API Reference

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

prepareApproveWithdrawTxData

Prepare the approval transaction required before withdrawing.

prepareWithdrawTxData

Prepare transaction data to redeem vault shares for tokens.

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
`prepareApproveWithdrawTxData`	Prepare withdrawal approval transaction
`prepareWithdrawTxData`	Prepare withdrawal execution transaction

Type Guards

The SDK exports type guards for handling discriminated union results:

import {
  isPermitAuth,
  isApprovalAuth,
  isAlreadyApprovedAuth,
} 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
}

See DepositAuthMethod for full type documentation.

⌘I

Getting started

Origin - Branded Stablecoins

Amplify - Stablecoin Earn

Access - Borrow

USDG0

Initialization

initAmplifySDK

fetchSupportedAssets

Deposits

Deposit Workflow

prepareDepositTxData

prepareDepositWithPermitTxData

Withdrawals

prepareApproveWithdrawTxData

prepareWithdrawTxData

Function Quick Reference

Type Guards

​Initialization

initAmplifySDK

fetchSupportedAssets

​Deposits

Deposit Workflow

prepareDepositTxData

prepareDepositWithPermitTxData

​Withdrawals

prepareApproveWithdrawTxData

prepareWithdrawTxData

​Function Quick Reference

​Type Guards

Initialization

Deposits

Withdrawals

Function Quick Reference

Type Guards