Bank Queries

Query token balances, total supply, and denomination metadata using the bank extension

The bank extension queries token balances, supply, and denomination metadata.

import { QueryClient, setupBankExtension } from "@cosmjs/stargate";
import { connectComet } from "@cosmjs/tendermint-rpc";

const cometClient = await connectComet("https://rpc.my-chain.network");
const queryClient = QueryClient.withExtensions(cometClient, setupBankExtension);

const balance = await queryClient.bank.balance("cosmos1...", "uatom");
console.info(balance); // { denom: "uatom", amount: "1000000" }

const allBalances = await queryClient.bank.allBalances("cosmos1...");
console.info(allBalances); // [{ denom: "uatom", amount: "1000000" }, ...]

Available Methods

Method	Parameters	Returns
balance	address, denom	Coin
allBalances	address	Coin[]
totalSupply	paginationKey?	QueryTotalSupplyResponse
supplyOf	denom	Coin
denomMetadata	denom	Metadata
denomsMetadata	—	Metadata[]

Total Supply with Pagination

const firstPage = await queryClient.bank.totalSupply();
console.info(firstPage.supply);

if (firstPage.pagination?.nextKey?.length) {
  const secondPage = await queryClient.bank.totalSupply(firstPage.pagination.nextKey);
  console.info(secondPage.supply);
}

totalSupply is the only paginated method in the bank module. See Pagination for the general pattern.

Next Steps

Staking Queries

Validators, delegations, and staking pool.

Pagination

Navigate paginated result sets.