getBalances

Get an account's shielded balances from storage, optionally refreshing first.

Import

import { getBalances } from "@0xcurvy/curvy-sdk/actions";

Usage

await getBalances();                       // active account, cached
await getBalances({ accountId });           // explicit account
await getBalances({ cached: false });      // refresh from chain first

Signature

function getBalances(parameters?: GetBalancesParameters): Promise<BalanceEntry[]>

Returns

Promise<BalanceEntry[]>

The action resolves or returns the value shown in the signature.

Parameters

cached

• Type: boolean
• Required: no

When false, refresh from chain first. Defaults to true (cached).

const result = await getBalances({
  cached: false, 
});

accountId

• Type: string
• Required: no

Target a specific account; defaults to the active account.

const result = await getBalances({
  accountId, 
});

inputFinalityPolicy

• Type: InputFinalityPolicy
• Required: no

Override account preference for this read.

const result = await getBalances({
  inputFinalityPolicy: "finalized", 
});

config

• Type: CurvyConfig
• Required: no

Curvy config to use. Defaults to the ambient config.

const result = await getBalances({
  config, 
});

Errors

• NoActiveAccountError when no accountId is given and no account is active.

Related

• Querying balances guide
• refreshBalances — Re-sync and persist an account's shielded balances.
• getScanProgress — Read the current balance-scan progress from 0 to 100.
• pauseBalanceRefresh — Pause new balance refreshes for an account.
• resumeBalanceRefresh — Allow balance refreshes for an account after a matching pause.

Source

packages/@0xcurvy/sdk/src/actions/balances/getBalances.ts