pauseBalanceRefresh
Pause new balance refreshes for an account.
Defaults accountId to the active account (state.activeAccountId).
Import
ts
import { pauseBalanceRefresh } from "@0xcurvy/curvy-sdk/actions";Usage
ts
pauseBalanceRefresh(); // active account
pauseBalanceRefresh({ accountId }); // explicit accountSignature
ts
function pauseBalanceRefresh(parameters?: PauseBalanceRefreshParameters): voidReturns
void
The action resolves or returns the value shown in the signature.
Parameters
accountId
- Type:
string - Required: no
The account whose balance-refresh lock should be paused. Defaults to the active account.
ts
pauseBalanceRefresh({
accountId,
});config
- Type:
CurvyConfig - Required: no
Curvy config to use. Defaults to the ambient config.
ts
pauseBalanceRefresh({
config,
});Errors
Errors from config resolution and the underlying SDK operation are propagated to the caller.
Related
- Querying balances guide
getBalances— Get an account's shielded balances from storage, optionally refreshing first.refreshBalances— Re-sync and persist an account's shielded balances.getScanProgress— Read the current balance-scan progress from 0 to 100.resumeBalanceRefresh— Allow balance refreshes for an account after a matching pause.
Source
packages/@0xcurvy/sdk/src/actions/balances/pauseBalanceRefresh.ts