Types

All TypeScript types exported from @yo-protocol/core.

Client Config

interface YoClientConfig {
  chainId: SupportedChainId  // 1 | 8453
  publicClient?: PublicClient
  walletClient?: WalletClient
  partnerId?: number          // Gateway partner attribution ID (default: 0)
}

Vault Types

interface VaultState {
  address: Address
  name: string
  symbol: string
  decimals: number
  totalAssets: bigint
  totalSupply: bigint
  asset: Address
  assetDecimals: number
  exchangeRate: bigint
}

interface VaultConfig {
  address: Address
  name: string
  symbol: VaultId
  underlying: {
    symbol: string
    decimals: number
    address: Record<number, Address>
  }
  chains: readonly number[]
}

type VaultId = 'yoETH' | 'yoBTC' | 'yoUSD' | 'yoEUR' | 'yoGOLD' | 'yoUSDT'

User Types

interface UserVaultPosition {
  shares: bigint
  assets: bigint
}

interface TokenBalance {
  token: Address
  balance: bigint
  decimals: number
}

interface TokenAllowance {
  token: Address
  owner: Address
  spender: Address
  allowance: bigint
}

Action Results

interface DepositResult {
  hash: Hash
  shares: bigint
}

interface RedeemResult {
  hash: Hash
  assets: bigint
}

interface ApproveResult {
  hash: Hash
}

interface DepositWithApprovalResult {
  approveHash?: Hash    // undefined if approval wasn't needed
  depositHash: Hash
  shares: bigint
}

interface RedeemReceipt {
  hash: Hash
  status: 'success' | 'reverted'
  instant: boolean               // true if redeemed instantly
  assetsOrRequestId: bigint      // assets returned or pending request ID
  shares: bigint
  blockNumber: bigint
}

interface TransactionReceipt {
  hash: Hash
  status: 'success' | 'reverted'
  blockNumber: bigint
  gasUsed: bigint
}

interface PreparedTransaction {
  to: Address
  data: Hex
  value: bigint
}

Action Params

interface DepositParams {
  vault: Address
  amount: bigint
  recipient?: Address
  minShares?: bigint
}

interface RedeemParams {
  vault: Address
  shares: bigint
  recipient?: Address
  minAssetsOut?: bigint
  slippageBps?: number
}

API Types

type Network = 'base' | 'ethereum' | 'unichain' | 'arbitrum' | 'tac' | 'plasma' | 'hyperevm'

interface FormattedValue {
  raw: number | string
  formatted: string
}

interface VaultSnapshot {
  address: string
  name: string
  symbol: string
  tvl: FormattedValue
  apy: number
  underlying: { address: string; symbol: string; decimals: number }
  pools?: { name: string; allocation: number; apy: number }[]
}

interface TimeseriesPoint {
  timestamp: number
  value: number
}

interface UserHistoryItem {
  type: 'deposit' | 'withdraw' | 'redeem'
  timestamp: number
  assets: FormattedValue
  shares: FormattedValue
  txHash: string
}

interface UserPoints {
  totalPoints: number
  rank?: number
  activities?: { type: string; points: number; timestamp: number }[]
}

interface PendingRedeem {
  assets?: FormattedValue
  shares?: FormattedValue
}