Giter VIP home page Giter VIP logo

tokenlists's Introduction

Balancer tokenlists

This is a general purpose tokenlist generation app that Balancer uses to generate it's tokenlist.

Make changes to the Balancer tokenlist

To make changes to the balancer tokenlist edit the files in src/tokenlists/balancer.

  1. metadata.ts - Edit this to change the highlevel tokenlist metadata.
  2. tokens/<network>.ts - Edit this to add or remove tokens from the generated tokenlist. E.g Tokens for Arbitrum go in tokens/arbitrum.ts, tokens for Ethereum go in tokens/ethereum.ts.
  3. overwrites.ts - Edit this to overwrite any token data that is incorrect when generated automatically.

Once changes are made, the tokenlist can be regenerated by running:

npm run generate

This updates the generated file at /generated/balancer.tokenlist.json

However, you do not need to run this command locally. Simply make changes to the mentioned files and merge them with the main branch. Following this, an autogenerated PR will be created to update the generated tokenlist files.

Create a new tokenlist

Although this repo is primarily for maintaing the balancer.tokenlist.json file, it can be forked and used to generate any kind of tokenlist. Simply run:

npm run tokenlist:create my-new-tokenlist

This will create a new template tokenlist in /src/tokenlists with the necessary files. Then, just add token addresses to the tokens.ts file and run npm run generate to generate your tokenlist json file.

Development

To run the generate command locally or in the Github actions of a fork you will need to add these ENV variables:

INFURA_KEY=xxx
POKT_KEY=xxx

You'll need to sign up to each of those services to get keys:

tokenlists's People

Contributors

zekraken-bot avatar balopco avatar garethfuller avatar timjrobinson avatar github-actions[bot] avatar tritium-vlk avatar dakotajakiser avatar 0xdcota avatar firebotdev avatar alter-eggo avatar jianlinjiang avatar xadcv avatar cyb3rkn1ght avatar zmanian avatar jvlandayan avatar plaguepatientzero avatar fabiaz84 avatar 0xyphilic avatar daveai avatar 0xsignal avatar selfwithin avatar kevinzhangto avatar ck2447 avatar birkses avatar mayfairfunds avatar elemontcapital avatar naisechef avatar tomerxarchimedes avatar prasad-kumkar avatar saurabh-lodha-16 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.