@depay/web3-constants

JavaScript library providing all common constants for web3 blockchains like MAXINT, ZERO etc.

Usage no npm install needed!

<script type="module">
  import depayWeb3Constants from 'https://cdn.skypack.dev/@depay/web3-constants';
</script>

README

Quickstart

yarn add @depay/web3-constants

or

npm install --save @depay/web3-constants
import { CONSTANTS } from '@depay/web3-constants'

CONSTANTS['ethereum'].ZERO  // '0x0000000000000000000000000000000000000000'
CONSTANTS['ethereum'].MAXINT  // '115792089237316195423570985008687907853269984665640564039457584007913129639935'
CONSTANTS['ethereum'].NATIVE  // '0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE'
CONSTANTS['ethereum'].DECIMALS  // 18
CONSTANTS['ethereum'].WRAPPED  // '0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2'
CONSTANTS['ethereum'].SYMBOL  // 'ETH'
CONSTANTS['ethereum'].CURRENCY  // 'Ether'
CONSTANTS['ethereum'].NAME  // 'Ethereum'
CONSTANTS['ethereum'].USD  // '0x6B175474E89094C44Da98b954EedeAC495271d0F' (DAI)

CONSTANTS['bsc'].ZERO  // '0x0000000000000000000000000000000000000000'
CONSTANTS['bsc'].MAXINT  // '115792089237316195423570985008687907853269984665640564039457584007913129639935'
CONSTANTS['bsc'].NATIVE  // '0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE'
CONSTANTS['bsc'].DECIMALS  // 18
CONSTANTS['bsc'].WRAPPED  // '0xbb4CdB9CBd36B01bD1cBaEBF2De08d9173bc095c'
CONSTANTS['bsc'].SYMBOL  // 'BNB'
CONSTANTS['bsc'].CURRENCY  // 'Binance Coin'
CONSTANTS['bsc'].NAME  // 'Binance Smart Chain'
CONSTANTS['bsc'].USD  // '0xe9e7CEA3DedcA5984780Bafc599bD69ADd087D56' (BUSD)

Constants

ZERO

The Address Zero.

CONSTANTS[blockchain].ZERO

e.g. CONSTANTS['ethereum'].ZERO // '0x0000000000000000000000000000000000000000'

MAXINT

The number value (as a string) representing the maximum integer value (usually uint256).

CONSTANTS[blockchain].MAXINT

e.g. CONSTANTS['ethereum'].ZERO // '115792089237316195423570985008687907853269984665640564039457584007913129639935'

NATIVE

The address used to represent the native blockchain token alongside other token addresses.

CONSTANTS[blockchain].NATIVE

e.g. CONSTANTS['ethereum'].NATIVE // '0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE'

DECIMALS

The decimals for the native token of the individual blockchain.

CONSTANTS[blockchain].DECIMALS

e.g. CONSTANTS['ethereum'].DECIMALS // 18

WRAPPED

The address of the token contract providing a wrapped token of individual blockchain's native token.

CONSTANTS[blockchain].WRAPPED

e.g. CONSTANTS['ethereum'].WRAPPED // '0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2'

SYMBOL

The symbol of the native currency.

CONSTANTS[blockchain].SYMBOL

e.g. CONSTANTS['ethereum'].SYMBOL // 'ETH'

CURRENCY

The written-out name of the native token on that blockchain.

CONSTANTS[blockchain].CURRENCY

e.g. CONSTANTS['ethereum'].CURRENCY // 'Ether'

NAME

The written-out name of the blockchain.

CONSTANTS[blockchain].NAME

e.g. CONSTANTS['ethereum'].NAME // 'Ethereum'

Development

Get started

yarn install
yarn dev

Release

npm publish