Skip to content

Latest commit

 

History

History
34 lines (22 loc) · 1.46 KB

buildWithdrawUnstakedTransaction.md

File metadata and controls

34 lines (22 loc) · 1.46 KB

buildWithdrawUnstakedTransaction

buildWithdrawUnstakedTransaction(params): Promise<UnstakeQueueTransactionData>

Generates transaction data to withdraw from the unstake queue

This method is the final step in the unstaking process. Once assets in the unstake queue have reached a withdrawable state (as determined by the getUnstakeQueueForVault method), the buildWithdrawUnstakedTransaction method prepares the transaction data necessary for transferring these assets back into the user's wallet.

Parameters

Name Type Description
params Object Parameters for building the transaction
params.vault Hex A vault address
params.queueItems UnstakeQueueItem[] An array of queue items to withdraw (see getUnstakeQueueForVault)

Returns

Promise<UnstakeQueueTransactionData>

A promise that resolves to a transaction data object

Remarks

Integrations should use their preferred wallet interface to broadcast the transaction via RPC nodes of their choice. This method is stateless and only generates transaction bytes, leaving the signing and broadcasting up to the code integrating the SDK

See

Unstaking for more information