VaultWithdraw

[Source]

Redeem vault shares for assets. The amount of assets received depends on the exchange rate, which adjusts based on the vault’s total assets and any unrealized losses.

Note

The VaultWithdraw transaction does not respect the Permissioned Domain rules. In other words, any account that holds the shares of the vault can redeem them. This is to avoid a situation where a depositor deposits assets to a private vault to then have their access revoked by invalidating their credentials, and thus losing access to their funds.

A depositor cannot redeem liquidity if the trust line or the MPToken between the pseudo-account and the issuer of the vault asset is frozen or locked.

(Requires the Single Asset Vault amendment )

Example VaultWithdraw JSON

{
  "TransactionType": "VaultWithdraw",
  "Account": "ra5nK24KXen9AHvsdFTKHSANinZseWnPcX",
  "Fee": "12",
  "Flags": 0,
  "LastLedgerSequence": 7108682,
  "Sequence": 8,
  "VaultID": "77D6234D074E505024D39C04C3F262997B773719AB29ACFA83119E4210328776",
  "Amount" : "10000",
  "Destination": "ruazs5h1qEsqpke88pcqnaseXdm6od2xc"
}

VaultWithdraw Fields

In addition to the common fields, VaultWithdraw transactions use the following fields:

Field Name	JSON Type	Internal Type	Required?	Description
`VaultID`	String	Hash256	Yes	The unique identifier of the vault to which the assets are deposited.
`Amount`	Number	Amount	Yes	The exact amount of vault asset to withdraw or vault share to redeem.
`Destination`	String	AccountID	No	An account to receive the assets. This account must be able to receive the vault asset or the transaction fails.

There are two ways to specify the transaction Amount field:

Specify Assets	Specify Shares
If the `Amount` field specifies an asset amount (e.g., 100 XRP), the transaction burns the necessary number of shares to provide the requested amount. If the vault has an unrealized loss, withdrawing the same amount of assets requires burning more shares.	If the `Amount` field specifies a share amount (e.g., 500 vault shares), the transaction converts those shares into the corresponding amount of assets. If the vault has an unrealized loss, each share is worth less, meaning fewer assets are received.

VaultWithdraw Flags

There are no flags defined for VaultWithdraw transactions.

Transfer Fees

A single asset vault does not apply the transfer fee to VaultWithdraw transactions. Additionally, whenever a protocol moves assets from or to a vault, the Transfer Fee must not be charged.

Error Cases

Besides errors that can occur for all transactions, VaultWithdraw transactions can result in the following transaction result codes: