!npm

Eth Chains

Helper module for getting Ethereum chains info from chainid.network.

Install

``
yarn add eth-chains
`

`
npm install eth-chains
`

$3

eth-chains uses a weekly automated release script that updates its chain data. This release script takes breaking changes into account, so breaking changes (e.g. renamed chains) are released as a new major version, while non-breaking changes (e.g. new chains) are released as a new minor version.

Usage

Import chains methods and enums:

`ts
import chains, { ChainId, ChainName } from 'eth-chains'
`

$3

`ts
import { chain } from 'eth-chains'

console.log(chain.ethereum.rinkeby)

console.log(chain.polygon.mumbai)
`

$3

`ts
console.log(ChainId.EthereumMainnet) // 1
console.log(ChainId.BinanceSmartChainMainnet) // 56
console.log(ChainName.EthereumMainnet) // "Ethereum Mainnet"
console.log(ChainName.Rinkeby) // "Rinkeby"
`

$3

`ts
chains.getById(ChainId.EthereumMainnet) // { name: "Ethereum Mainnet", ..., "infoURL": "https://ethereum.org" }
// Equivalent
chains.getById(1)
`

$3

`ts
chains.getByName(ChainName.EthereumMainnet) // { name: "Ethereum Mainnet", ..., "infoURL": "https://ethereum.org" }
// Equivalent
chains.getByName('Ethereum Mainnet')
`

$3

`ts
const allChains = chains.all()
// { 1: { name: "Ethereum Mainnet", ..., "infoURL": "https://ethereum.org" }, 2: {...}}
`

$3

`ts
import { Chain, NativeCurrency, Explorer } from 'eth-chains'
const ethereum: Chain = chains.getById(ChainId.EthereumMainnet)
ethereum.chain // 'ETH'
``

---

TODO:

- [ ] Add webhook that watches the chains repo and triggers an update to this package whenever that repo gets updated
- [ ] Add check in the deploy script to make sure that the types are correct before publishing
- [ ] Add Tests
- [ ] Once quicktype is added, test with different chains.json objects to make sure it can handle new types
- [ ] Use quicktype to autogen types from json
- [x] Autogen Chain Id enum
- [x] Autogen Chain Name enum