1.0.1 • Published 10 months ago
@scobru/address-book v1.0.1
��# @scobru/address-book
A collection of useful addresses on EVM chains.
I have built an address-book as a shared package where all builders from Buidlguidl are free to add their newly created token, the smart contract to interact with their dapp, or simply a list of addresses of existing hacker houses
Feel free to add your own addresses to the address-book.
Contributing (Please read above, leaving this here for historical reasons)
- Read the CONTRIBUTING doc first
- run
yarn
. This will install the packages and prepare husky pre-commit hook - Add addresses:
- If new platform:
- Add a file for the platform (i.e pancakeswap) under the respective chain in address-book/(your chain name)
- Add the third party contracts in an object there and export the object.
- Add the export to the chain's index.ts file.
- For tokens:
- 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.
- If new platform:
- 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.
- Once the commit goes through, raise a pull request.
- If the checksum passes, a maintainer will review it and merge it
- 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.