Hyperion Docs
  • Home
  • Overview
    • Introduction
    • Contact
    • Glossary
    • Roadmap
  • Concepts
    • Concentrated Liquidity
    • Fees
    • Swap
    • Liquidity Mining
    • Range Order
    • Drips
  • Guides
    • FAQ
    • How to Swap
    • How to Create New Position
    • How to Add/Remove Liquidity
    • How to Create a New Pool
    • How to Place a Limit Order
  • Developer
    • Dev Overview
    • via SDK
      • Getting Started
      • Prerequisites
      • Features Available
        • Get pools
        • Get positions
        • Get ticks
        • Create pool
        • Add Liquidity
        • Remove Liquidity
        • Fee & Rewards
        • Swap
        • Types
    • via Contract
      • Get Started
      • Data structure
      • Features available
        • Create pool
        • Swap
        • Open position
        • Add liquidity
        • Remove liquidity
        • Collect fees
        • Collect rewards
    • via API
    • Contract ErrorCode
  • Security
    • Audits
  • Resource
    • Brand Asset
Powered by GitBook
On this page
  • Pools Item
  • Pool
  • TokenInfo
  • Fee & Subsidy
  1. Developer
  2. via SDK
  3. Features Available

Types

Pools Item

interface PoolItem {
  id: string;
  aprUSD: string;
  dailyVolumeUSD: string;
  feesUSD: string;
  tvlUSD: string;
  pool: Pool;
}

Pool


interface Pool {
  currentTick: number;
  feeRate: string;
  feeTier: number;
  poolId: string;
  senderAddress: string;
  sqrtPrice: string;
  token1: string;
  token2: string;
  token1Info: TokenInfo;
  token2Info: TokenInfo;
}

TokenInfo

interface TokenInfo {
  assetType: string;
  bridge: string | null;
  coinMarketcapId: string;
  coinType: string;
  coingeckoId: string;
  decimals: number;
  faType: string;
  hyperfluidSymbol: string;
  logoUrl: string;
  name: string;
  symbol: string;
  isBanned: boolean;
  websiteUrl: string | null;
}

Fee & Subsidy

interface Subsidy {
    claimed: Array<{
        amount: string;
        amountUSD: string;
        token: string;
    }>;
    unclaimed: Array<{
        amount: string;
        amountUSD: string;
        token: string;
    }>;
}

interface Fee {
    claimed: Array<{
        amount: string;
        amountUSD: string;
        token: string;
    }>;
    unclaimed: Array<{
        amount: string;
        amountUSD: string;
        token: string;
    }>;
}

PreviousSwapNextvia Contract

Last updated 4 months ago