kylefang/stacks-blockchain-api
1
0
Fork 0
mirror of https://github.com/alexgo-io/stacks-blockchain-api.git synced 2026-04-30 05:45:37 +08:00
Code Issues Packages Projects Releases Wiki Activity

feat: token metadata

Browse Source
This commit is contained in:
Asim Mehmood
2021-09-02 04:14:05 +05:00
committed by GitHub
parent e37b5afbf5
commit 33f11bbcf3
40 changed files with 3029 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
docs/entities/tokens/fungible-token.schema.example.json Normal file
View File

@@ -0,0 +1,11 @@
{
"token_uri": "https://heystack.xyz/token-metadata.json",
"name": "Heystack",
"description": "Heystack is a SIP-010-compliant fungible token on the Stacks Blockchain, used on the Heystack app",
"image_uri": "https://heystack.xyz/assets/Stacks128w.png",
"image_canonical_uri": "https://heystack.xyz/assets/Stacks128w.png",
"tx_id": "0xef2ac1126e16f46843228b1dk4830e19eb7599129e4jf392cab9e65ae83a45c0",
"sender_address": "ST399W7Z9WS0GMSNQGJGME5JAENKN56D65VGMGKGA",
"symbol": "HEY",
"decimals": 5
}

56
docs/entities/tokens/fungible-token.schema.json Normal file
View File

@@ -0,0 +1,56 @@
{
"$schema": "http://json-schema.org/draft-07/schema",
"$id": "fungible-token-metadata",
"title": "FungibleTokenMetadata",
"type": "object",
"additionalProperties": false,
"required": [
"token_uri",
"name",
"description",
"image_uri",
"image_canonical_uri",
"symbol",
"decimals",
"tx_id",
"sender_address"
],
"properties": {
"token_uri": {
"type": "string",
"description": "An optional string that is a valid URI which resolves to this token's metadata. Can be empty."
},
"name": {
"type": "string",
"description": "Identifies the asset to which this token represents"
},
"description": {
"type": "string",
"description": "Describes the asset to which this token represents"
},
"image_uri": {
"type": "string",
"description": "A URI pointing to a resource with mime type image/* representing the asset to which this token represents. The API may provide a URI to a cached resource, dependending on configuration. Otherwise, this can be the same value as the canonical image URI."
},
"image_canonical_uri": {
"type": "string",
"description": "The original image URI specified by the contract. A URI pointing to a resource with mime type image/* representing the asset to which this token represents. Consider making any images at a width between 320 and 1080 pixels and aspect ratio between 1.91:1 and 4:5 inclusive."
},
"symbol": {
"type": "string",
"description": "A shorter representation of a token. This is sometimes referred to as a \"ticker\". Examples: \"STX\", \"COOL\", etc. Typically, a token could be referred to as $SYMBOL when referencing it in writing."
},
"decimals": {
"type": "number",
"description": "The number of decimal places in a token."
},
"tx_id": {
"type": "string",
"description": "Tx id that deployed the contract"
},
"sender_address": {
"type": "string",
"description": "principle that deployed the contract"
}
}
}

9
docs/entities/tokens/non-fungible-token.schema.example.json Normal file
View File

@@ -0,0 +1,9 @@
{
"token_uri": "https://pool.friedger.de/nft.json",
"name": "Friedger Pool",
"description": "Enjoying the stacking pool.",
"image_uri": "https://pool.friedger.de/nft.webp",
"image_canonical_uri": "https://pool.friedger.de/nft.webp",
"tx_id": "0xef2ac1126e16f46843228b1dk4830e19eb7599129e4jf392cab9e65ae83a45c0",
"sender_address": "ST399W7Z9WS0GMSNQGJGME5JAENKN56D65VGMGKGA"
}

46
docs/entities/tokens/non-fungible-token.schema.json Normal file
View File

@@ -0,0 +1,46 @@
{
"$schema": "http://json-schema.org/draft-07/schema",
"$id": "non-fungible-token-metadata",
"title": "NonFungibleTokenMetadata",
"type": "object",
"additionalProperties": false,
"required": [
"token_uri",
"name",
"description",
"image_uri",
"image_canonical_uri",
"tx_id",
"sender_address"
],
"properties": {
"token_uri": {
"type": "string",
"description": "An optional string that is a valid URI which resolves to this token's metadata. Can be empty."
},
"name": {
"type": "string",
"description": "Identifies the asset to which this token represents"
},
"description": {
"type": "string",
"description": "Describes the asset to which this token represents"
},
"image_uri": {
"type": "string",
"description": "A URI pointing to a resource with mime type image/* representing the asset to which this token represents. The API may provide a URI to a cached resource, dependending on configuration. Otherwise, this can be the same value as the canonical image URI."
},
"image_canonical_uri": {
"type": "string",
"description": "The original image URI specified by the contract. A URI pointing to a resource with mime type image/* representing the asset to which this token represents. Consider making any images at a width between 320 and 1080 pixels and aspect ratio between 1.91:1 and 4:5 inclusive."
},
"tx_id": {
"type": "string",
"description": "Tx id that deployed the contract"
},
"sender_address": {
"type": "string",
"description": "principle that deployed the contract"
}
}
}