Documentation Index
Fetch the complete documentation index at: https://developers.paxoslabs.com/llms.txt
Use this file to discover all available pages before exploring further.
Reads the minimum withdrawal order size from the on-chain WithdrawQueue contract. Use this to validate user input before submitting a withdrawal order.
Import
import { getMinimumWithdrawalOrderSize } from "@paxoslabs/amplify-sdk";
Usage
import { getMinimumWithdrawalOrderSize, YieldType } from "@paxoslabs/amplify-sdk";
const result = await getMinimumWithdrawalOrderSize({
yieldType: YieldType.CORE,
chainId: 1,
assetAddress: "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
});
console.log(result.minimumOrderSize); // bigint
console.log(result.shareDecimals); // number
Parameters
| Parameter | Type | Required | Description |
|---|
yieldType | YieldType | Yes | Yield strategy type |
chainId | ChainId | Yes | Blockchain network ID |
assetAddress | Address | Yes | Asset address for vault lookup |
interface GetMinimumWithdrawalOrderSizeParams {
yieldType: YieldType;
chainId: ChainId;
assetAddress: Address;
}
Return Type
interface MinimumWithdrawalOrderSizeResult {
/** Minimum order size in vault share units */
minimumOrderSize: bigint;
/** Vault share token decimals */
shareDecimals: number;
}
import { getMinimumWithdrawalOrderSize, YieldType } from "@paxoslabs/amplify-sdk";
import { parseUnits, formatUnits } from "viem";
const result = await getMinimumWithdrawalOrderSize({
yieldType: YieldType.CORE,
chainId: 1,
assetAddress: usdcAddress,
});
const userAmount = parseUnits(userInput, result.shareDecimals);
if (userAmount < result.minimumOrderSize) {
const min = formatUnits(result.minimumOrderSize, result.shareDecimals);
console.error(`Minimum withdrawal is ${min} shares`);
}
Error Handling
| Error Message Pattern | Description | Resolution |
|---|
"No vault found" | No vault matches parameters | Verify yieldType, asset, chainId |
"SDK not initialized" | SDK not initialized | Call initAmplifySDK() first |
