Changed readme.md
This commit is contained in:
1 parent
9afaee9f64
commit
bf1b1c9af0
1 file changed
+1
-92
@@ -33,98 +33,7 @@ related assets.
|
|||||||
- The file extension must be `.json`.
|
- The file extension must be `.json`.
|
||||||
|
|
||||||
3. **Schema Validation**:
|
3. **Schema Validation**:
|
||||||
- The JSON file must conform to the schema defined in `scripts/token-schema.json`. Below is the required schema:
|
- The JSON file must conform to the schema defined in `scripts/token-schema.json`.
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
||||||
"title": "Token Schema",
|
|
||||||
"description": "Schema for validating token information in a blockchain context.",
|
|
||||||
"type": "object",
|
|
||||||
"properties": {
|
|
||||||
"name": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "The name of the token."
|
|
||||||
},
|
|
||||||
"ticker": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "The short name of the token."
|
|
||||||
},
|
|
||||||
"title": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "The full name of the network or token."
|
|
||||||
},
|
|
||||||
"iconFileName": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "The icon file name for the token."
|
|
||||||
},
|
|
||||||
"infoURL": {
|
|
||||||
"type": "string",
|
|
||||||
"format": "uri",
|
|
||||||
"description": "URL for additional information about the token."
|
|
||||||
},
|
|
||||||
"contractAddress": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "The smart contract address of the token."
|
|
||||||
},
|
|
||||||
"type": {
|
|
||||||
"type": "string",
|
|
||||||
"enum": [
|
|
||||||
"fungible",
|
|
||||||
"nft"
|
|
||||||
],
|
|
||||||
"description": "The type of token (fungible or NFT)."
|
|
||||||
},
|
|
||||||
"decimals": {
|
|
||||||
"type": "integer",
|
|
||||||
"description": "The number of decimal places."
|
|
||||||
},
|
|
||||||
"description": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "A description of the token.",
|
|
||||||
"default": ""
|
|
||||||
},
|
|
||||||
"website": {
|
|
||||||
"type": "string",
|
|
||||||
"format": "uri",
|
|
||||||
"description": "Link to the project's website.",
|
|
||||||
"default": ""
|
|
||||||
},
|
|
||||||
"whitepaper": {
|
|
||||||
"type": "string",
|
|
||||||
"format": "uri",
|
|
||||||
"description": "Link to the project's whitepaper.",
|
|
||||||
"default": ""
|
|
||||||
},
|
|
||||||
"initialSupply": {
|
|
||||||
"type": "number",
|
|
||||||
"description": "The initial supply of tokens.",
|
|
||||||
"default": 0
|
|
||||||
},
|
|
||||||
"totalSupply": {
|
|
||||||
"type": "number",
|
|
||||||
"description": "The total supply of tokens.",
|
|
||||||
"default": 0
|
|
||||||
},
|
|
||||||
"maxSupply": {
|
|
||||||
"type": "number",
|
|
||||||
"description": "The maximum supply of tokens.",
|
|
||||||
"default": 0
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"required": [
|
|
||||||
"name",
|
|
||||||
"ticker",
|
|
||||||
"title",
|
|
||||||
"iconFileName",
|
|
||||||
"infoURL",
|
|
||||||
"contractAddress",
|
|
||||||
"type",
|
|
||||||
"decimals"
|
|
||||||
],
|
|
||||||
"additionalProperties": false
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### PNG File Requirements (`icons` Directory)
|
### PNG File Requirements (`icons` Directory)
|
||||||
|
|
||||||
|
|||||||
Reference in new issue
Block a user