Code Monkey home page Code Monkey logo

linea-token-list's Introduction

Linea Token List

This repository maintains a list of ERC20 tokens available on Linea. The list is kept updated by the community.

If you want to add a token or validate an addition, please follow the procedures outlined below.

How to add a Token (for community)

To add a new Token,

  1. Fork this repository to your own GitHub account, then clone your fork and create a new branch.

Example:

git clone https://github.com/<your-github-username>/linea-token-list.git
cd linea-token-list
git checkout -b feat/<token-name>
  1. Fill out the ./json/linea-goerli-token-shortlist.json with your token's information.

Example:

"tokens": [
...
{
      "chainId": 59140,
      "chainURI": "https://goerli.lineascan.build/block/0",
      "tokenId": "https://goerli.lineascan.build/token/0x7823e8dcc8bfc23ea3ac899eb86921f90e80f499",
      "tokenType": ["bridged"],
      "address": "0x7823e8dcc8bfc23ea3ac899eb86921f90e80f499",
      "name": "Uniswap",
      "symbol": "UNI",
      "decimals": 18,
      "createdAt": "2023-06-26",
      "updatedAt": "2023-06-26",
      "logoURI": "https://s2.coinmarketcap.com/static/img/coins/64x64/7083.png",
      "extension": {
        "rootChainId": 5,
        "rootChainURI": "https://goerli.etherscan.io/block/0",
        "rootAddress": "0x41E5E6045f91B61AACC99edca0967D518fB44CFB"
      }
}
...
]

Description of the fields:

Name Description type Required?
chainId The typically used number identifier for the chain on which the token was issued number Mandatory
chainURI A resolvable URI to the genesis block of the chain on which the token was issued following the RFC 3986 standard string Mandatory
tokenId A resolvable URI of the token following the RFC 3986 standard to for example the deployment transaction of the token, or a DID identifying the token and its issuer string Mandatory
tokenType Describes the type of token (e.g: native, bridged…) string Mandatory
address Address of the token smart contract string Mandatory
name Token name string Mandatory
symbol Token symbol e.g. UNI string Mandatory
decimals Allowed number of decimals for the listed token integer Mandatory
createdAt Date and time token was created string Mandatory
updateAt Date and time token was last updated string Mandatory
logoURI URI or URL of the token logo following the RFC 3986 standard string Optional
extension Extension to specify information about the token on its native chain if it was bridged Array Mandatory if the token has been bridged, otherwise optional
rootChainId The typically used number identifier for the chain on which the token was originally issued number Mandatory if the token has been bridged, otherwise optional
rootChainURI A resolvable URI to the genesis block of the root chain on which the token was originally issued following the RFC 3986 standard string Mandatory if the token has been bridged, otherwise optional
rootAddress Address of the token on its native chain string Mandatory if the token has been bridged, otherwise optional

Additional guidelines:

  • Please ensure the completed JSON follows the schema outlined in ./json/schema/l2-token-list-schema.json.
  • Make sure to add the token following alphabetical order of the symbol field.
  • Update the updatedAt (and potentially createdAt) fields for the file and the token
  • Update the file version:
    • Increase patch when modifying information of an existing token
    • Increase minor when modifying adding a new token
    • Increase major when changing the structure of the file
  1. Commit your changes and push your branch.

Note: Only commit the list file. Do not modify the schema or the templates.

  1. Go to https://github.com/ConsenSys/linea-token-list/pulls and create a new PR. Make sure to set the base branch as main.

A GitHub Actions workflow will automatically verify the integrity of your JSON. If the check passes, validators will review the new list. If all the information are correct, they will approve the token addition.

In case of a failing check, refer to the error message in the Actions tab. Make necessary modifications and try again.

Happy contributing!

linea-token-list's People

Contributors

arthur-remy avatar wantedsystem avatar julink-eth avatar phoax avatar github-actions[bot] avatar croll83 avatar solniechniy avatar plutoegg 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.