100x-sdk 1.0.2 → 1.0.4

package/src/types/index.d.ts

@@ -1,7 +1,7 @@
 import { Connection, PublicKey, Transaction, Keypair } from '@solana/web3.js';
 import { BN, Wallet, Program } from '@coral-xyz/anchor';
 
-// ========================= 基础类型定义 =========================
+// ========================= Basic Type Definitions =========================
 
 export type DataSourceType = 'fast' | 'chain';
 
@@ -29,7 +29,7 @@ export interface Fun100xSdkOptions {
   paramsAccount?: string;
 }
 
-// ========================= 订单和交易相关类型 =========================
+// ========================= Order and Trading Related Types =========================
 
 export interface OrderData {
   order_pda: string;
@@ -89,7 +89,7 @@ export interface MintInfo {
   [key: string]: any;
 }
 
-// ========================= 交易参数类型 =========================
+// ========================= Trading Parameter Types =========================
 
 export interface BuyParams {
   mintAccount: string | PublicKey;
@@ -147,7 +147,7 @@ export interface TransactionOptions {
   computeUnits?: number;
 }
 
-// ========================= 查询参数类型 =========================
+// ========================= Query Parameter Types =========================
 
 export interface OrdersQueryOptions {
   type?: 'up_orders' | 'down_orders';
@@ -167,7 +167,7 @@ export interface UserOrdersQueryOptions {
   dataSource?: DataSourceType;
 }
 
-// ========================= 模拟器相关类型 =========================
+// ========================= Simulator Related Types =========================
 
 export interface SimulationResult {
   liqResult: {
@@ -187,7 +187,7 @@ export interface SimulationResult {
   suggestedSolAmount: string;
 }
 
-// ========================= 工具类相关类型 =========================
+// ========================= Utility Related Types =========================
 
 export interface FindPrevNextResult {
   prevOrder: OrderData | null;
@@ -200,7 +200,7 @@ export interface ValidationResult {
   warnings: string[];
 }
 
-// ========================= 模块接口定义 =========================
+// ========================= Module Interface Definitions =========================
 
 export interface TradingModule {
   buy(params: BuyParams, options?: TransactionOptions): Promise<TransactionResult>;
@@ -242,14 +242,14 @@ export interface SimulatorModule {
   simulateSellStopLoss(mint: string, sellTokenAmount: bigint | string | number, stopLossPrice: bigint | string | number, lastPrice?: any, ordersData?: any): Promise<any>;
 }
 
-// ========================= 数据接口类型 =========================
+// ========================= Data Interface Types =========================
 
 export interface DataInterface {
   orders(mint: string, options?: OrdersQueryOptions): Promise<OrdersResponse>;
   price(mint: string, options?: PriceQueryOptions): Promise<PriceResponse>;
 }
 
-// ========================= 主 SDK 类型定义 =========================
+// ========================= Main SDK Type Definition =========================
 
 export declare class Fun100xSdk {
   connection: Connection;
@@ -262,12 +262,12 @@ export declare class Fun100xSdk {
   paramsAccount: PublicKey;
   fastApiUrl: string;
 
-  // 常量
+  // Constants
   readonly MAX_ORDERS_COUNT: number;
   readonly FIND_MAX_ORDERS_COUNT: number;
   readonly SUGGEST_LIQ_RATIO: number;
 
-  // 模块
+  // Modules
   trading: TradingModule;
   fast: FastModule;
   chain: ChainModule;
@@ -276,7 +276,7 @@ export declare class Fun100xSdk {
   simulator: SimulatorModule;
   data: DataInterface;
 
-  // 静态工具类引用
+  // Static utility class references
   static CurveAMM: typeof CurveAMM;
   static OrderUtils: typeof OrderUtils;
 
@@ -286,14 +286,14 @@ export declare class Fun100xSdk {
     options?: Fun100xSdkOptions
   );
 
-  // OrderUtils 快捷方法
+  // OrderUtils shortcut methods
   buildLpPairs(orders: OrderData[], direction: string, price: any, maxCount?: number): LpPair[];
   buildOrderAccounts(orders: OrderData[], maxCount?: number): (string | null)[];
   findPrevNext(orders: OrderData[], findOrderPda: string): FindPrevNextResult;
   findOrderIndex(orders: OrderData[], targetOrderPda: string | PublicKey | null): number;
 }
 
-// ========================= 工具类导出 =========================
+// ========================= Utility Class Exports =========================
 
 export declare class OrderUtils {
   static buildLpPairs(orders: OrderData[], direction: string, price: any, maxCount?: number): LpPair[];
@@ -336,7 +336,7 @@ export declare class CurveAMM {
   static calculateInitialK(): any;
   static getInitialPrice(): bigint | null;
 
-  // Custom pool parameters calculation (动态流动池)
+  // Custom pool parameters calculation (dynamic liquidity pool)
   static calculateK(initialVirtualSol: any, initialVirtualToken: any): any;
   static getInitialPriceWithParams(initialVirtualSol: any, initialVirtualToken: any): bigint | null;
 
@@ -349,7 +349,7 @@ export declare class CurveAMM {
   static buyFromPriceWithTokenOutput(startLowPrice: bigint | string | number, tokenOutputAmount: bigint | string | number): [bigint, bigint] | null;
   static sellFromPriceWithSolOutput(startHighPrice: bigint | string | number, solOutputAmount: bigint | string | number): [bigint, bigint] | null;
 
-  // AMM calculation methods with custom pool parameters (动态流动池)
+  // AMM calculation methods with custom pool parameters (dynamic liquidity pool)
   static priceToReservesWithParams(price: any, initialVirtualSol: any, initialVirtualToken: any): [any, any] | null;
   static buyFromPriceToPriceWithParams(startLowPrice: bigint | string | number, endHighPrice: bigint | string | number, initialVirtualSol: any, initialVirtualToken: any): [bigint, bigint] | null;
   static sellFromPriceToPriceWithParams(startHighPrice: bigint | string | number, endLowPrice: bigint | string | number, initialVirtualSol: any, initialVirtualToken: any): [bigint, bigint] | null;
@@ -365,7 +365,7 @@ export declare class CurveAMM {
   static calculatePoolPrice(lpTokenReserve: bigint | string | number | BN, lpSolReserve: bigint | string | number | BN): string | null;
 }
 
-// ========================= 常量和函数导出 =========================
+// ========================= Constant and Function Exports =========================
 
 export declare const FUN100X_PROGRAM_ID: PublicKey;
 
@@ -373,7 +373,7 @@ export declare function getProgramId(network?: NetworkType): PublicKey;
 
 export declare function getDefaultOptions(networkName?: 'MAINNET' | 'DEVNET' | 'LOCALNET'): NetworkConfig;
 
-// ========================= 模块类导出 =========================
+// ========================= Module Class Exports =========================
 
 export declare class TradingModule implements TradingModule {}
 export declare class FastModule implements FastModule {}
@@ -382,5 +382,5 @@ export declare class TokenModule implements TokenModule {}
 export declare class ParamModule implements ParamModule {}
 export declare class SimulatorModule implements SimulatorModule {}
 
-// 默认导出
+// Default export
 export default Fun100xSdk;

package/src/utils/constants.js

@@ -29,7 +29,7 @@ const DEFAULT_NETWORKS = {
   LOCALNET: {
     name: 'localnet',
     network: 'localnet',
-    programId: 'sGecRTjTZmnqJBmLK4ZMNCzsaMrgkFfNqEcYk1GhRde',
+    programId: 'EVNaaiyg9z876PUmLCVQcdc5L5eJukT4pni5GtVJ8P37',
     defaultDataSource: 'fast', // 'fast' or 'chain'
     solanaEndpoint: 'http://127.0.0.1:8899',
     fastApiUrl: 'http://127.0.0.1:3000',
@@ -37,7 +37,7 @@ const DEFAULT_NETWORKS = {
     // fastApiUrl: 'http://216.158.231.58:3000',
     feeRecipient: 'GesAj2dTn2wdNcxj4x8qsqS9aNRVPBPkE76aaqg7skxu',
     baseFeeRecipient: '5YHi1HsxobLiTD6NQfHJQpoPoRjMuNyXp4RroTvR6dKi',
-    paramsAccount: 'FqQM2qikNcQDbzufTjURq4Eg9Wc6rLjJQYgyFdHdks1P'
+    paramsAccount: 'HPuvtLLcgSMPSyRmULPiFe9oAvm1o8mR4weqXZrUhzRM'
   }
 };
 

package/src/utils/curve_amm.js

@@ -286,16 +286,16 @@ class CurveAMM {
     }
 
     /**
-     * 根据自定义初始储备量计算 k 值
-     * @param {string|number|Decimal} initialVirtualSol - 初始虚拟SOL储备量（实际值，非lamports）
-     * @param {string|number|Decimal} initialVirtualToken - 初始虚拟Token储备量（实际值，非最小单位）
-     * @returns {Decimal} k值
+     * Calculate the k value based on custom initial reserves
+     * @param {string|number|Decimal} initialVirtualSol - Initial virtual SOL reserve (actual value, not lamports)
+     * @param {string|number|Decimal} initialVirtualToken - Initial virtual Token reserve (actual value, not smallest unit)
+     * @returns {Decimal} k value
      *
      * @example
-     * // 使用默认参数（30 SOL, 10.73亿 Token）
+     * // Use default parameters (30 SOL, 1.073 billion Token)
      * const k1 = CurveAMM.calculateK(30, 1073000000);
      *
-     * // 使用自定义参数（60 SOL, 10.73亿 Token）
+     * // Use custom parameters (60 SOL, 1.073 billion Token)
      * const k2 = CurveAMM.calculateK(60, 1073000000);
      */
     static calculateK(initialVirtualSol, initialVirtualToken) {
@@ -305,7 +305,7 @@ class CurveAMM {
     }
 
     /**
-     * 使用默认参数计算初始k值（向后兼容）
+     * Calculate the initial k value using default parameters (backward compatible)
      * @returns {Decimal} Product k value of initial reserves
      */
     static calculateInitialK() {
@@ -316,10 +316,10 @@ class CurveAMM {
     }
 
     /**
-     * 根据自定义初始储备量获取初始价格
-     * @param {string|number|Decimal} initialVirtualSol - 初始虚拟SOL储备量
-     * @param {string|number|Decimal} initialVirtualToken - 初始虚拟Token储备量
-     * @returns {bigint|null} u128格式的初始价格
+     * Get the initial price based on custom initial reserves
+     * @param {string|number|Decimal} initialVirtualSol - Initial virtual SOL reserve
+     * @param {string|number|Decimal} initialVirtualToken - Initial virtual Token reserve
+     * @returns {bigint|null} Initial price in u128 format
      */
     static getInitialPriceWithParams(initialVirtualSol, initialVirtualToken) {
         const sol = new Decimal(initialVirtualSol);
@@ -329,7 +329,7 @@ class CurveAMM {
     }
 
     /**
-     * 使用默认参数获取初始价格（向后兼容）
+     * Get the initial price using default parameters (backward compatible)
      * Get initial price (SOL amount for 1 token)
      *
      * @returns {bigint|null} Initial price in u128 format, returns null if calculation fails
@@ -342,12 +342,12 @@ class CurveAMM {
     }
 
     /**
-     * 根据自定义初始储备量计算从低价买入到高价所需的SOL和获得的Token
-     * @param {bigint|string|number} startLowPrice - 起始价格（较低）
-     * @param {bigint|string|number} endHighPrice - 目标价格（较高）
-     * @param {string|number|Decimal} initialVirtualSol - 初始虚拟SOL储备量
-     * @param {string|number|Decimal} initialVirtualToken - 初始虚拟Token储备量
-     * @returns {[bigint, bigint]|null} 成功返回 [需投入SOL数量, 获得token数量], 失败返回null
+     * Calculate the SOL required and Token obtained when buying from a low price up to a high price, based on custom initial reserves
+     * @param {bigint|string|number} startLowPrice - Starting price (lower)
+     * @param {bigint|string|number} endHighPrice - Target price (higher)
+     * @param {string|number|Decimal} initialVirtualSol - Initial virtual SOL reserve
+     * @param {string|number|Decimal} initialVirtualToken - Initial virtual Token reserve
+     * @returns {[bigint, bigint]|null} Returns [SOL amount to invest, token amount obtained] on success, null on failure
      */
     static buyFromPriceToPriceWithParams(startLowPrice, endHighPrice, initialVirtualSol, initialVirtualToken) {
         // Convert to Decimal for calculation
@@ -397,7 +397,7 @@ class CurveAMM {
     }
 
     /**
-     * 使用默认参数计算从低价买入到高价（向后兼容）
+     * Calculate buying from a low price up to a high price using default parameters (backward compatible)
      * Calculate SOL required and token amount obtained when buying tokens from low to high price
      *
      * @param {bigint|string|number} startLowPrice - Starting price (lower)
@@ -415,12 +415,12 @@ class CurveAMM {
     }
 
     /**
-     * 根据自定义初始储备量计算从高价卖出到低价所需的Token和获得的SOL
-     * @param {bigint|string|number} startHighPrice - 起始价格（较高）
-     * @param {bigint|string|number} endLowPrice - 目标价格（较低）
-     * @param {string|number|Decimal} initialVirtualSol - 初始虚拟SOL储备量
-     * @param {string|number|Decimal} initialVirtualToken - 初始虚拟Token储备量
-     * @returns {[bigint, bigint]|null} 成功返回 [需卖出token数量, 获得SOL数量], 失败返回null
+     * Calculate the Token required and SOL obtained when selling from a high price down to a low price, based on custom initial reserves
+     * @param {bigint|string|number} startHighPrice - Starting price (higher)
+     * @param {bigint|string|number} endLowPrice - Target price (lower)
+     * @param {string|number|Decimal} initialVirtualSol - Initial virtual SOL reserve
+     * @param {string|number|Decimal} initialVirtualToken - Initial virtual Token reserve
+     * @returns {[bigint, bigint]|null} Returns [token amount to sell, SOL amount obtained] on success, null on failure
      */
     static sellFromPriceToPriceWithParams(startHighPrice, endLowPrice, initialVirtualSol, initialVirtualToken) {
         // Convert to Decimal for calculation
@@ -470,7 +470,7 @@ class CurveAMM {
     }
 
     /**
-     * 使用默认参数计算从高价卖出到低价（向后兼容）
+     * Calculate selling from a high price down to a low price using default parameters (backward compatible)
      * Calculate SOL amount obtained when selling tokens from high to low price
      *
      * @param {bigint|string|number} startHighPrice - Starting price (higher)
@@ -488,9 +488,9 @@ class CurveAMM {
     }
 
     /**
-     * 根据价格和自定义k值计算储备量
-     * @param {bigint|string} price - u128格式价格
-     * @param {Decimal} k - 自定义k值
+     * Calculate reserves based on a price and a custom k value
+     * @param {bigint|string} price - Price in u128 format
+     * @param {Decimal} k - Custom k value
      * @returns {{solReserve: Decimal, tokenReserve: Decimal}|null}
      */
     static priceToReservesWithK(price, k) {
@@ -523,10 +523,10 @@ class CurveAMM {
     }
 
     /**
-     * 根据价格和自定义初始储备量计算储备量
-     * @param {bigint|string} price - u128格式价格
-     * @param {string|number|Decimal} initialVirtualSol - 初始虚拟SOL储备量
-     * @param {string|number|Decimal} initialVirtualToken - 初始虚拟Token储备量
+     * Calculate reserves based on a price and custom initial reserves
+     * @param {bigint|string} price - Price in u128 format
+     * @param {string|number|Decimal} initialVirtualSol - Initial virtual SOL reserve
+     * @param {string|number|Decimal} initialVirtualToken - Initial virtual Token reserve
      * @returns {{solReserve: Decimal, tokenReserve: Decimal}|null}
      */
     static priceToReservesWithParams(price, initialVirtualSol, initialVirtualToken) {
@@ -535,8 +535,8 @@ class CurveAMM {
     }
 
     /**
-     * 使用默认参数根据价格计算储备量（向后兼容）
-     * @param {bigint|string} price - u128格式价格
+     * Calculate reserves based on a price using default parameters (backward compatible)
+     * @param {bigint|string} price - Price in u128 format
      * @returns {{solReserve: Decimal, tokenReserve: Decimal}|null}
      */
     static priceToReserves(price) {
@@ -617,12 +617,12 @@ class CurveAMM {
     }
 
     /**
-     * 根据自定义初始储备量，基于起始价格和SOL输入量计算token输出量和结束价格
-     * @param {bigint|string|number} startLowPrice - 起始价格
-     * @param {bigint|string|number} solInputAmount - 用于买入的SOL数量
-     * @param {string|number|Decimal} initialVirtualSol - 初始虚拟SOL储备量
-     * @param {string|number|Decimal} initialVirtualToken - 初始虚拟Token储备量
-     * @returns {[bigint, bigint]|null} 成功返回 [交易后价格, 获得的token数量], 失败返回null
+     * Based on custom initial reserves, calculate the token output amount and ending price from a starting price and SOL input amount
+     * @param {bigint|string|number} startLowPrice - Starting price
+     * @param {bigint|string|number} solInputAmount - SOL amount used for buying
+     * @param {string|number|Decimal} initialVirtualSol - Initial virtual SOL reserve
+     * @param {string|number|Decimal} initialVirtualToken - Initial virtual Token reserve
+     * @returns {[bigint, bigint]|null} Returns [price after transaction, token amount obtained] on success, null on failure
      */
     static buyFromPriceWithSolInputWithParams(startLowPrice, solInputAmount, initialVirtualSol, initialVirtualToken) {
         // Convert to Decimal for calculation
@@ -683,7 +683,7 @@ class CurveAMM {
     }
 
     /**
-     * 使用默认参数计算token输出量和结束价格（向后兼容）
+     * Calculate the token output amount and ending price using default parameters (backward compatible)
      * Calculate token output amount and ending price based on starting price and SOL input amount
      *
      * @param {bigint|string|number} startLowPrice - Starting price
@@ -701,12 +701,12 @@ class CurveAMM {
     }
 
     /**
-     * 根据自定义初始储备量，基于起始价格和token输入量计算SOL输出量和结束价格
-     * @param {bigint|string|number} startHighPrice - 起始价格
-     * @param {bigint|string|number} tokenInputAmount - 要卖出的token数量
-     * @param {string|number|Decimal} initialVirtualSol - 初始虚拟SOL储备量
-     * @param {string|number|Decimal} initialVirtualToken - 初始虚拟Token储备量
-     * @returns {[bigint, bigint]|null} 成功返回 [交易后价格, 获得的SOL数量], 失败返回null
+     * Based on custom initial reserves, calculate the SOL output amount and ending price from a starting price and token input amount
+     * @param {bigint|string|number} startHighPrice - Starting price
+     * @param {bigint|string|number} tokenInputAmount - Token amount to sell
+     * @param {string|number|Decimal} initialVirtualSol - Initial virtual SOL reserve
+     * @param {string|number|Decimal} initialVirtualToken - Initial virtual Token reserve
+     * @returns {[bigint, bigint]|null} Returns [price after transaction, SOL amount obtained] on success, null on failure
      */
     static sellFromPriceWithTokenInputWithParams(startHighPrice, tokenInputAmount, initialVirtualSol, initialVirtualToken) {
         // Convert to Decimal for calculation
@@ -741,7 +741,7 @@ class CurveAMM {
         // Calculate token reserves for ending state
         const endTokenReserve = startTokenReserve.add(tokenInputDec);
 
-        // 根据AMM公式计算结束状态的SOL储备量
+        // Calculate the SOL reserve for the ending state according to the AMM formula
         const endSolReserve = k.div(endTokenReserve);
 
         // Calculate SOL output amount
@@ -767,7 +767,7 @@ class CurveAMM {
     }
 
     /**
-     * 使用默认参数计算SOL输出量和结束价格（向后兼容）
+     * Calculate the SOL output amount and ending price using default parameters (backward compatible)
      * Calculate SOL output amount and ending price based on starting price and token input amount
      *
      * @param {bigint|string|number} startHighPrice - Starting price
@@ -825,14 +825,14 @@ class CurveAMM {
         // Calculate token reserves for ending state
         const endTokenReserve = startTokenReserve.sub(tokenOutputDec);
 
-        //console.log('buyFromPriceWithTokenOutput  结束token储备 = 起始token储备 - token输出量:', endTokenReserve.toString());
+        //console.log('buyFromPriceWithTokenOutput  ending token reserve = starting token reserve - token output amount:', endTokenReserve.toString());
 
         // Check if token reserves are sufficient
         if (endTokenReserve.lte(0)) {
             return null;
         }
 
-        // 根据AMM公式计算结束状态的SOL储备量
+        // Calculate the SOL reserve for the ending state according to the AMM formula
         const endSolReserve = k.div(endTokenReserve);
 
         // Calculate required SOL input amount
@@ -858,7 +858,7 @@ class CurveAMM {
     }
 
     /**
-     * 基于起始价格和期望token输出量计算需要的SOL输入量和结束价格（带自定义流动池参数）
+     * Based on a starting price and desired token output amount, calculate the required SOL input amount and ending price (with custom liquidity pool parameters)
      * Based on starting price and desired token output, calculate required SOL input and ending price (with custom pool params)
      *
      * @param {bigint|string|number} startLowPrice - Starting price (lower)
@@ -1003,7 +1003,7 @@ class CurveAMM {
     }
 
     /**
-     * 基于起始价格和期望SOL输出量计算需要的token输入量和结束价格（带自定义流动池参数）
+     * Based on a starting price and desired SOL output amount, calculate the required token input amount and ending price (with custom liquidity pool parameters)
      * Based on starting price and desired SOL output, calculate required token input and ending price (with custom pool params)
      *
      * @param {bigint|string|number} startHighPrice - Starting price (higher)

package/src/utils/orderUtils.js

@@ -1,10 +1,8 @@
 const anchor = require('@coral-xyz/anchor');
 
 /**
- * 订单数据处理工具模块
  * Order Data Processing Utilities Module
- * 
- * 提供订单数据格式转换和处理的纯函数工具方法
+ *
  * Provides pure function utilities for order data format conversion and processing
  */
 class OrderUtils {