Transfer all funds from one account to another
On-chain name of extrinsic: balances_transferAll
Parameters
| parameter | type | optional | description |
|---|---|---|---|
| dest | string | false | account that will receive funds |
| keepAlive | boolean | false | if set to false it will reap the account as well |
| waitFor | WaitFor | false | wait for block inclusion or finalization |
| account | KeyringPair | false | account that will send and sign the transaction |
| options | SignerOptions | true | used to overwrite existing signer options |
Return value
On failure, a reason of failure is returned. On Success, TransferEvent event, KilledAccount (optionally) event, transaction hash and block hash is returned.
Minimal Example
-
You will need to set up the dev enviornment required to run this example. For instructions, check out our docs here.
-
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.
- Inside
your-file-name.ts, add the following code:
avail-js
import { SDK, WaitFor, Keyring, BN } from "avail-js-sdk"
const main = async () => {
const providerEndpoint = "wss://turing-rpc.avail.so/ws";
const sdk = await SDK.New(providerEndpoint)
const Alice = 'This is a random seed phrase please replace with your own';
const account = new Keyring({ type: "sr25519" }).addFromUri(Alice)
const dest = "5HGjWAeFDfFCWPsjFQdVV2Msvz2XtMktvgocEZcCj68kUMaw" // Eve
const keepAlive = true
const result = await sdk.tx.balances.transferAll(dest, keepAlive, WaitFor.BlockInclusion, account)
if (result.isErr) {
console.log(result.reason)
process.exit(1)
}
console.log("From=" + result.event.from + ", To=" + result.event.to + ", Amount=" + result.event.amount)
console.log("MaybeKilled=" + result.event2?.account)
console.log("TxHash=" + result.txHash + ", BlockHash=" + result.blockHash)
process.exit()
}
main()- Run the code using:
ts-node your-file-name.ts