DeFi Tokens Wiki

Overview

DeFi Tokens Wiki is a comprehensive collection of metadata on thousands of DeFi tokens.

Dharma displays this metadata in their mobile app. Tokens added to this repository are also indexed on Uniswap.

Such a large collection can be maintained only through a community effort, so contributions are welcome, primarily from token projects.

Contribution Quick Start

Details of the repository structure and contribution guidelines are listed on the DeFi Token Wiki site. Here is a quick starter summary for common use cases.

Add files via command line

Fork the repository to your own GitHub account
Clone fork and create new branch:

git clone git@github.com:YOUR_HANDLE/defi-tokens-wiki.git
cd defi-tokens-wiki
git checkout -b <branch_name>

Add token to appropriate directory, the folder structure documentation will help you
Commit and push to your fork

git add -A
git commit -m “Add <token_name>”
git push origin <branch_name>

From your repo clone page make a new PR (pull request)
If you PR doesn't pass the automated test suite, please update your PR and push again
Once the automated test suite passes, a Dharma admin will be notified to approve the PR

Add files via the web UI

Fork the repository to your own GitHub account
Find the file you want to update. Use the folder structure docs to help you navigate. For this example, let's use the COMP metadata file here.
Next, click the edit icon in the UI
Make your changes. Use the repository details docs to ensure you are using the correct formatting.
Commit your changes and create a new branch using the modal at the bottom of the page
If you PR doesn't pass the automated test suite, please update your PR and push again
Wait for your PR to be approved by an admin

Adding Token Metadata

Fork the Github repository
Open the metadata.json file in the tokens/<tokenAddress>/metadata.json path
Add token metadata using the following format:

{
    "name": "Maker",
    "symbol": "MKR",
    "address": "0x9f8F72aA9304c8B593d555F12eF6589cC3A579A2",
    "decimals": 18,
    "dharmaVerificationStatus": "VERIFIED",
    "description": "The MKR token—the governance token of the Maker Protocol—allows those who hold it to vote on changes to the Maker Protocol. Note that anyone, not only MKR holders, can submit proposals for an MKR vote.",
    "socialLinks": [
        {
            "type": "website",
            "value": "https://makerdao.com/"
        },
        {

            "type": "twitter",
            "value": "https://twitter.com/MakerDAO"
        },
        {
            "type": "telegram",
            "value": "https://t.me/makerdaoOfficial"
        },
				{
            "type": "discord",
            "value": "https://discord.com/makerdao"
        }
    ],
    "tags": ["governance", "defi"]
}

Create a PR to the main repo
If you PR doesn't pass the automated test suite, please update your PR and push again
Wait for your PR to be approved by an admin

Image Requirements

File location: must be placed in the correct folder and subfolder within the folder structure.
File extension: png. Uppercase PNG is considered invalid.
File name：logo.png, all lowercase.
Dimension: 256 x 256 pixels or 512 x 512 pixels.
Background: preferably transparent (should fit dark mode as well; deny logos need light border/background).
File size: maximum 100kB. Tip: optimize image size, e.g. using simple drag-and-drop online service tinypng.

Disclaimer

The Dharma team allows anyone to submit new assets to this repository. However, this does not mean that we are in direct partnership with all of the projects.

The Dharma team will reject projects that are deemed as scam or fraudulent after careful review. The Dharma team reserves the right to change the terms of asset submissions at any time due to changing market conditions, risk of fraud, or any other factors we deem relevant.

Documentation format inspired by TrustWallet

patrickxrivera / defi-tokens-wiki