Skip to content

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): number

Returns ​

number

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

Parameters ​

accountId ​

  • Type: string
  • Required: no

The account whose scan progress is read. Defaults to the active account.

ts
const result = getScanProgress({
  accountId, 
});

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.

Source ​

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