YieldType enum represents different yield strategies available in the Amplify protocol.
Import
Definition
Values
Usage
Selecting a Yield Type
Related
- getSupportedAssets - Get assets for a yield type
- Deposit Workflow - Use yield types in deposits
Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Yield strategy enum for vault selection
YieldType enum represents different yield strategies available in the Amplify protocol.
import { YieldType } from '@paxoslabs/amplify-sdk'
export const YieldType = {
CORE: 'CORE',
TREASURY: 'TREASURY',
FRONTIER: 'FRONTIER',
} as const
export type YieldType = (typeof YieldType)[keyof typeof YieldType]
| Value | String | Description |
|---|---|---|
YieldType.CORE | "CORE" | Standard yield strategy with balanced risk/reward |
YieldType.TREASURY | "TREASURY" | Treasury-backed strategy with lower risk |
YieldType.FRONTIER | "FRONTIER" | Higher-risk strategy with potentially higher rewards |
import { YieldType, getSupportedAssets } from '@paxoslabs/amplify-sdk'
// Fetch assets for a specific yield type
const coreAssets = await getSupportedAssets({
yieldType: YieldType.CORE,
})
// Use in deposit parameters
const params = {
yieldType: YieldType.CORE,
depositAsset: '0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48',
depositAmount: '1000',
to: userAddress,
chainId: 1,
}
| Yield Type | Risk Level | Target APY | Best For |
|---|---|---|---|
TREASURY | Low | 3-4% | Conservative users, treasury management |
CORE | Medium | 5-7% | Most users, balanced approach |
FRONTIER | Higher | 8-12% | Risk-tolerant users seeking higher yields |