/address-book

Primary LanguageTypeScript

address-book

A collection of useful addresses on EVM chains for defi development

Contributing

  1. Read the CONTRIBUTING doc first
  2. run yarn. This will install the packages and prepare husky pre-commit hook
  3. Add addresses:
    1. If new platform:
      1. Add a file for the platform (i.e pancakeswap) under the respective chain in address-book/
      2. Add the third party contracts in an object there and export the object.
      3. Add the export to the chain's index.ts file.
    2. For tokens:
      1. Add to respective token.ts file, with token symbol as key. Make sure the decimals are correct for the token. Usually you can find this info via the chain's block explorer.
  4. Try to commit the change. If it fails, its because the address isn't passing the checksum check. Look at the console output and paste the correct address.
  5. Once commit goes through, raise a PR
  6. If the checksum passes, a maintainer will review it and merge it
  7. Once merged, the package version will be bumped and the package will be published. Run yarn upgrade in the consuming repo to consume the new package version.