Skip to content

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 account

Signature

ts
function pauseBalanceRefresh(parameters?: PauseBalanceRefreshParameters): void

Returns

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.

Source

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