prepareWithdrawal

Prepare transaction data for submitting a withdrawal order through the unified withdrawal wrapper. prepareWithdrawal() is the recommended execution helper for most integrations.

prepareWithdrawal() does not check or enforce allowance. Run prepareWithdrawalAuthorization first if you need approval routing.

Import

import { prepareWithdrawal } from "@paxoslabs/amplify-sdk";

Usage

const txData = await prepareWithdrawal({
  yieldType: "CORE",
  wantAsset: "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", // USDC
  withdrawAmount: "1.0", // Vault shares to offer
  userAddress: "0x1234...",
  chainId: 1,
});

const hash = await walletClient.writeContract(txData);

Parameters

Parameter	Type	Required	Description
`yieldType`	`YieldType`	Yes	Yield strategy (CORE, TREASURY, FRONTIER)
`wantAsset`	`Address`	Yes	Token address user wants to receive
`withdrawAmount`	`string`	Yes	Vault shares to withdraw (decimal string)
`userAddress`	`Address`	Yes	User wallet address
`chainId`	`ChainId`	Yes	Chain ID

Return Type

Returns PrepareWithdrawalResult (alias of WithdrawOrderTxData), ready for writeContract.

Recommended Flow

Check Authorization

const auth = await prepareWithdrawalAuthorization({
  yieldType: "CORE",
  wantAsset: USDC_ADDRESS,
  withdrawAmount: "1.0",
  userAddress,
  chainId: 1,
});

if (isWithdrawApprovalAuth(auth)) {
  await walletClient.writeContract(auth.txData);
}

Prepare Withdrawal Tx

const withdrawTx = await prepareWithdrawal({
  yieldType: "CORE",
  wantAsset: USDC_ADDRESS,
  withdrawAmount: "1.0",
  userAddress,
  chainId: 1,
});

Submit Transaction

await walletClient.writeContract(withdrawTx);

prepareWithdrawalAuthorization - Authorization routing
prepareWithdrawOrderTxData - Low-level withdraw order builder
prepareApproveWithdrawOrderTxData - Manual vault share approval

Getting started

Origin - Branded Stablecoins

Amplify - Stablecoin Earn

Access - Borrow

USDG0

Import

Usage

Parameters

Return Type

Recommended Flow

​Import

​Usage

​Parameters

​Return Type

​Recommended Flow

​Related

Import

Usage

Parameters

Return Type

Recommended Flow

Related