@asset-projects/token-balance/README.md

A library for retrieving the amount of ERC20 tokens held by a specific address.

# @asset-projects/token-balance

[![npm](https://img.shields.io/npm/v/@asset-projects/token-balance)](https://unpkg.com/@asset-projects/token-balance@latest/)[![Package size](https://badgen.net/bundlephobia/minzip/@asset-projects/token-balance)](https://bundlephobia.com/package/@asset-projects/token-balance)[![!License](https://badgen.net/npm/license/@asset-projects/token-balance)](https://github.com/asset-projects/token-balance/blob/main/LICENSE)  
[![Build](https://github.com/asset-projects/token-balance/actions/workflows/build.yml/badge.svg)](https://github.com/asset-projects/token-balance/actions/workflows/build.yml)[![Test](https://github.com/asset-projects/token-balance/actions/workflows/test.yml/badge.svg)](https://github.com/asset-projects/token-balance/actions/workflows/test.yml)

A library for retrieving the amount of ERC20 tokens held by a specific address.

## Install on your project

1. Installing

```zsh
  # npm
  npm i @asset-projects/token-balance

  # yarn
  yarn add @asset-projects/token-balance
```

2. Implementation

```ts
import { ethers } from 'ethers';
import { erc20Tokens } from '@asset-projects/token-balance';

/** Prepare a provider */
const provider = new ethers.providers.JsonRpcProvider(url);

// or
const provider = new ethers.providers.InfuraProvider('homestead', {
  projectId: process.env.INFURA_PROJECT_ID,
  projectSecret: process.env.INFURA_PROJECT_SECRET,
});

/** Main */
const tokens = await erc20Tokens(provider, address);
console.log({ tokens });
/**
 * {
 *   tokens: [
 *     {
 *       chainId: 1,
 *       type: 'ERC20',
 *       address: '0x6b175474e89094c44da98b954eedeac495271d0f',
 *       name: 'Dai Stablecoin',
 *       symbol: 'Dai',
 *       decimals: 18,
 *       logoURI: 'https://raw.githubusercontent.com/asset-projects/token-list/main/public/dai.png'
 *       balance: '100.100000000000000000',
 *     }
 *   ]
 * }
 */
```