Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/taylorjdawson/eth-chains
Helper module for getting Ethereum chains info from chainlist.org.
https://github.com/taylorjdawson/eth-chains
blockchain ethereum hacktoberfest web3
Last synced: 17 days ago
JSON representation
Helper module for getting Ethereum chains info from chainlist.org.
- Host: GitHub
- URL: https://github.com/taylorjdawson/eth-chains
- Owner: taylorjdawson
- Created: 2021-05-28T15:17:22.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-03-25T11:04:57.000Z (8 months ago)
- Last Synced: 2024-10-09T23:09:26.320Z (about 1 month ago)
- Topics: blockchain, ethereum, hacktoberfest, web3
- Language: TypeScript
- Homepage:
- Size: 196 KB
- Stars: 66
- Watchers: 9
- Forks: 24
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[](https://github.com/taylorjdawson/eth-chains/actions/workflows/publish-release.yml/badge.svg) 
# Eth Chains
Helper module for getting Ethereum chains info from [chainid.network](https://chainid.network/).
## Install
```
yarn add eth-chains
```
```
npm install eth-chains
```
### Note on versioning
`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'
```
### Easily get most popular chains:
```ts
import { chain } from 'eth-chains'
console.log(chain.ethereum.rinkeby)
console.log(chain.polygon.mumbai)
```
### Chain names and ids via Enums:
```ts
console.log(ChainId.EthereumMainnet) // 1
console.log(ChainId.BinanceSmartChainMainnet) // 56
console.log(ChainName.EthereumMainnet) // "Ethereum Mainnet"
console.log(ChainName.Rinkeby) // "Rinkeby"
```
### Chain by ID:
```ts
chains.getById(ChainId.EthereumMainnet) // { name: "Ethereum Mainnet", ..., "infoURL": "https://ethereum.org" }
// Equivalent
chains.getById(1)
```
### Chain by Name:
```ts
chains.getByName(ChainName.EthereumMainnet) // { name: "Ethereum Mainnet", ..., "infoURL": "https://ethereum.org" }
// Equivalent
chains.getByName('Ethereum Mainnet')
```
### Get all Chains:
```ts
const allChains = chains.all()
// { 1: { name: "Ethereum Mainnet", ..., "infoURL": "https://ethereum.org" }, 2: {...}}
```
### Typescript Types:
```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](https://github.com/quicktype/quicktype) to autogen types from json
- [x] Autogen Chain Id enum
- [x] Autogen Chain Name enum