Changelog

​

Terminology Change

​

New Features

• Supply cap awareness — The SDK now reads and enforces account deposit supply caps on-chain. Deposits that would exceed the account’s supplyCapInBase (read from the DistributorCodeDepositor contract) are rejected with a descriptive APIError before submitting a transaction. The cached AmplifyVault type exposes a new depositCap?: VaultDepositCap field with supplyCapInBase and hasDepositCap.
• getDepositCap() — New display helper that reads the supply cap and fee module address from the DCD contract on-chain. Returns supplyCapInBase, hasDepositCap, depositFeeModuleAddress, and hasFees.
• getCurrentSupply() — New display helper that reads the current total account supply from the BoringVault and Accountant contracts. Returns totalShareSupply, exchangeRate, accountantDecimals, and totalValueInBase for comparing against the supply cap.
• calculateDepositFee() — New display helper that reads deposit fee parameters from the on-chain fee module. Returns a full fee breakdown: feePercentage, flatFee, variableFeeAmount, totalFeeAmount, depositAmountAfterFees, and assetDecimals.
• getShareValue() — New display helper that calculates the value of account shares in a quote asset using the on-chain getRateInQuote exchange rate. Accepts either a userAddress (reads balanceOf on-chain) or an explicit shareAmount.
• Deposit fee data on accounts — AmplifyVault.depositFees?: VaultDepositFees carries per-asset fee data from the indexer, enriched with defaults when the fee module is configured but indexer data is missing. Includes hasFees, feeModuleAddress, and per-asset feePercentage/flatFee.
• Withdraw fee data on accounts — AmplifyVault.withdrawFees?: VaultWithdrawFees carries withdraw queue fee metadata from the indexer. Includes hasFees, feeModuleAddress, offerFeeBps, and offerFeeRate.
• Account enrichment — getVaults() now automatically enriches accounts with on-chain supply caps and default fee structures during cache population. Supply cap reads only run for accounts with both a communityCodeDepositorAddress and depositFeeModuleAddress.

​

Improvements

• VaultContracts expanded — Added depositFeeModuleAddress and withdrawFeeModuleAddress fields to the account contracts interface.
• Deposit cap enforcement — prepareDepositTxData() and prepareDepositWithPermitTxData() now validate deposits against the supply cap before building the transaction, comparing the deposit amount (converted to base units via accountant rate) against remaining capacity.

​

Migration from v0.5.2

import {
  getDepositCap,
  getCurrentSupply,
  calculateDepositFee,
  getShareValue,
} from '@paxoslabs/amplify-sdk'

​

Direct Contract Integration — KYT Accounts

• KYT-only deposit documentation — The Direct Contract deposits guide now documents the DistributorCodeDepositorV1 (KYT) contract exclusively. Both deposit() and depositWithPermit() include the required _attestation tuple parameter with empty/zero default values. Contact the Paxos Labs team to implement a compliance policy.
• KYT callout on Direct Contract overview — Added a warning banner to the Direct Contract overview page about the KYT account requirement.

​

Documentation Fixes

• Permit deposit txData shape corrected — Code examples in the Deposit Workflow, Deposits Guide (Privy, Wagmi, and Viem tabs), and Quickstart now use the flat txData structure (txData.abi, txData.functionName, txData.args) introduced in v0.5.2. Previously these examples incorrectly referenced the pre-v0.5.2 nested shape (txData.data.abi).
• BigInt serialization fix for Privy permit signing — Replaced JSON.stringify(auth.permitData) with the SDK’s toEthSignTypedDataV4() helper in the Deposits Guide (Privy tab) and Quickstart. JSON.stringify throws a TypeError on BigInt values in permitData.message.
• getRateInQuoteSafe ABI corrected — The Accountant ABI in the Direct Contract Deposits and Withdrawals guides now includes the required quote: address input parameter. The previous ABI had an empty inputs array, which would produce the wrong function selector on-chain.
• VaultContracts field name corrected — Renamed distributorCodeDepositorAddress to communityCodeDepositorAddress in the Types reference to match the SDK’s actual VaultContracts interface.
• AmplifyVault type updated — Added missing inDeprecation: boolean and enterpriseConfig?: EnterpriseConfig fields to the AmplifyVault interface in the Types reference, getVaultsByConfig, findVaultByConfig, and AI Reference docs.
• getWithdrawalFee() parameters corrected — Fixed parameter names (withdrawAssetAddress → assetAddress, withdrawAmount → amount) and added missing required parameters (offerAsset, wantAsset, receiver) in the AI Reference. Return type corrected from string to bigint.
• getMinimumWithdrawalOrderSize() parameter corrected — Fixed parameter name (withdrawAssetAddress → assetAddress) in the AI Reference. Return type corrected from string to bigint with additional shareDecimals: number field.

