four-flap-meme-sdk 1.5.55 → 1.5.56

package/dist/sol/dex/jup/portfolio.d.ts

@@ -0,0 +1,362 @@
+/**
+ * Jupiter Portfolio API V1
+ * @module sol/dex/jup/portfolio
+ *
+ * Portfolio API 提供钱包投资组合/持仓查询
+ * 包括各平台的 DeFi 头寸、代币持仓等
+ */
+import type { JupiterConfig } from './types.js';
+/** Fetcher 报告 */
+export interface FetcherReport {
+    /** Fetcher ID */
+    id: string;
+    /** 状态 */
+    status: string;
+    /** 耗时 (ms) */
+    duration: number;
+}
+/** 投资组合元素 */
+export interface PortfolioElement {
+    /** 类型 */
+    type: string;
+    /** 数据 */
+    data: Record<string, unknown>;
+    /** 标签 */
+    label: string;
+    /** 网络 ID */
+    networkId: string;
+    /** 平台 ID */
+    platformId: string;
+    /** 价值 (USD) */
+    value: number;
+    /** Fetcher ID */
+    fetcherId: string;
+}
+/** 投资组合响应 */
+export interface PortfolioResponse {
+    /** 查询时间戳 */
+    date: number;
+    /** 钱包地址 */
+    owner: string;
+    /** Fetcher 报告列表 */
+    fetcherReports: FetcherReport[];
+    /** 投资组合元素列表 */
+    elements: PortfolioElement[];
+    /** 查询耗时 (ms) */
+    duration: number;
+    /** 代币信息 */
+    tokenInfo: Record<string, unknown>;
+}
+/** 获取投资组合参数 */
+export interface GetPortfolioParams {
+    /** 钱包地址 */
+    address: string;
+    /** 平台 ID 列表（可选，逗号分隔） */
+    platforms?: string;
+}
+/** 解锁中的 JUP */
+export interface UnstakingJup {
+    /** 数量 */
+    amount: number;
+    /** 解锁时间 (Unix 时间戳) */
+    until: number;
+}
+/** JUP 质押信息 */
+export interface StakedJupInfo {
+    /** 已质押数量 */
+    stakedAmount: number;
+    /** 解锁中的列表 */
+    unstaking: UnstakingJup[];
+}
+/** 平台链接 */
+export interface PlatformLinks {
+    /** 官网 */
+    website?: string;
+    /** Discord */
+    discord?: string;
+    /** Telegram */
+    telegram?: string;
+    /** Twitter */
+    twitter?: string;
+    /** GitHub */
+    github?: string;
+    /** Medium */
+    medium?: string;
+    /** 文档 */
+    documentation?: string;
+}
+/** 平台信息 */
+export interface PlatformInfo {
+    /** 平台 ID */
+    id: string;
+    /** 名称 */
+    name: string;
+    /** 图标 URL */
+    image: string;
+    /** 描述 */
+    description: string;
+    /** DefiLlama ID */
+    defiLlamaId: string;
+    /** 是否已弃用 */
+    isDeprecated: boolean;
+    /** 代币列表 */
+    tokens: string[];
+    /** 标签列表 */
+    tags: string[];
+    /** 链接 */
+    links: PlatformLinks;
+}
+/**
+ * 获取钱包投资组合 (V1)
+ *
+ * 查询钱包在各 DeFi 平台的持仓情况。
+ *
+ * @param params 查询参数
+ * @param config Jupiter 配置
+ * @returns 投资组合响应
+ *
+ * @example
+ * ```typescript
+ * import { Sol } from 'four-flap-meme-sdk'
+ *
+ * Sol.setJupiterConfig({ apiKey: 'your-api-key' })
+ *
+ * // 获取钱包投资组合
+ * const portfolio = await Sol.getPortfolio({
+ *   address: 'YourWalletAddress...',
+ * })
+ *
+ * console.log(`钱包: ${portfolio.owner}`)
+ * console.log(`查询时间: ${new Date(portfolio.date * 1000)}`)
+ * console.log(`耗时: ${portfolio.duration}ms`)
+ *
+ * // 遍历投资组合元素
+ * portfolio.elements.forEach(element => {
+ *   console.log(`[${element.platformId}] ${element.label}`)
+ *   console.log(`  类型: ${element.type}`)
+ *   console.log(`  价值: $${element.value}`)
+ * })
+ *
+ * // 按平台筛选
+ * const raydiumOnly = await Sol.getPortfolio({
+ *   address: 'YourWalletAddress...',
+ *   platforms: 'raydium',
+ * })
+ * ```
+ */
+export declare function getPortfolio(params: GetPortfolioParams, config?: JupiterConfig): Promise<PortfolioResponse>;
+/**
+ * 获取钱包投资组合（简化版）
+ *
+ * @param address 钱包地址
+ * @param platforms 平台 ID 数组（可选）
+ * @param config Jupiter 配置
+ * @returns 投资组合响应
+ */
+export declare function getWalletPortfolio(address: string, platforms?: string[], config?: JupiterConfig): Promise<PortfolioResponse>;
+/**
+ * 获取 JUP 质押信息
+ *
+ * @param address 钱包地址
+ * @param config Jupiter 配置
+ * @returns JUP 质押信息
+ *
+ * @example
+ * ```typescript
+ * import { Sol } from 'four-flap-meme-sdk'
+ *
+ * Sol.setJupiterConfig({ apiKey: 'your-api-key' })
+ *
+ * const staked = await Sol.getStakedJup('YourWalletAddress...')
+ *
+ * console.log(`已质押: ${staked.stakedAmount} JUP`)
+ *
+ * if (staked.unstaking.length > 0) {
+ *   console.log('解锁中:')
+ *   staked.unstaking.forEach(u => {
+ *     const unlockDate = new Date(u.until * 1000)
+ *     console.log(`  ${u.amount} JUP - ${unlockDate.toLocaleString()}`)
+ *   })
+ * }
+ * ```
+ */
+export declare function getStakedJup(address: string, config?: JupiterConfig): Promise<StakedJupInfo>;
+/**
+ * 获取 JUP 质押总量
+ *
+ * @param address 钱包地址
+ * @param config Jupiter 配置
+ * @returns 已质押的 JUP 数量
+ */
+export declare function getStakedJupAmount(address: string, config?: JupiterConfig): Promise<number>;
+/**
+ * 获取解锁中的 JUP 总量
+ *
+ * @param address 钱包地址
+ * @param config Jupiter 配置
+ * @returns 解锁中的 JUP 总量
+ */
+export declare function getUnstakingJupAmount(address: string, config?: JupiterConfig): Promise<number>;
+/**
+ * 检查是否有即将解锁的 JUP
+ *
+ * @param address 钱包地址
+ * @param withinHours 在多少小时内（默认 24）
+ * @param config Jupiter 配置
+ * @returns 即将解锁的列表
+ */
+export declare function getUpcomingUnlocks(address: string, withinHours?: number, config?: JupiterConfig): Promise<UnstakingJup[]>;
+/**
+ * 获取所有平台列表
+ *
+ * @param config Jupiter 配置
+ * @returns 平台信息列表
+ *
+ * @example
+ * ```typescript
+ * import { Sol } from 'four-flap-meme-sdk'
+ *
+ * Sol.setJupiterConfig({ apiKey: 'your-api-key' })
+ *
+ * const platforms = await Sol.getPlatforms()
+ *
+ * platforms.forEach(p => {
+ *   console.log(`[${p.id}] ${p.name}`)
+ *   console.log(`  ${p.description}`)
+ *   console.log(`  标签: ${p.tags.join(', ')}`)
+ *   if (p.links.website) {
+ *     console.log(`  网站: ${p.links.website}`)
+ *   }
+ * })
+ * ```
+ */
+export declare function getPlatforms(config?: JupiterConfig): Promise<PlatformInfo[]>;
+/**
+ * 获取平台 ID 列表
+ *
+ * @param config Jupiter 配置
+ * @returns 平台 ID 数组
+ */
+export declare function getPlatformIds(config?: JupiterConfig): Promise<string[]>;
+/**
+ * 获取活跃平台列表（非弃用）
+ *
+ * @param config Jupiter 配置
+ * @returns 活跃平台列表
+ */
+export declare function getActivePlatforms(config?: JupiterConfig): Promise<PlatformInfo[]>;
+/**
+ * 按标签筛选平台
+ *
+ * @param tag 标签
+ * @param config Jupiter 配置
+ * @returns 匹配的平台列表
+ */
+export declare function getPlatformsByTag(tag: string, config?: JupiterConfig): Promise<PlatformInfo[]>;
+/**
+ * 搜索平台
+ *
+ * @param keyword 关键词（搜索名称和描述）
+ * @param config Jupiter 配置
+ * @returns 匹配的平台列表
+ */
+export declare function searchPlatforms(keyword: string, config?: JupiterConfig): Promise<PlatformInfo[]>;
+/**
+ * 获取平台详情
+ *
+ * @param platformId 平台 ID
+ * @param config Jupiter 配置
+ * @returns 平台信息或 null
+ */
+export declare function getPlatformById(platformId: string, config?: JupiterConfig): Promise<PlatformInfo | null>;
+/**
+ * 获取投资组合总价值
+ *
+ * @param address 钱包地址
+ * @param config Jupiter 配置
+ * @returns 总价值 (USD)
+ */
+export declare function getPortfolioTotalValue(address: string, config?: JupiterConfig): Promise<number>;
+/**
+ * 获取按平台分组的投资组合
+ *
+ * @param address 钱包地址
+ * @param config Jupiter 配置
+ * @returns 平台 -> 元素列表 映射
+ */
+export declare function getPortfolioByPlatform(address: string, config?: JupiterConfig): Promise<Map<string, PortfolioElement[]>>;
+/**
+ * 获取按类型分组的投资组合
+ *
+ * @param address 钱包地址
+ * @param config Jupiter 配置
+ * @returns 类型 -> 元素列表 映射
+ */
+export declare function getPortfolioByType(address: string, config?: JupiterConfig): Promise<Map<string, PortfolioElement[]>>;
+/**
+ * 获取平台价值汇总
+ *
+ * @param address 钱包地址
+ * @param config Jupiter 配置
+ * @returns 平台 -> 总价值 映射
+ */
+export declare function getPlatformValueSummary(address: string, config?: JupiterConfig): Promise<Map<string, number>>;
+/**
+ * 获取投资组合摘要
+ *
+ * @param address 钱包地址
+ * @param config Jupiter 配置
+ * @returns 投资组合摘要
+ */
+export declare function getPortfolioSummary(address: string, config?: JupiterConfig): Promise<{
+    owner: string;
+    totalValue: number;
+    platformCount: number;
+    elementCount: number;
+    platforms: Array<{
+        id: string;
+        value: number;
+        count: number;
+    }>;
+    fetchDuration: number;
+}>;
+/**
+ * 筛选特定平台的元素
+ *
+ * @param elements 元素列表
+ * @param platformId 平台 ID
+ * @returns 筛选后的元素
+ */
+export declare function filterByPlatform(elements: PortfolioElement[], platformId: string): PortfolioElement[];
+/**
+ * 筛选特定类型的元素
+ *
+ * @param elements 元素列表
+ * @param type 类型
+ * @returns 筛选后的元素
+ */
+export declare function filterByType(elements: PortfolioElement[], type: string): PortfolioElement[];
+/**
+ * 筛选价值大于阈值的元素
+ *
+ * @param elements 元素列表
+ * @param minValue 最小价值 (USD)
+ * @returns 筛选后的元素
+ */
+export declare function filterByMinValue(elements: PortfolioElement[], minValue: number): PortfolioElement[];
+/**
+ * 按价值排序元素
+ *
+ * @param elements 元素列表
+ * @param descending 是否降序（默认 true）
+ * @returns 排序后的元素
+ */
+export declare function sortByValue(elements: PortfolioElement[], descending?: boolean): PortfolioElement[];
+/**
+ * 获取前 N 个高价值元素
+ *
+ * @param elements 元素列表
+ * @param n 数量
+ * @returns 前 N 个元素
+ */
+export declare function getTopElements(elements: PortfolioElement[], n: number): PortfolioElement[];