/ethers-balances

Primary LanguageTypeScript

Ethers-balances

This is a simple tool that allows you to retrieve the balances of ether and stablecoin for a given address on multiple chains. The tool is implemented as a JavaScript function called getBalances, which takes an address as input and returns an object containing the balances on each supported chain.

With this tool, you can easily check your account balances across various chains without having to manually check each chain's explorer.

Supported chains:

  • ethereum
  • moonbeam
  • moonriver
  • polygon
  • avalanche

Supported Tokens:

  • USDC
  • USDT
  • Wormhole_USDC
  • Wormhole_USDT
  • Multichain_USDC
  • Multichain_USDT
  • Multichain_DAI
  • xcKSM

To use the tool, simply pass an address to the getBalances function and it will return the balances for the specified address on each supported chain.

Install

npm i ethers-balances

After installation, you can import the getBalances function in your code as follows:

const { getBalances } = require('ether-balances');

Usage

const {getBalances} = require("ethers-balances")


async function main(){
    const result = await getBalances("0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48")
    console.log(result)

}

main()
.catch((e)=>{
    console.error(e)
    process.exit(1)
})

output

{
  etherBalances: {
    ethereum: '0.0 ETH',
    moonbeam: '31.5793 GLMR',
    moonriver: '0.0 MOVR',
    polygon: '44287.5803 MATIC',
    avalanche: '65.3016 AVAX'
  },
  erc20Balances: {
    ethereum: { USDC: '0.0', USDT: '51390.1224' },
    moonbeam: {
      Wormhole_USDC: '0.0',
      Multichain_USDC: '97.0206',
      Multichain_USDT: '0.0'
    },
    moonriver: { Multichain_USDC: '5.5', Multichain_USDT: '0.0', xcKSM: '0.0' },
    polygon: {
      USDC: '16179.4030',
      USDT: '0.0',
      Wormhole_USDC: '16179.4030',
      Wormhole_USDT: '11.8264'
    },
    avalanche: { USDC: '8353.9902', USDT: '2313.5021' }
  }
}

Contributing

If you find a bug or have a feature request, please create an issue on the GitHub repository. Pull requests are also welcome!