Skip to main content
The display module provides helper functions for building UI components that show vault data. Import them from the /display subpath or the main package.

​
Import

import {
  getMinimumMint,
  getVaultAPY,
  getVaultTVL,
  getWithdrawalFee,
  getWithdrawalRequests,
  getMinimumWithdrawalOrderSize,
} from '@paxoslabs/amplify-sdk'

// Or from the display subpath for tree-shaking
import { getVaultAPY } from '@paxoslabs/amplify-sdk/display'

​
Functions

getVaultsByConfig

Discover vaults by yield type, chain, and asset. Returns vault.name for use in transaction functions.

findVaultByConfig

Find a single vault by asset, yield type, and chain.

getMinimumMint

Calculate expected vault shares for a deposit amount.

getVaultAPY

Fetch the latest APY for a vault.

getVaultTVL

Fetch total value locked for a vault.

getWithdrawalFee

Calculate withdrawal fees from the on-chain FeeModule.

getWithdrawalRequests

Fetch a user’s withdrawal request history.

getMinimumWithdrawalOrderSize

Get the minimum withdrawal order size for a vault.

​
Quick Reference

FunctionData SourceReturns
getVaultsByConfigCacheArray of vaults matching yield type, chain, and asset
findVaultByConfigCacheSingle vault for a given asset, yield type, and chain
getMinimumMintOn-chain (Accountant contract)Expected shares, exchange rate, decimals
getVaultAPYBackend APIAPY value and formatted string
getVaultTVLBackend APITVL value and asset denomination
getWithdrawalFeeOn-chain (FeeModule contract)Fee amount and percentage
getWithdrawalRequestsBackend APIPaginated withdrawal requests
getMinimumWithdrawalOrderSizeOn-chain (WithdrawQueue contract)Minimum order size in shares