API Reference

Complete function reference for the Amplify SDK

The Amplify SDK provides functions for initializing the SDK, fetching data, and preparing transactions for deposits and withdrawals.

Initialization

initAmplifySDK

Initialize the SDK with your API key before using any other functions.

fetchSupportedAssets

Fetch supported tokens and vault configurations for a yield type.

Deposits

Deposit Workflow

The unified deposit API with prepareDepositAuthorization and prepareDeposit.

prepareDepositTxData

Prepare transaction data for a standard deposit after approval.

prepareDepositWithPermitTxData

Prepare transaction data for a permit-based deposit (single transaction).

Withdrawals

prepareWithdrawalAuthorization

Check approval requirements and prepare withdrawal authorization.

prepareWithdrawal

Prepare transaction data through the unified withdrawal wrapper.

prepareWithdrawOrderTxData

Build low-level WithdrawQueue order transaction data.

prepareApproveWithdrawOrderTxData

Build low-level approval transaction data for vault shares.

Display Helpers

Display Helpers

UI helper functions for showing vault APY, TVL, fees, share calculations, and withdrawal history.

Function Quick Reference

Function	Description
initAmplifySDK	Initialize SDK with API key and options
fetchSupportedAssets	Get supported tokens for a yield type
prepareDepositAuthorization	Determine optimal authorization method
prepareDeposit	Prepare deposit with auto-detected method
prepareDepositTxData	Prepare standard deposit transaction
prepareDepositWithPermitTxData	Prepare permit-based deposit transaction
prepareWithdrawalAuthorization	Determine if withdrawal approval is required
prepareWithdrawal	Prepare withdrawal execution transaction
prepareWithdrawOrderTxData	Prepare low-level WithdrawQueue submission
prepareApproveWithdrawOrderTxData	Prepare low-level withdraw approval transaction
findVaultByConfig	Discover vault address by asset, yield type, and chain
getMinimumMint	Calculate expected vault shares for a deposit
getVaultAPY	Fetch latest vault APY
getVaultTVL	Fetch vault total value locked
getWithdrawalFee	Calculate withdrawal fees
getWithdrawalRequests	Fetch user’s withdrawal requests
getMinimumWithdrawalOrderSize	Get minimum withdrawal order size

Type Guards

The SDK exports type guards for handling discriminated union results:

import {
  prepareWithdrawalAuthorization,
  isPermitAuth,
  isApprovalAuth,
  isAlreadyApprovedAuth,
  isWithdrawApprovalAuth,
  isWithdrawAlreadyApprovedAuth,
} from "@paxoslabs/amplify-sdk";

const auth = await prepareDepositAuthorization(params);

if (isPermitAuth(auth)) {
  // auth.permitData is available
} else if (isApprovalAuth(auth)) {
  // auth.txData is available
} else if (isAlreadyApprovedAuth(auth)) {
  // auth.allowance is available
}

const withdrawAuth = await prepareWithdrawalAuthorization({
  // ...
});
if (isWithdrawApprovalAuth(withdrawAuth)) {
  // withdrawAuth.txData is available
} else if (isWithdrawAlreadyApprovedAuth(withdrawAuth)) {
  // withdrawAuth.allowance is available
}

See DepositAuthMethod for full type documentation.