Skip to content

Latest commit

 

History

History
34 lines (22 loc) · 1.37 KB

buildUnstakeTransaction.md

File metadata and controls

34 lines (22 loc) · 1.37 KB

buildUnstakeTransaction

buildUnstakeTransaction(params): Promise<UnstakeTransactionData>

Generates unstake transaction data to withdraw from the chosen vault

The unstake transaction effectively moves the user's assets into an unstake queue where they remain until they become eligible for withdrawal. This queue is a safeguard mechanism that ensures the liquidity and stability of the vault by managing the flow of assets. To check the status of these assets, use the getUnstakeQueueForVault method.

Parameters

Name Type Description
params Object Parameters for building the transaction
params.vault Hex A vault address
params.amount bigint An amount of ETH to unstake, denominated in wei

Returns

Promise<UnstakeTransactionData>

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