From 64ad15800faf4853d2e6ca525bf83d946b228716 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?P=C3=A9ter=20Garamv=C3=B6lgyi?= Date: Fri, 16 Aug 2024 15:59:36 +0200 Subject: [PATCH] nit --- README.md | 4 +++- docs/badges.md | 13 +++++++------ 2 files changed, 10 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 17f50b1..f12533d 100644 --- a/README.md +++ b/README.md @@ -16,9 +16,11 @@ Users can mint a non-transferable and unique personal persona to collect and dis ### Key Features - **Canvas**: Each Canvas is a smart contract minted through the `ProfileRegistry` contract by the user on Scroll’s website. -- **Badges**: Attestations of achievements and traits verified through the Ethereum Attestation Service ([EAS service](https://docs.attest.sh/docs/welcome)), issued by different projects and the Scroll Foundation. +- **Badges**: Attestations of achievements and traits verified through the [Ethereum Attestation Service](https://docs.attest.sh/docs/welcome) (EAS), issued by different projects and the Scroll Foundation. Badges are wallet-bound and non-transferable. +Differences between attestations and NFTs: + | Attestation | NFT | | --- | --- | | Witness Proofs | Tokenized Assets | diff --git a/docs/badges.md b/docs/badges.md index fea719d..1c22017 100644 --- a/docs/badges.md +++ b/docs/badges.md @@ -74,6 +74,7 @@ There are three main badge types of badges: This backend implements some off-chain eligibility check and exposes an eligibility check and claim API. If the user is authorized to mint, the backend issues a signed permit. The user then mints using this permit. + See [this document](https://scrollzkp.notion.site/Badge-APIs-95890d7ca14944e2a6d34835ceb6b914) for the API requirements. For backend-authorized badges, you need to deploy two contracts: the badge contract, and an [`AttesterProxy`](../src/AttesterProxy.sol). @@ -116,7 +117,7 @@ There are three main badge types of badges: @@ -212,7 +213,7 @@ There are three main badge types of badges: N/A - + @@ -245,12 +246,12 @@ This repo also contains some [examples](src/badge/examples): We recommend going through this checklist before your badge is published: -- [ ] The badge contract is deployed on Scroll mainnet and verified on Scrollscan. -- [ ] The badge contract configured the correct resolver address, see [Deployments](./deployments.md). +- [ ] The badge contract is deployed on Scroll mainnet and verified on [Scrollscan](https://scrollscan.com). +- [ ] The badge contract was deployed with the correct resolver address, see [Deployments](./deployments.md). Backend-authorized badges: -- [ ] The attester proxy contract is deployed on Scroll mainnet and verified on Scrollscan. +- [ ] The attester proxy contract is deployed on Scroll mainnet and verified on [Scrollscan](https://scrollscan.com). - [ ] The badge enabled the attester proxy: `badge.toggleAttester(attesterProxy, true)`. - [ ] The attester proxy enabled your backend signer account: `attesterProxy.toggleAttester(signer, true)`.