The Meld Supported config manages the supported tokens, NFT, chains and networks for use in the MeldApp and Mobile App. It's used by our backend services as well as our clients.
After cloning run npm i. Then you are good to go!.
To run the tests: npm run test.
Each token is represented by a json file containing the details of the token or NFT.
These mini config files are grouped by network (meld, kanazawa etc). We validate this list, checking for duplication, invalid schemas etc, then concatenate them into a config file per network.
Our backend & frontend services then consume that config.
{
//This is the official ticker for the specific asset. The ticker can from 2 to 8 letters or numbers always represented only as capitals. In almost all cases tickers should be 3 or 4 characters. You can not use any special characters in the ticker.
"tokenTicker": "USDC",
//This is common full name of the asset. This is described in normal letters (upper lower and special characters allowed).
"tokenName": "USD Coin (ERC20)",
//This is the official token contract and it has to be verified in order to be accepted. More details on the requirements can be found at dev.meld.com.
"tokenAddress": "0x777777fdd5026127f247aa92ba6dbd0ec882b095",
//This is the MELD internal id for a token. It is produced based on this model {network}-{tokenTicker}-{tokenAddress}.
"mldId": "MELD-JOE-0x777777fdd5026127f247aa92ba6dbd0ec882b095",
//This is the icon used for representing the token. The icon image needs to be included in the pull request if it hasn't been added previously.
"tokenIcon": "/static/tokens/usdc.svg",
//This is the color used in in the MELDapp We have different colors that can be selected which come close to a brand color.
"tokenColorTheme": 2,
//This describes the token type. It can be native-cardano, native-evm, CNT, ERC20, ERC-1155.
"tokenType": "ERC20",
//This is by default always 18. In some very special cases it can be less.
"decimals": 18,
//This is the lowercase name used in Coin Market Cap API.
"CMCslug": "usdc",
//Can contain: bridged, stablecoin, wrapped.
"tags": []
//This is the IRL organization name.
"orgName": "Nakamigos",
//This is the organization or project URL.
"orgUrl": "https://nakamigos.io",
}For example:
{
"tokenTicker": "MELD",
"tokenName": "MELD",
"tokenAddress": "0x333000333b26ee30214b4af6419d9ab07a450400",
"mldId": "ethereum-MELD-0x333000333b26ee30214b4af6419d9ab07a450400",
"tokenIcon": "/static/tokens/MELD.svg",
"tokenColorTheme": "#e51b44",
"tokenType": "ERC20",
"decimals": 18,
"CMCslug": "meld",
"tags": [],
"orgName": "MELD",
"orgUrl": "https://www.meld.com"
}//This is the schema to be used for deploying a new NFT project into the MELD token registry. These can be either ERC721 or ERC1155.
{
//Not all NFTs have this. You might need to look into the smart contract for it.
"tokenTicker": "NKMGS",
//This is the token address for the specific NFT
"tokenAddress": "0xd774557b647330C91Bf44cfEAB205095f7E6c367",
//This is the color used in in the MELDapp We have different colors that can be selected which come close to a brand color.
"tokenColorTheme": 2,
//This is the token type: ERC20, ERC721, ERC1155
"tokenType": "ERC721",
//This is a name for a group of NFTs to be described under. Similar to the author but without a unique wallet address.
"collectionName": "Nakamigos",
//This is a person or orgs wallet that many NFT collections or 1of1 or other works can be grouped under.
"groupedUnder": "0x777777fdd5026127f247aa92ba6dbd0ec882b095",
//This is the icon used for representing the whole collection. The icon image needs to be included in the pull request if it hasn't been added previously.
"collectionIcon": "/static/tokens/nakamigos.png",
//This is the actual wallet that minted the NFTs
"authorsName": "Nakamigos-Deployer",
"authorAddress": "0xBAa4b7858C3277Da9cb9CdaDf405f2017aFea19A",
//This is the maximum number of assets under this specific deployer.
"maxSupply": 20000,
//mldId is setup based on the following: {tokenTicker}-{tokenAddress}-{tokenID}
"mldId": "NKMGS-0x777777fdd5026127f247aa92ba6dbd0ec882b095-8990",
//This is the blockchain in which this token was originally minted.
"chainId": 1,
//This is the royalties the author gets per transaction. The number is from 0 to 50.
"royalties": 5,
//Can contain: 1Of1, pfp, collection, bridged.
"tags": [],
//This is the IRL organization name.
"orgName": "Nakamigos",
//This is the organization or project URL.
"orgUrl": "https://nakamigos.io",
}For example:
{
"tokenTicker": "CDB",
"tokenAddress": "0x42069ABFE407C60cf4ae4112bEDEaD391dBa1cdB",
"tokenColorTheme": 3,
"tokenType": "ERC721",
"collectionName": "CryptoDickbutts S3",
"groupedUnder": "0x777777fdd5026127f247aa92ba6dbd0ec882b095",
"collectionIcon": "/static/tokens/nakamigos.png",
"authorsName": "Nakamigos-Deployer",
"authorAddress": "0xFCD457B27EE149E74A080B2a4e482D9A5dBaf3d9",
"maxSupply": 20000,
"mldId": "NKMGS-0x777777fdd5026127f247aa92ba6dbd0ec882b095-8990",
"chainId": 1,
"royalties": 5,
"tags": [],
"orgName": "CryptoDickbutts",
"orgUrl": "https://cryptodickbutts.com/",
}//This is the schema to be used for deploying a new CNT project into the MELD token registry.
{
//This is the lowercase name used in Coin Market Cap API.
"CMCslug": "meld",
//This is by default always 6.
"decimals": 6,
//This is the MELD internal id for a token. It is produced based on this model {network}-{tokenTicker}-{tokenAddress}.
"mldId": "cardano-MELD-a2944573e99d2ed3055b808eaa264f0bf119e01fc6b18863067c63e44d454c44",
//This is the IRL organization name. It can be blank.
"orgName": "",
//This is the organization or project URL. It can be blank.
"orgUrl": "",
// This combines the policyId and encoded asset name in the format {policyId}{encodedAssetName}, ensuring that the dot is removed.
"tokenAddress": "a2944573e99d2ed3055b808eaa264f0bf119e01fc6b18863067c63e44d454c44",
//This is the color used in in the MELDapp. We have different colors that can be selected which come close to a brand color.
"tokenColorTheme": 1,
//This is the icon used for representing the token. The icon image needs to be included in the pull request if it hasn't been added previously.
"tokenIcon": "/static/tokens/MELD.svg",
//This is common full name of the asset. It follows Cardano's token name rules.
"tokenName": "MELD",
//This is the official ticker for the specific asset. It is the ticker value defined in cardano-token-registry.
"tokenTicker": "MELD",
//This is the token type for Cardano Native Token.
"tokenType": "CNT",
// The default is an empty array. Only lovelace has the tag "native"
"tags": []
}For example:
{
"CMCslug": "meld",
"decimals": 6,
"mldId": "cardano-MELD-a2944573e99d2ed3055b808eaa264f0bf119e01fc6b18863067c63e44d454c44",
"orgName": "",
"orgUrl": "",
"tokenAddress": "a2944573e99d2ed3055b808eaa264f0bf119e01fc6b18863067c63e44d454c44",
"tokenColorTheme": 1,
"tokenIcon": "/static/tokens/MELD.svg",
"tokenName": "MELD",
"tokenTicker": "MELD",
"tokenType": "CNT",
"tags": []
}Tokens and NFT have a tokenColorTheme property. This is an id to hex colour mapping used to set and restrict the number of colours displayed.
The full list of colour themes is
| ID | HEX | |
|---|---|---|
| 1 | #e51b44 | |
| 2 | #2775ca | |
| 3 | #e4a62a | |
| 4 | #50AF95 | |
| 5 | #2f45c5 | |
| 6 | #1B314F | |
| 7 | #F1716A | |
| 8 | #E62F29 | |
| 9 | #F7931A | |
| 10 | #0033ad | |
| 11 | #525255 | |
| 12 | #9355fa | |
| 13 | #00a35c | |
| 14 | #4b2fc5 | |
| 15 | #6349a2 | |
| 16 | #000000 | |
| 17 | #BF5750 | |
| 18 | #FF007A | |
| 19 | #393939 | |
| 20 | #F00500 | |
| 21 | #290290 | |
| 22 | #2986F0 |
Tokens have a tokenIcon property representing the token, and NFTs have a collectionIcon property representing the NFT collection.
When submitting a pull request to add new tokens, ensure you include the token icons if they haven't been added previously.
The icon should be a .svg file with a size of 24x24 px and must be placed inside the static/tokens folder.
While Token & NFT support is done by the MELD team, we will look at PR's raised to add token support. Please fork and raise your PR along with a completed pull request template for consideration.
While we would love to support all tokens from day 1, it's not always feasible. Please don't be offended if we chose to not support your favourite meme coin at this time.
Please note that we will run validation and unit tests as part of our CI/CD, and nothing will be deployed or merged with breaking tests.