getScanProgress
Read the current balance-scan progress from 0 to 100.
Import
ts
import { getScanProgress } from "@0xcurvy/curvy-sdk/actions";Usage
ts
const pct = getScanProgress();Signature
ts
function getScanProgress(parameters?: GetScanProgressParameters): numberReturns
number
The action resolves or returns the value shown in the signature.
Parameters
config
- Type:
CurvyConfig - Required: no
Curvy config to use. Defaults to the ambient config.
ts
const result = getScanProgress({
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.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/getScanProgress.ts