GithubHelp home page GithubHelp logo

pegasys-tokenlists's Introduction

Pegasys Tokenlists

Token Lists is a specification for lists of token metadata (e.g. address, decimals, etc.) that can be used by any dApp interfaces that needs one or more lists of tokens. Anyone can create and maintain a token list, as long as they follow the specification. The Pegasys community invites you to add your token to our tokenlists!

Adding Your Token to an Existing List

General Requirements

To integrate your token into the Pegasys app you must submit a PR following these steps:

  1. Token should be verified on the block explorer.

  2. Tokens are added to tokenlists by Pegasys team based on market demand and other metrics.

  3. Make sure to let us know of your interest through our Discord channel by reaching out to anyone from our team over at the Support -> πŸŒ±β”‚new-tokens channel.

  4. Fork the Github repository, preferably to your team's Github organization.

  5. Create a new folder with the checksum formatted smart contract address of your token inside logos(mixed case 0xa5B6... address).

  6. Tell your designer that token image must be in PNG format, preferably transparent background, recommended size 256x256px, with max file size of 100kB.

  7. Upload your logo with file named logo.png to previously created folder, i.e. logos/0x0000000000000000000000000000000000000bAe/logo.png

  8. Add an entry in the tokens field of the appropriate tokenlist. Here is an example:

    {
        "address": "0x0000000000000000000000000000000000000bAe",
        "chainId": 69420,
        "name": "Bae Token",
        "symbol": "BAE",
        "decimals": 18,
        "logoURI": "https://raw.githubusercontent.com/logo.png"
    }
  9. Update the timestamp field to the current timestamp.

  10. Update the version field to adhere to semantic versioning:

    • Increment major version when tokens are removed
    • Increment minor version when tokens are added
    • Increment patch version when tokens already on the list have minor details changed (name, symbol, logo URL, decimals)

    Note: Changing a token address or chain ID is considered both a remove and an add, and should be a major version update.

Creating Your Own List

List creation is encouraged! The Pegasys team wants the community to develop their own lists and will not gatekeep new lists.

Have more questions?

Come visit us on discord at our dev-talk channel. Link: https://discord.gg/kAq3pAUAkE

Disclaimer

Pegasys 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 Pegasys team will reject projects that are deemed as scam or fraudulent after careful review. We also reserve 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. We hold no responsibility to add your token under any circumstances.

pegasys-tokenlists's People

Contributors

0xbae avatar lucasbitt7 avatar potolski avatar thomgabriel avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  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.