instantWithdrawal

instantWithdrawal is a method on the ARIO class that instantly withdraws funds from an existing vault on a gateway. If no gatewayAddress is provided, the signer's address will be used.

instantWithdrawal requires authentication.

Parameters

Parameter	Type	Description	Required
gatewayAddress	string	The gateway address where the vault exists	No
vaultId	string	The ID of the vault to withdraw from	Yes
tags	array	An array of GQL tag objects to attach to the transaction	No

Examples

instantWithdrawal

 const fs = require("fs");
 const { ARIO, ArweaveSigner } = require("@ar.io/sdk");

 async function main() {
 const jwk = JSON.parse(fs.readFileSync("KeyFile.json"));
 const ario = ARIO.init({
     signer: new ArweaveSigner(jwk),
 });

 const { id: txId } = await ario.instantWithdrawal(
         {
             // gateway address where delegate vault exists
             gatewayAddress: 't4Xr0_J4Iurt7caNST02cMotaz2FIbWQ4Kbj616RHl3',
             // delegated vault id to cancel
             vaultId: 'fDrr0_J4Iurt7caNST02cMotaz2FIbWQ4Kcj616RHl3',
         },
         // optional additional tags
         {
             tags: [{ name: 'App-Name', value: 'My-Awesome-App' }],
         },
         );
         // removes an operator vault from a gateway
         const { id: txId } = await ario.instantWithdrawal(
         {
             vaultId: 'fDrr0_J4Iurt7caNST02cMotaz2FIbWQ4Kcj616RHl3',
         },
     );
 }

 main();