​

New Features

• KYT deposit routing — Deposits automatically route to the KYT-enabled DistributorCodeDepositorV1 contract when an account has enterpriseConfig.predicatePolicyId set. The SDK returns a discriminated union (StandardDepositTxData | KytDepositTxData) with a depositType field so consumers can distinguish between standard and KYT deposits. Type guards isKytDeposit() and isStandardDeposit() are exported for narrowing.
• Account deprecation warnings — Accounts with inDeprecation: true now trigger a warning via the SDK logger when prepareDepositTxData() or prepareDepositWithPermitTxData() is called. The AmplifyVault type exposes the new inDeprecation: boolean field.
• Enterprise config on accounts — AmplifyVault.enterpriseConfig carries predicatePolicyId from the GraphQL schema, enabling client-side KYT policy awareness.

​

Improvements

• Flattened permit deposit return — prepareDepositWithPermitTxData() now returns a flat object ({ depositType, abi, address, functionName, args, chainId }) matching the shape of prepareDepositTxData(). Previously the ABI and args were nested under a .data property. This makes both functions directly spreadable into viem’s writeContract.

​

Migration from v0.5.1

// Before (v0.5.1)
await writeContract({
  address: txData.address,
  abi: txData.data.abi,
  functionName: txData.data.functionName,
  args: txData.data.args,
})

// After (v0.5.2)
await writeContract({
  address: txData.address,
  abi: txData.abi,
  functionName: txData.functionName,
  args: txData.args,
})

​

New Features

• Base mainnet — Base (chainId 8453) is included in the SDK’s built-in chain map, so getVaultsByConfig(), deposit and withdrawal preparation, and on-chain reads resolve a proper viem Chain for Base without extra configuration. Pass chainId: 8453 anywhere you already pass Ethereum or HyperEVM IDs.
• Cross-chain chain resolution — When the wallet’s chain differs from the account’s chain (for example, multi-chain or bridged-asset flows), chain utilities can resolve the correct built-in chain config for the user’s chainId as well as the account’s.

​

Breaking Changes

​

New Features

• getVaults() — Renamed from fetchVaults(). Same cache-first behavior, new name for consistency.
• getSupportedAssets() — Renamed from fetchSupportedAssets(). Same cache-first behavior, new name for consistency.
• getVaultsByConfig() — Multi-filter account discovery. Filter by yieldType, chainId, depositAssetAddress, withdrawAssetAddress, and settlementAssetAddress.
• getWithdrawSupportedAssets() — Fetch all supported withdrawal assets grouped by token with their available accounts.
• vaultName parameter on display helpers — getVaultAPY, getVaultTVL, and getWithdrawalRequests now accept vaultName as an alternative to vaultAddress.
• Cache management — Fully documented: initializeCache(), getCache(), refreshVaultCache(), isCacheReady(), waitForCacheReady().

​

Migration Guide

​

Why this change?

// 1. Discover (once, at app startup or on chain/asset change)
const [vault] = await getVaultsByConfig({
  yieldType: YieldType.CORE,
  chainId: 1,
  depositAssetAddress: USDC,
})

// 2. Transact (using the vault's name)
await prepareDeposit({
  vaultName: vault.name,
  depositAsset: USDC,
  depositAmount: '1000',
  to: userAddress,
  chainId: 1,
})

import { getVaultsByConfig, YieldType } from '@paxoslabs/amplify-sdk'

// Before — no discovery step needed
// After  — discover the vault first
const [vault] = await getVaultsByConfig({
  yieldType: YieldType.CORE,
  chainId: 1,
  depositAssetAddress: '0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48',
})

// vault.name is used in all subsequent calls

