Coder Social home page Coder Social logo

pinkdiamond1 / token-directory Goto Github PK

View Code? Open in Web Editor NEW

This project forked from 0xsequence/token-directory

0.0 1.0 0.0 6.98 MB

Public dataset of ERC20, ERC721, ERC1155 token lists across network deployments

License: MIT License

TypeScript 100.00%

token-directory's Introduction

Sequence Token Directory

Token directory that contains a list of almost all ERC-20, ERC-721 and ERC-1155 tokens.

Token List Formats

The ERC-20 token lists present in this repository follow the Uniswap Token List Schema. The original list was populated using Coingecko's erc20 token list [email protected]. Token description and links are taken from Coingecko's API.

The ERC-721 and ERC-1155 token lists present in this repository follow the Sequence Collectible List Schema. The original list was populated using Dune Analytics via the query #16838. Token description and links were taken from OpenSea's API.

Add or Update Your Token

If a token is missing entirely, or contains incorrect or missing information, please stick to the following procedure;

  1. Fork the current Token Directory repository
  2. Add your token in the tokens array in the correct file in the src/registry/ folder e.g. Registring a new ERC-721 token on Mainnet should be done by adding entry here.
  3. Open a PR comparing the main branch with your fork
  4. In the PR, add an explanation if this PR is for an existing token that needs to be updated

If the token is already part of the list, the token object in the registry will replace the existing token in the list (tokens will be matched by contract address).

Formats

Depending on the standard, your token entries should respect the following format:

ERC20

See here for examples.

{
  chainId: number,         // Chain ID 
  address: string,         // Contract address
  name: string,            // Name of token, 40 chars max
  symbol: string,          // Symbol of token, 20 chars max
  decimals: number,        // Number of decimals token uses
  logoURI: string | null,  // URI / URL for token logo 
  extensions: {
    link: string | null,        // URL of token's website
    description: string | null, // Short description of token (1000 chars max)
    ogImage: string | null      // URL of Open Graph image of token website 
}

ERC721 and ERC1155

See here for erc721 and here for erc1155 examples.

{
  chainId: number,                // Chain ID 
  address: string,                // Contract address
  name: string,                   // Name of token, 40 chars max
  standard: 'erc721' | 'erc1155', // Name of token's standard 
  symbol: string | null,          // Symbol of token, 20 chars max
  logoURI: string | null,         // URI / URL for token logo
  extensions: {
    link: string | null,        // URL of token's website
    description: string | null, // Short description of token (1000 chars max)
    ogImage: string | null      // URL of Open Graph image of token website 
}

LICENSE

MIT

token-directory's People

Contributors

phabc avatar pkieltyka avatar attente avatar corbanbrook avatar acrylix avatar samuelea avatar scotato avatar shubhaankar-sharma avatar tolgahan-arikan avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.