four-flap-meme-sdk 1.5.55 → 1.5.56

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

@@ -0,0 +1,457 @@
+/**
+ * Jupiter Studio API V1
+ * @module sol/dex/jup/studio
+ *
+ * Studio API 提供在 Meteora DBC (Dynamic Bonding Curve) 上创建代币的功能
+ * 支持配置市值、费用、vesting 等参数
+ */
+import type { JupiterConfig } from './types.js';
+/** 图片类型 */
+export type TokenImageContentType = 'image/jpeg' | 'image/png' | 'image/gif' | 'image/webp';
+/** Quote 代币小数位 */
+export type TokenQuoteDecimal = 6 | 9;
+/** Vesting 期数 */
+export type VestingPeriod = 0 | 6 | 12 | 183 | 365;
+/** Vesting 持续时间（秒） */
+export type VestingDuration = 0 | 15552000 | 15811200 | 31536000;
+/** 费用基点 */
+export type FeeBps = 100 | 200;
+/** 费用持续时间（秒） */
+export type FeeDuration = 60 | 120 | 180 | 240 | 300;
+/** 费用模式 */
+export type FeeMode = 'linear' | 'exponential';
+/** 锁定 Vesting 参数 */
+export interface LockedVestingParam {
+    /** 总锁定 vesting 数量（0% 到 80% 的总供应量） */
+    totalLockedVestingAmount: number;
+    /** 悬崖解锁数量 */
+    cliffUnlockAmount: number;
+    /** Vesting 期数（天: 183/365，月: 6/12） */
+    numberOfVestingPeriod: VestingPeriod;
+    /** 总 vesting 持续时间（秒） */
+    totalVestingDuration: VestingDuration;
+    /** 从迁移时间开始的悬崖持续时间（秒） */
+    cliffDurationFromMigrationTime: VestingDuration;
+}
+/** 市值曲线参数 */
+export interface BuildCurveByMarketCapParam {
+    /**
+     * Quote 代币 Mint 地址
+     * 支持 USDC, SOL, 或 JUP
+     */
+    quoteMint: string;
+    /**
+     * 初始市值（quote 代币单位）
+     * 例如: 16000 表示 16000 USDC/SOL/JUP 的初始市值
+     */
+    initialMarketCap: number;
+    /**
+     * 迁移市值（quote 代币单位）
+     * 例如: 69000 表示 69000 USDC/SOL/JUP 的迁移市值
+     */
+    migrationMarketCap: number;
+    /** Quote 代币小数位 */
+    tokenQuoteDecimal: TokenQuoteDecimal;
+    /** 锁定 vesting 参数 */
+    lockedVestingParam: LockedVestingParam;
+}
+/** 费用配置 */
+export interface FeeConfig {
+    /** 费用基点（100 = 1%, 200 = 2%） */
+    feeBps: FeeBps;
+    /** 费用计划总持续时间（秒） */
+    totalDuration?: FeeDuration;
+    /** 费用模式 */
+    baseFeeMode?: FeeMode;
+}
+/** 创建 DBC 池参数 */
+export interface CreateDbcPoolParams {
+    /** 市值曲线参数 */
+    buildCurveByMarketCapParam: BuildCurveByMarketCapParam;
+    /** 是否启用防狙击保护 */
+    antiSniping: boolean;
+    /** 费用配置 */
+    fee: FeeConfig;
+    /** 代币名称 */
+    tokenName: string;
+    /** 代币符号 */
+    tokenSymbol: string;
+    /** 图片类型 */
+    tokenImageContentType: TokenImageContentType;
+    /** 创建者钱包公钥 */
+    creator: string;
+    /** 是否锁定 LP（默认 true） */
+    isLpLocked?: boolean;
+}
+/** 创建 DBC 池响应 */
+export interface CreateDbcPoolResponse {
+    /** Base64 编码的交易 */
+    transaction: string;
+    /** 生成的代币 Mint 地址 */
+    mint: string;
+    /** 图片上传预签名 URL（PUT 请求） */
+    imagePresignedUrl: string;
+    /** 元数据上传预签名 URL（PUT 请求） */
+    metadataPresignedUrl: string;
+    /** 最终图片 URL */
+    imageUrl: string;
+}
+/** 提交 DBC 池参数 */
+export interface SubmitDbcPoolParams {
+    /** Base64 编码的已签名交易 */
+    transaction: string;
+    /** 所有者钱包公钥 */
+    owner: string;
+    /** 可选：内容描述（显示在 Studio 代币页面） */
+    content?: string;
+    /** 可选：头图文件（显示在 Studio 代币页面） */
+    headerImage?: Blob | File;
+}
+/** 提交 DBC 池响应 */
+export interface SubmitDbcPoolResponse {
+    /** 是否成功 */
+    success: boolean;
+    /** 数据 */
+    data: {
+        /** 代币 Mint 地址 */
+        mint: string;
+        /** 配置 Key */
+        configKey: string;
+    };
+}
+/** 池地址响应 */
+export interface DbcPoolAddressesResponse {
+    /** 是否成功 */
+    success: boolean;
+    /** 数据 */
+    data: {
+        /** DAMM V2 池地址 */
+        dammv2PoolAddress: string | null;
+        /** DBC 池地址 */
+        dbcPoolAddress: string | null;
+        /** 配置 Key */
+        configKey: string | null;
+    };
+}
+/** 费用信息响应 */
+export interface DbcFeeResponse {
+    /** 未领取的创建者费用 */
+    unclaimed: string;
+    /** 总交易费用的一半（创建者份额） */
+    total: string;
+}
+/** 领取费用参数 */
+export interface ClaimDbcFeeParams {
+    /** 所有者钱包公钥 */
+    ownerWallet: string;
+    /** DBC 池地址 */
+    poolAddress: string;
+    /** 最大领取数量 */
+    maxQuoteAmount: number;
+}
+/** 领取费用响应 */
+export interface ClaimDbcFeeResponse {
+    /** Base64 编码的交易 */
+    transaction: string;
+}
+/** Quote 代币 Mint 地址 */
+export declare const QUOTE_MINTS: {
+    /** USDC */
+    readonly USDC: "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v";
+    /** SOL (Wrapped) */
+    readonly SOL: "So11111111111111111111111111111111111111112";
+    /** JUP */
+    readonly JUP: "JUPyiwrYJFskUPiHa7hkeR8VUtAeFoSYbKedZNsDvCN";
+};
+/** Vesting 持续时间常量 */
+export declare const VESTING_DURATIONS: {
+    /** 无 vesting */
+    readonly NONE: VestingDuration;
+    /** 6 个月 (180天) */
+    readonly SIX_MONTHS: VestingDuration;
+    /** 约 6 个月 (183天) */
+    readonly SIX_MONTHS_183: VestingDuration;
+    /** 1 年 (365天) */
+    readonly ONE_YEAR: VestingDuration;
+};
+/**
+ * 创建 DBC 池交易
+ *
+ * 在 Meteora DBC 上创建代币，支持配置市值、费用、vesting 等参数。
+ *
+ * @param params 创建参数
+ * @param config Jupiter 配置
+ * @returns 创建响应
+ *
+ * @example
+ * ```typescript
+ * import { Sol } from 'four-flap-meme-sdk'
+ *
+ * Sol.setJupiterConfig({ apiKey: 'your-api-key' })
+ *
+ * // 创建 DBC 池
+ * const result = await Sol.createDbcPoolTx({
+ *   buildCurveByMarketCapParam: {
+ *     quoteMint: Sol.QUOTE_MINTS.USDC,
+ *     initialMarketCap: 16000,      // 16k USDC 初始市值
+ *     migrationMarketCap: 69000,    // 69k USDC 迁移市值
+ *     tokenQuoteDecimal: 6,
+ *     lockedVestingParam: {
+ *       totalLockedVestingAmount: 0,
+ *       cliffUnlockAmount: 0,
+ *       numberOfVestingPeriod: 0,
+ *       totalVestingDuration: 0,
+ *       cliffDurationFromMigrationTime: 0,
+ *     },
+ *   },
+ *   antiSniping: true,
+ *   fee: { feeBps: 100 },
+ *   tokenName: 'My Token',
+ *   tokenSymbol: 'MTK',
+ *   tokenImageContentType: 'image/png',
+ *   creator: wallet.publicKey.toBase58(),
+ *   isLpLocked: true,
+ * })
+ *
+ * console.log(`代币 Mint: ${result.mint}`)
+ * console.log(`图片上传 URL: ${result.imagePresignedUrl}`)
+ * console.log(`元数据上传 URL: ${result.metadataPresignedUrl}`)
+ *
+ * // 1. 上传图片
+ * await fetch(result.imagePresignedUrl, {
+ *   method: 'PUT',
+ *   headers: { 'Content-Type': 'image/png' },
+ *   body: imageBuffer,
+ * })
+ *
+ * // 2. 上传元数据
+ * const metadata = {
+ *   name: 'My Token',
+ *   symbol: 'MTK',
+ *   description: 'Token description',
+ *   image: result.imageUrl,
+ * }
+ * await fetch(result.metadataPresignedUrl, {
+ *   method: 'PUT',
+ *   headers: { 'Content-Type': 'application/json' },
+ *   body: JSON.stringify(metadata),
+ * })
+ *
+ * // 3. 签名并发送交易
+ * const tx = VersionedTransaction.deserialize(Buffer.from(result.transaction, 'base64'))
+ * tx.sign([wallet])
+ * // 发送交易...
+ * ```
+ */
+export declare function createDbcPoolTx(params: CreateDbcPoolParams, config?: JupiterConfig): Promise<CreateDbcPoolResponse>;
+/**
+ * 创建简单 DBC 池
+ *
+ * 使用简化参数创建 DBC 池。
+ *
+ * @param name 代币名称
+ * @param symbol 代币符号
+ * @param creator 创建者地址
+ * @param options 可选参数
+ * @param config Jupiter 配置
+ * @returns 创建响应
+ *
+ * @example
+ * ```typescript
+ * // 使用 USDC 作为 quote，默认参数创建
+ * const result = await Sol.createSimpleDbcPool(
+ *   'My Token',
+ *   'MTK',
+ *   wallet.publicKey.toBase58(),
+ *   {
+ *     quoteMint: 'usdc',
+ *     initialMarketCap: 16000,
+ *     migrationMarketCap: 69000,
+ *   },
+ * )
+ * ```
+ */
+export declare function createSimpleDbcPool(name: string, symbol: string, creator: string, options?: {
+    quoteMint?: 'usdc' | 'sol' | 'jup' | string;
+    initialMarketCap?: number;
+    migrationMarketCap?: number;
+    feeBps?: FeeBps;
+    antiSniping?: boolean;
+    isLpLocked?: boolean;
+    imageContentType?: TokenImageContentType;
+}, config?: JupiterConfig): Promise<CreateDbcPoolResponse>;
+/**
+ * 创建带 Vesting 的 DBC 池
+ *
+ * @param name 代币名称
+ * @param symbol 代币符号
+ * @param creator 创建者地址
+ * @param vestingPercent Vesting 百分比（0-80）
+ * @param vestingDuration Vesting 持续时间
+ * @param options 其他选项
+ * @param config Jupiter 配置
+ * @returns 创建响应
+ */
+export declare function createDbcPoolWithVesting(name: string, symbol: string, creator: string, vestingPercent: number, vestingDuration: VestingDuration, options?: {
+    quoteMint?: 'usdc' | 'sol' | 'jup' | string;
+    initialMarketCap?: number;
+    migrationMarketCap?: number;
+    cliffDuration?: VestingDuration;
+    imageContentType?: TokenImageContentType;
+}, config?: JupiterConfig): Promise<CreateDbcPoolResponse>;
+/**
+ * 提交 DBC 池交易
+ *
+ * 提交已签名的交易到链上创建 DBC 池。
+ *
+ * @param params 提交参数
+ * @param config Jupiter 配置
+ * @returns 提交响应
+ *
+ * @example
+ * ```typescript
+ * // 签名交易后提交
+ * const result = await Sol.submitDbcPool({
+ *   transaction: signedTxBase64,
+ *   owner: wallet.publicKey.toBase58(),
+ *   content: 'My awesome token description',
+ * })
+ *
+ * if (result.success) {
+ *   console.log(`创建成功: ${result.data.mint}`)
+ *   console.log(`配置 Key: ${result.data.configKey}`)
+ * }
+ * ```
+ */
+export declare function submitDbcPool(params: SubmitDbcPoolParams, config?: JupiterConfig): Promise<SubmitDbcPoolResponse>;
+/**
+ * 获取 DBC 池地址
+ *
+ * @param mint 代币 Mint 地址
+ * @param config Jupiter 配置
+ * @returns 池地址响应
+ *
+ * @example
+ * ```typescript
+ * const addresses = await Sol.getDbcPoolAddresses('tokenMintAddress...')
+ *
+ * if (addresses.success) {
+ *   console.log(`DBC 池: ${addresses.data.dbcPoolAddress}`)
+ *   console.log(`DAMM V2 池: ${addresses.data.dammv2PoolAddress}`)
+ * }
+ * ```
+ */
+export declare function getDbcPoolAddresses(mint: string, config?: JupiterConfig): Promise<DbcPoolAddressesResponse>;
+/**
+ * 获取 DBC 池地址（仅地址）
+ *
+ * @param mint 代币 Mint 地址
+ * @param config Jupiter 配置
+ * @returns DBC 池地址或 null
+ */
+export declare function getDbcPoolAddress(mint: string, config?: JupiterConfig): Promise<string | null>;
+/**
+ * 获取 DAMM V2 池地址
+ *
+ * @param mint 代币 Mint 地址
+ * @param config Jupiter 配置
+ * @returns DAMM V2 池地址或 null
+ */
+export declare function getDammV2PoolAddress(mint: string, config?: JupiterConfig): Promise<string | null>;
+/**
+ * 检查代币是否已迁移到 DAMM V2
+ *
+ * @param mint 代币 Mint 地址
+ * @param config Jupiter 配置
+ * @returns 是否已迁移
+ */
+export declare function isTokenMigrated(mint: string, config?: JupiterConfig): Promise<boolean>;
+/**
+ * 获取 DBC 费用信息
+ *
+ * @param poolAddress DBC 池地址
+ * @param config Jupiter 配置
+ * @returns 费用信息
+ *
+ * @example
+ * ```typescript
+ * const fee = await Sol.getDbcFee('poolAddress...')
+ *
+ * console.log(`未领取: ${fee.unclaimed}`)
+ * console.log(`总计: ${fee.total}`)
+ * ```
+ */
+export declare function getDbcFee(poolAddress: string, config?: JupiterConfig): Promise<DbcFeeResponse>;
+/**
+ * 创建领取 DBC 费用交易
+ *
+ * @param params 领取参数
+ * @param config Jupiter 配置
+ * @returns 领取响应
+ *
+ * @example
+ * ```typescript
+ * // 获取未领取费用
+ * const fee = await Sol.getDbcFee('poolAddress...')
+ *
+ * if (BigInt(fee.unclaimed) > 0) {
+ *   // 创建领取交易
+ *   const result = await Sol.createClaimDbcFeeTx({
+ *     ownerWallet: wallet.publicKey.toBase58(),
+ *     poolAddress: 'poolAddress...',
+ *     maxQuoteAmount: Number(fee.unclaimed),
+ *   })
+ *
+ *   // 签名并发送
+ *   const tx = VersionedTransaction.deserialize(
+ *     Buffer.from(result.transaction, 'base64')
+ *   )
+ *   tx.sign([wallet])
+ *   // 发送交易...
+ * }
+ * ```
+ */
+export declare function createClaimDbcFeeTx(params: ClaimDbcFeeParams, config?: JupiterConfig): Promise<ClaimDbcFeeResponse>;
+/**
+ * 领取所有未领取的 DBC 费用
+ *
+ * @param ownerWallet 所有者钱包
+ * @param poolAddress 池地址
+ * @param config Jupiter 配置
+ * @returns 领取交易或 null（无费用可领）
+ */
+export declare function claimAllDbcFee(ownerWallet: string, poolAddress: string, config?: JupiterConfig): Promise<ClaimDbcFeeResponse | null>;
+/**
+ * 生成代币元数据
+ *
+ * @param name 代币名称
+ * @param symbol 代币符号
+ * @param description 描述
+ * @param imageUrl 图片 URL
+ * @param options 其他选项
+ * @returns 元数据 JSON 字符串
+ */
+export declare function generateTokenMetadata(name: string, symbol: string, description: string, imageUrl: string, options?: {
+    externalUrl?: string;
+    twitter?: string;
+    telegram?: string;
+    discord?: string;
+    website?: string;
+}): string;
+/**
+ * 上传图片到预签名 URL
+ *
+ * @param presignedUrl 预签名 URL
+ * @param imageData 图片数据 (Buffer 或 Blob)
+ * @param contentType 图片类型
+ * @returns 是否成功
+ */
+export declare function uploadDbcTokenImage(presignedUrl: string, imageData: Blob | ArrayBuffer, contentType: TokenImageContentType): Promise<boolean>;
+/**
+ * 上传元数据到预签名 URL
+ *
+ * @param presignedUrl 预签名 URL
+ * @param metadata 元数据对象或 JSON 字符串
+ * @returns 是否成功
+ */
+export declare function uploadDbcTokenMetadata(presignedUrl: string, metadata: Record<string, unknown> | string): Promise<boolean>;