// Before (v0.4.2)
await prepareDepositTxData({
  yieldType: YieldType.CORE,
  depositAsset: '0x...',
  depositAmount: '1000',
  to: userAddress,
  chainId: 1,
})

// After (v0.5.0)
await prepareDepositTxData({
  vaultName: vault.name,
  depositAsset: '0x...',
  depositAmount: '1000',
  to: userAddress,
  chainId: 1,
})

// Before (v0.4.2)
await prepareWithdrawalAuthorization({
  yieldType: 'CORE',
  wantAsset: USDC,
  withdrawAmount: '1.0',
  userAddress,
  chainId: 1,
})

// After (v0.5.0)
const [vault] = await getVaultsByConfig({ yieldType: 'CORE', chainId: 1 })

await prepareWithdrawalAuthorization({
  vaultName: vault.name,
  wantAsset: USDC,
  withdrawAmount: '1.0',
  userAddress,
  chainId: 1,
})

// Before (v0.4.2)
const result = await getMinimumMint({
  yieldType: YieldType.CORE,
  chainId: 1,
  depositAssetAddress: USDC,
  depositAmount: '1000.0',
})

// After (v0.5.0)
const [vault] = await getVaultsByConfig({
  yieldType: YieldType.CORE,
  chainId: 1,
})

const result = await getMinimumMint({
  vaultName: vault.name,
  chainId: 1,
  depositAssetAddress: USDC,
  depositAmount: '1000.0',
})

// New — use vaultName instead of looking up vaultAddress manually
const apy = await getVaultAPY({ vaultName: vault.name })
const tvl = await getVaultTVL({ vaultName: vault.name, chainId: 1 })

// Before (v0.4.2)
interface DepositParams {
  amount: string
  depositAsset: `0x${string}`
  yieldType: YieldType
}

const params = {
  yieldType,
  depositAsset,
  depositAmount: amount,
  to: address,
  chainId,
}

// After (v0.5.0)
interface DepositParams {
  amount: string
  depositAsset: `0x${string}`
  vaultName: string
}

const params = {
  vaultName,
  depositAsset,
  depositAmount: amount,
  to: address,
  chainId,
}

# Find all yieldType usages in SDK calls
rg "yieldType.*YieldType\." --type ts
rg "yieldType.*['\"]CORE['\"]" --type ts

# Find all affected function calls
rg "prepare(Deposit|Withdrawal|WithdrawOrder|ApproveWithdraw|CancelWithdrawOrder)" --type ts
rg "get(MinimumMint|WithdrawalFee|MinimumWithdrawalOrderSize)" --type ts

​

Breaking Changes

• Withdrawal flow migrated from AtomicQueue to WithdrawQueue.
• Renamed withdrawal APIs:
  • prepareWithdrawTransactionData() -> prepareWithdrawOrderTxData()
  • prepareApproveWithdrawToken() -> prepareApproveWithdrawOrderTxData()
• Added prepareCancelWithdrawOrderTxData() for order cancellation.
• Withdrawal slippage parameters removed from the new flow.

​

Highlights

• Added unified prepareWithdrawal() wrapper for withdrawal execution.
• Added unified prepareWithdrawalAuthorization() wrapper.
• Added smart-wallet detection for deposit/withdraw authorization routing.
• Added forceMethod parameter for explicit authorization routing.

​

Breaking Changes

// Before (v0.2.x)
await prepareDepositTxData({
  depositToken: "0x...",
  recipientAddress: "0x...",
  // ...
});

// After (v0.3.0)
await prepareDepositTxData({
depositAsset: "0x...",
to: "0x...",
// ...
});

// Before (v0.2.x)
import { YieldType } from "@paxoslabs/amplify-sdk";
YieldType.PRIME;
YieldType.TBILL;
YieldType.LENDING;

// After (v0.3.0)
import { YieldType } from "@paxoslabs/amplify-sdk";
YieldType.CORE;
YieldType.TREASURY;
YieldType.FRONTIER;

​

Features

• Improved TypeScript inference for deposit functions
• Added eth_signTypedData_v4 helper for better wallet compatibility

​

Bug Fixes

• Fixed instanceof checks for APIError and WithdrawError in transpiled code

​

Refactoring

• Standardized parameter naming across deposit APIs to match contract terminology
• Removed deprecated display module and bridge functionality
• Added explicit exports for tree-shaking optimization