Skip to main content
The YieldType enum represents different yield strategies available in the Amplify protocol.

​
Import

import { YieldType } from "@paxoslabs/amplify-sdk";

​
Definition

export const YieldType = {
  CORE: "CORE",
  TREASURY: "TREASURY",
  FRONTIER: "FRONTIER",
} as const;

export type YieldType = (typeof YieldType)[keyof typeof YieldType];

​
Values

ValueStringDescription
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

​
Usage

import { YieldType, fetchSupportedAssets } from "@paxoslabs/amplify-sdk";

// Fetch assets for a specific yield type
const coreAssets = await fetchSupportedAssets({
  yieldType: YieldType.CORE,
});

// Use in deposit parameters
const params = {
  yieldType: YieldType.CORE,
  depositAsset: "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
  depositAmount: "1000",
  to: userAddress,
  chainId: 1,
};

​
Selecting a Yield Type

Yield TypeRisk LevelTarget APYBest For
TREASURYLow3-4%Conservative users, treasury management
COREMedium5-7%Most users, balanced approach
FRONTIERHigher8-12%Risk-tolerant users seeking higher yields