📌balanceOf

Description

The balanceOf function is an asynchronous function that retrieves the balance of a specific token for a given address in a specified contract on a particular blockchain.

Parameters

Parameter	Data Type	Description
blockchain	string	The name or symbol of the blockchain.
contractAddress	string	The address of the contract on the blockchain.
address	string	The address for which the token balance is to be retrieved.
tokenId	string	The ID of the token for which the balance is to be retrieved.
env	string	The environment or network where the contract exists (e.g., 'mainnet', 'testnet').

Response

Field	Data Type	Description
code	number	A numeric value indicating the execution status (1 for success, 0 for error).
error	any	The error object containing details about the encountered error, if applicable.
result	string	The balance of the specified token for the given address.

Example Request and Response

Prerequisites

Before making requests with NEST® SDK, you must have it installed.

You can install NEST® SDK using either npm or yarn. Use the following commands to install NEST® SDK:

npm install @nest25/evm-chains-lib
OR
yarn add @nest25/evm-chains-lib

Request

Here is an example of how to make a balanceOf request using the NEST® SDK:

const { ERC1155 } = require('@nest25/evm-chains-lib');

const erc1155 = new ERC1155();
const privateKey = "your private key"

async function main() {
    const response = await erc1155.balanceOf('ava','0x1d224f9ba0c15058601e18b171e87cdadfc8de45',"0x1148d4a18e53f8072734325ed5e72dbb7aeb6fa6",'354856');
    console.log(response)
}

main();

Response

{ code: 1, result: '85' }

Use Cases

• The balanceOf function can be used to retrieve the balance of a specific token for a given address in a contract.