0.0.2 • Published 2 years ago

@hashex/web3-chains v0.0.2

Weekly downloads
-
License
ISC
Repository
github
Last release
2 years ago

HashEx WEB3 Chains

npm version

HashEx WEB3 Chains library is a set of useful WEB3 Chains constans and utils.

Installation

  • via yarn
yarn add @hashex/web3-chains
  • via npm
npm i @hashex/web3-chains

Exported constants

    import { CHAIN_ID, CHAIN_PARAMS } from '@hashex/web-chains'

    const ethereumParams = CHAIN_PARAMS[CHAIN_ID.MAINNET];

    const { icon, chainId, chainIdHex, chainName, nativeCurrency, rpcUrls, explorerUrls } = ethereumParams;

    const { name, symbol, decimals } = nativeCurrency;

Chain utils

getChainIcon(chainId: CHAIN_ID, defaultIcon?: string): string - returns chain icon stored in https://github.com/hashex/icons or passed defaultIcon if wasn't found in constants.

getChainLabel(chainId: CHAIN_ID, defaultLabel?: string): string - returns chain label or passed defaultLabel if wasn't found in constants.

getChainNativeCurrency(chainId: CHAIN_ID, defaultNativeCurrency: Partial<NativeCurrency> = {}): NativeCurrency - returns chain native currency or passed defaultNativeCurrency if wasn't found in constants.

getChainRPCUrls(chainId: CHAIN_ID, defaultRPCUrls: string[] = []): string[] - returns an array of chain RPC urls merged with passed defaultRPCUrls.

getChainExplorerUrls(chainId: CHAIN_ID, defaultBlockExplorers: string[] = []): string[] - returns an array of chain block explorer urls merged with passed defaultBlockExplorers.

getChainParams(chainId: CHAIN_ID, options: Partial<ChainParams> = {}): ChainParams - returns chain params merged with passed options

Supported Chains

  • Ethereum
  • Polygon (Matic)
  • Fantom
  • Gnosis (xDai)
  • Binance Smart Chain
  • Arbitrum
  • Moonbeam
  • Avalanche
  • Heco
  • Harmony
  • OKEX
  • Cronos
  • Aurora
  • Moonriver

Supported Testnet Chains

Matic testnet, Fantom testnet, Binance Smart Chain testnet, Arbitrum testnet, Moonbeam testnet, Avalanche testnet, Harmony testnet, Heco testnet, Okex Testnet, Cronos testnet, Aurora testnet, Aurora Betanet

License

This project is licensed under the MIT License - Copyright (c) 2022 HashEx