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

​
Import

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

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

​
Functions

getVaultsByConfig

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

findVaultByConfig

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

getMinimumMint

Calculate expected account shares for a deposit amount.

getDepositCap

Read the deposit supply cap from the on-chain DCD contract.

getCurrentSupply

Read current account total supply in base-asset units.

calculateDepositFee

Calculate deposit fees (variable + flat) from the on-chain fee module.

getShareValue

Calculate the value of account shares in a quote asset.

getVaultAPY

Fetch the latest APY for an account.

getVaultTVL

Fetch total value locked for an account.

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 an account.

​
Quick Reference

FunctionData SourceReturns
getVaultsByConfigCacheArray of accounts matching yield type, chain, and asset
findVaultByConfigCacheSingle account for a given asset, yield type, and chain
getMinimumMintOn-chain (Accountant contract)Expected shares, exchange rate, decimals
getDepositCapOn-chain (DCD contract)Supply cap, fee module address, boolean flags
getCurrentSupplyOn-chain (Account + Accountant)Total share supply, exchange rate, value in base units
calculateDepositFeeOn-chain (Fee module)Variable fee, flat fee, total fee, net amount after fees
getShareValueOn-chain (Accountant contract)Share balance, value in quote asset, exchange rate
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