Display Helpers

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,
  calculateDepositFee,
} 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.

calculateDepositFee

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

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

Function	Data Source	Returns
`getVaultsByConfig`	Cache	Array of accounts matching yield type, chain, and asset
`findVaultByConfig`	Cache	Single account for a given asset, yield type, and chain
`getMinimumMint`	On-chain (Accountant contract)	Expected shares, exchange rate, decimals
`getDepositCap`	On-chain (DCD contract)	Supply cap, fee module address, boolean flags
`calculateDepositFee`	On-chain (Fee module)	Variable fee, flat fee, total fee, net amount after fees
`getVaultAPY`	Backend API	APY value and formatted string
`getVaultTVL`	Backend API	TVL value and asset denomination
`getWithdrawalFee`	On-chain (FeeModule contract)	Fee amount and percentage
`getWithdrawalRequests`	Backend API	Paginated withdrawal requests
`getMinimumWithdrawalOrderSize`	On-chain (WithdrawQueue contract)	Minimum order size in shares

Getting started

Amplify

USDG0

Import

Functions

getVaultsByConfig

findVaultByConfig

getMinimumMint

getDepositCap

calculateDepositFee

getVaultAPY

getVaultTVL

getWithdrawalFee

getWithdrawalRequests

getMinimumWithdrawalOrderSize

Quick Reference

​Import

​Functions

getVaultsByConfig

findVaultByConfig

getMinimumMint

getDepositCap

calculateDepositFee

getVaultAPY

getVaultTVL

getWithdrawalFee

getWithdrawalRequests

getMinimumWithdrawalOrderSize

​Quick Reference

Import

Functions

Quick Reference