Skip to content

Commit

Permalink
Update ERC-7572: add symbol to contractURI schema
Browse files Browse the repository at this point in the history
Merged by EIP-Bot.
  • Loading branch information
ryanio authored Apr 6, 2024
1 parent a48730d commit 74abc71
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion ERCS/erc-7572.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ The string returned from `contractURI()` MAY be an offchain resource or onchain

The `ContractURIUpdated()` event SHOULD be emitted on updates to the contract metadata for offchain indexers to query the contract.

If the underlying contract additionally provides a `name()` method, the metadata returned by `contractURI()`'s `name` property is RECOMMENDED to take precedence. This enables contract creators to update their contract name with an event that notifies of the update.
If the underlying contract provides any methods that conflict with the `contractURI` schema such as `name()` or `symbol()`, the metadata returned by `contractURI()` is RECOMMENDED to take precedence. This enables contract creators to update their contract details with an event that notifies of the update.

### Schema for contractURI

Expand All @@ -51,6 +51,10 @@ The schema for the JSON returned from `contractURI()` MUST conform to:
"type": "string",
"description": "The name of the contract."
},
"symbol": {
"type": "string",
"description": "The symbol of the contract."
},
"description": {
"type": "string",
"description": "The description of the contract."
Expand Down Expand Up @@ -93,6 +97,7 @@ Example:
```json
{
"name": "Example Contract",
"symbol": "EC",
"description": "Your description here",
"image": "ipfs://QmTNgv3jx2HHfBjQX9RnKtxj2xv2xQCtbDXoRi5rJ3a46e",
"banner_image": "ipfs://QmdChMVnMSq4U7oVKhud7wUSEZGnwuMuTY5rUQx57Ayp6H",
Expand Down

0 comments on commit 74abc71

Please sign in to comment.