Skip to content

Commit

Permalink
nit
Browse files Browse the repository at this point in the history
  • Loading branch information
Thegaram committed Aug 16, 2024
1 parent 6026b5c commit 64ad158
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 7 deletions.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
Expand Down
13 changes: 7 additions & 6 deletions docs/badges.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down Expand Up @@ -116,7 +117,7 @@ There are three main badge types of badges:
<ul>
<li>

The badge is deployed on the **Scroll Mainnet** and verified on [ScrollScan](https://scrollscan.com).
The badge is deployed on the **Scroll Mainnet** and verified on [Scrollscan](https://scrollscan.com).

</li>
<li>
Expand Down Expand Up @@ -170,7 +171,7 @@ There are three main badge types of badges:
</li>
<li>

The attester proxy contract is deployed on the **Scroll Mainnet** and verified on [ScrollScan](https://scrollscan.com).
The attester proxy contract is deployed on the **Scroll Mainnet** and verified on [Scrollscan](https://scrollscan.com).

</li>
</ul>
Expand Down Expand Up @@ -212,7 +213,7 @@ There are three main badge types of badges:

<td>
N/A
<td>
</td>
</tr>

</table>
Expand Down Expand Up @@ -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)`.

Expand Down

0 comments on commit 64ad158

Please sign in to comment.