Quickstart
yarn add depay-web3-tokens
or
npm install --save depay-web3-tokens
import { Token } from 'depay-web3-tokens'
let token = new Token({
blockchain: 'ethereum',
address: '0xa0bed124a09ac2bd941b10349d8d224fe3c955eb'
});
token.address // '0xa0bEd124a09ac2Bd941b10349d8d224fe3c955eb'
await token.decimals() // 18
await token.symbol() // 'DEPAY'
await token.name() // 'DePay'Support
This library supports the following blockchains:
Functionalities
initalize (new)
import { Token } from 'depay-web3-tokens'
let token = new Token({
blockchain: 'ethereum',
address: '0xa0bed124a09ac2bd941b10349d8d224fe3c955eb'
});decimals
Retrieves token decimals
await token.decimals() // 18symbol
Retrieves token symbol
await token.symbol() // DEPAYname
Retrieves token name
await token.name() // DePaybalance
Provides the balance (BigNumber) of the given account:
await token.balance('0xb0252f13850a4823706607524de0b146820F2240') // BigNumber {_hex: "0x0b896d5e9eeaabf4f1", _isBigNumber: true}this also works for the native token of the given blockchain:
let token = new Token({ ..., address: '0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE' })
await token.balance('0xb0252f13850a4823706607524de0b146820F2240') // BigNumber {_hex: "0x0b896d5e9eeaabf4f1", _isBigNumber: true}BigNumber
Provides the BigNumber amount for a given token (based on the tokens decimals) based on a human readable amount:
let token = new Token({
blockchain: 'ethereum',
address: '0xa0bed124a09ac2bd941b10349d8d224fe3c955eb'
})
await token.BigNumber(1) // BigNumber '1000000000000000000'await Token.BigNumber({
amount: 1,
blockchain: 'ethereum',
address: '0xa0bed124a09ac2bd941b10349d8d224fe3c955eb'
}) // BigNumber '1000000000000000000'readable
Provides a human readable amount based on a given BigInt number.
-
Ending zeros will be eliminated
1.30000->1.3 -
Decimals are dropped if there are none
1.00000->1
await Token.readable({
amount: '1231211111210000000',
blockchain: 'ethereum',
address: '0xa0bed124a09ac2bd941b10349d8d224fe3c955eb'
}) // "1.23121111121"let token = new Token({
blockchain: 'ethereum',
address: '0xa0bed124a09ac2bd941b10349d8d224fe3c955eb'
})
await token.readable('1231211111210000000') // "1.23121111121"Token Standards
depay-web3-tokens exports standard token apis, like ERC20, BEP20 etc.:
import { Token } from 'depay-web3-tokens'
Token.ethereum.ERC20 // [...] ERC20 ABI
Token.bsc.BEP20 // [...] BEP20 ABIDEFAULT references the broad default token standard on the respective blockchain:
import { Token } from 'depay-web3-tokens'
Token.ethereum.DEFAULT // ERC20
Token.bsc.DEFAULT // BEP20
Token[blockchain].DEFAULTDevelopment
Get started
yarn install
yarn dev
Release
npm publish