Skip to Content
API ReferenceAvail node API referenceUnbond AVAIL tokens from Avail DA

Unbond AVAIL tokens from Avail DA

On-chain name of extrinsic: staking_unbond

Parameters

parametertypeoptionaldescription
valueBNfalseamount of tokens to unbond
waitForWaitForfalsewait for block inclusion or finalization
accountKeyringPairfalseaccount that will send and sign the transaction
optionsSignerOptionstrueused to overwrite existing signer options

Returns

On failure, a reason of failure is returned. On Success, Unbonded event, transaction hash and block hash is returned.

Minimal example

  1. You will need to set up the dev environment required to run this example. For instructions, check out our docs here.

  2. If you’re sending an extrinsic (i.e conducting a transaction) you will need to replace the demo seed phrase with your own seed phrase. The rest of the code should work as is.

  1. Inside your-file-name.ts, add the following code:
avail-js
import * as dotenv from 'dotenv'; import { Account, SDK, BN, Pallets } from 'avail-js-sdk'; dotenv.config(); export async function stakingUnbond() { // Initialize SDK with Turing endpoint const sdk = await SDK.New('wss://turing-rpc.avail.so/ws'); // Create account from seed in .env file const seed = process.env.SEED; if (!seed) { throw new Error("SEED environment variable is not set"); } // Create account from seed const account = Account.new(seed); console.log("Account Address: ", account.address); // Unbond amount: 1 AVAIL const value = new BN(10).pow(new BN(18)); // 1 AVAIL console.log("Unbond Amount: 1 AVAIL"); // Create unbond transaction const tx = sdk.tx.staking.unbond(value); console.log("Submitting unbond transaction..."); // Execute and wait for inclusion const res = await tx.executeWaitForInclusion(account, {}); // Check if transaction was successful const isOk = res.isSuccessful(); if (isOk === undefined) { throw new Error("Cannot check if transaction was successful"); } else if (!isOk) { throw new Error("Transaction failed"); } console.log("Unbond operation completed successfully"); console.log(`Transaction Hash: ${res.txHash}`); console.log(`Block Hash: ${res.blockHash}`); process.exit(0); } // Execute the function stakingUnbond();
  1. Run the code using:
terminal
ts-node your-file-name.ts
Last updated on