force_release_deposit

Call v154 → current #7

Force-release a deposit even during safe-mode (privileged origin only).

View calls on chain

Click items to navigate. Pan and zoom to explore.

Used by: validatorsdevelopers

The Big Picture

Governance can override standard release restrictions to return deposits when the situation clearly warrants it, without waiting for normal delays.

Use Cases

  • Release deposit during safe-mode if needed
  • Override ReleaseDelay in special cases

From Chain Metadata

Force to release a deposit for an account that entered safe-mode at a given historical block. This can be called while safe-mode is still entered. Emits a [`Event::DepositReleased`] event on success. Errors with [`Error::Entered`] if safe-mode is entered. Errors with [`Error::NoDeposit`] if the payee has no reserved currency at the specified block. Can only be called by the [`Config::ForceDepositOrigin`] origin.

Input Parameters

#NameTypeDescription
0
account
AccountId account: Account address (32 bytes, SS58-encoded) (hex -> SS58)
1
block
u32 BlockNumberFor<T>block: Block number

Permissions

Origin
Unknown
Required Role

Permission data inferred from metadata. May be incomplete.

Requirements

  • Caller is ForceDepositOrigin
  • Account has a deposit at the specified block

Effects

Events Emitted

Storage Modified

Postconditions

  • Deposit unreserved and returned to account
  • DepositReleased event emitted

Code Examples

import { createClient, Binary } from "polkadot-api";
import { getWsProvider } from "polkadot-api/ws";
import { sub } from "@polkadot-api/descriptors"; // generated by: npx papi add sub -w wss://entrypoint-finney.opentensor.ai:443

const client = createClient(getWsProvider("wss://entrypoint-finney.opentensor.ai:443"));
const api = client.getTypedApi(sub);

// Build force_release_deposit call (typed, named args)
const account = "5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY";
const block = 0;

const tx = api.tx.SafeMode.force_release_deposit({
  account,
  block,
});

Runtime Info

Pallet Index
20
Call Index
7
First Version
v154
Current Version
v411