100x-sdk 1.0.2 → 1.0.4

package/src/modules/token.js

@@ -1,10 +1,10 @@
 const { ComputeBudgetProgram, PublicKey, Transaction, Keypair, SystemProgram, SYSVAR_RENT_PUBKEY } = require('@solana/web3.js');
 const { TOKEN_PROGRAM_ID, getAssociatedTokenAddress, createAssociatedTokenAccountInstruction, ASSOCIATED_TOKEN_PROGRAM_ID } = require('@solana/spl-token');
 const anchor = require('@coral-xyz/anchor');
-// 统一使用 buffer 包，所有平台一致
+// Uniformly use the buffer package, consistent across all platforms
 const { Buffer } = require('buffer');
 
-// Metaplex Token Metadata 程序ID
+// Metaplex Token Metadata program ID
 const METADATA_PROGRAM_ID = new PublicKey("metaqbxxUerdq28cj1RbAWkYQm3ybzjb6a8bt518x1s");
 
 /**
@@ -17,42 +17,42 @@ class TokenModule {
   }
 
   /**
-   * 创建新代币
-   * @param {Object} params - 创建参数
-   * @param {Keypair} params.mint - 代币mint keypair
-   * @param {string} params.name - 代币名称
-   * @param {string} params.symbol - 代币符号
-   * @param {string} params.uri - 元数据URI
-   * @param {PublicKey} params.payer - 创建者公钥（付款方）
+   * Create a new token
+   * @param {Object} params - Creation parameters
+   * @param {Keypair} params.mint - Token mint keypair
+   * @param {string} params.name - Token name
+   * @param {string} params.symbol - Token symbol
+   * @param {string} params.uri - Metadata URI
+   * @param {PublicKey} params.payer - Creator public key (payer)
    *
-   * === 第二阶段新增：高级版池子可选参数（5个参数必须全部提供或全部不提供）===
-   * @param {anchor.BN} [params.customLpSol] - 自定义流动池SOL数量（lamports，9位精度）
-   *   - 不传或传null：创建普通版池子，使用默认值30 SOL
-   *   - 传入值：创建高级版池子，需在 10 SOL ~ 1000 SOL 范围内
-   *   - ⚠️ 必须与其他4个 custom 参数同时提供
+   * === Phase 2 addition: advanced pool optional parameters (all 5 must be provided together or none at all) ===
+   * @param {anchor.BN} [params.customLpSol] - Custom liquidity pool SOL amount (lamports, 9-digit precision)
+   *   - Not provided or null: creates a standard pool using the default value of 30 SOL
+   *   - Provided: creates an advanced pool, must be within the range 10 SOL ~ 1000 SOL
+   *   - ⚠️ Must be provided together with the other 4 custom parameters
    *
-   * @param {anchor.BN} [params.customLpToken] - 自定义流动池Token数量（最小单位，9位精度）
-   *   - 不传或传null：使用默认值10.73亿 Token
-   *   - 传入值：需在 1亿 ~ 100亿 Token 范围内
+   * @param {anchor.BN} [params.customLpToken] - Custom liquidity pool Token amount (smallest unit, 9-digit precision)
+   *   - Not provided or null: uses the default value of 1.073 billion Token
+   *   - Provided: must be within the range 100 million ~ 10 billion Token
    *
-   * @param {number} [params.customBorrowRatio] - 自定义借贷池代币占比（5-30表示5%-30%）
-   *   - 不传或传null：使用默认值20%
-   *   - 传入值：需在 5 ~ 30 范围内
+   * @param {number} [params.customBorrowRatio] - Custom borrow pool token ratio (5-30 means 5%-30%)
+   *   - Not provided or null: uses the default value of 20%
+   *   - Provided: must be within the range 5 ~ 30
    *
-   * @param {number} [params.customBorrowDuration] - 自定义借贷时长（秒）
-   *   - 不传或传null：使用Params账户配置的默认值
-   *   - 传入值：需在 3天(259200秒) ~ 6个月(15552000秒) 范围内
+   * @param {number} [params.customBorrowDuration] - Custom borrow duration (seconds)
+   *   - Not provided or null: uses the default value configured in the Params account
+   *   - Provided: must be within the range 3 days (259200 seconds) ~ 6 months (15552000 seconds)
    *
-   * @param {number} [params.customFee] - 自定义手续费率（单位：基点 basis points）
-   *   - 不传或传null：使用Params账户配置的默认手续费
-   *   - 传入值：需在 1000 ~ 5000 范围内（表示 1% ~ 5%）
-   *   - 示例：2000 表示 2%
-   *   - 借贷手续费会自动上浮20%（如设置2000，则 swap_fee=2000，borrow_fee=2400）
+   * @param {number} [params.customFee] - Custom fee rate (unit: basis points)
+   *   - Not provided or null: uses the default fee configured in the Params account
+   *   - Provided: must be within the range 1000 ~ 5000 (representing 1% ~ 5%)
+   *   - Example: 2000 means 2%
+   *   - Borrow fee is automatically increased by 20% (e.g. setting 2000 results in swap_fee=2000, borrow_fee=2400)
    *
-   * @returns {Promise<Object>} 包含transaction、signers和账户信息的对象
+   * @returns {Promise<Object>} Object containing transaction, signers and account info
    *
    * @example
-   * // 创建普通版代币（使用默认参数）
+   * // Create a standard token (using default parameters)
    * const result = await sdk.token.create({
    *   mint: mintKeypair,
    *   name: "My Token",
@@ -62,7 +62,7 @@ class TokenModule {
    * });
    *
    * @example
-   * // 创建高级版代币（自定义流动池参数，必须提供全部5个参数）
+   * // Create an advanced token (custom liquidity pool parameters, all 5 parameters must be provided)
    * const anchor = require('@coral-xyz/anchor');
    * const result = await sdk.token.create({
    *   mint: mintKeypair,
@@ -71,9 +71,9 @@ class TokenModule {
    *   uri: "https://example.com/metadata.json",
    *   payer: wallet.publicKey,
    *   customLpSol: new anchor.BN('60000000000'),              // 60 SOL
-   *   customLpToken: new anchor.BN('1073000000000000000'),    // 10.73亿 Token
+   *   customLpToken: new anchor.BN('1073000000000000000'),    // 1.073 billion Token
    *   customBorrowRatio: 15,                                   // 15%
-   *   customBorrowDuration: 7 * 24 * 3600,                     // 7天
+   *   customBorrowDuration: 7 * 24 * 3600,                     // 7 days
    *   customFee: 2000                                          // 2% (2000 basis points)
    * });
    */
@@ -83,7 +83,7 @@ class TokenModule {
     symbol,
     uri,
     payer,
-    // 高级版池子可选参数（5个参数必须全部提供或全部不提供）
+    // Advanced pool optional parameters (all 5 must be provided together or none at all)
     customLpSol = null,
     customLpToken = null,
     customBorrowRatio = null,
@@ -96,7 +96,7 @@ class TokenModule {
       symbol,
       uri,
       payer: payer.toString(),
-      // 高级版池子参数日志
+      // Advanced pool parameters log
       poolType: (customLpSol === null && customLpToken === null &&
                  customBorrowRatio === null && customBorrowDuration === null &&
                  customFee === null)
@@ -192,7 +192,7 @@ class TokenModule {
       units: 400000
     });
 
-    // 构建创建代币指令（传入5个自定义参数）
+    // Build the create token instruction (passing in 5 custom parameters)
     const createIx = await this.sdk.program.methods
       .createToken(
         name,
@@ -202,7 +202,7 @@ class TokenModule {
         customLpToken,         // Option<u64>
         customBorrowRatio,     // Option<u8>
         customBorrowDuration,  // Option<u32>
-        customFee              // Option<u16> - 新增参数
+        customFee              // Option<u16> - new parameter
       )
       .accounts({
         payer: payer,
@@ -248,7 +248,7 @@ class TokenModule {
 
   /**
    * Create token and buy in one transaction
-   * 将 create 和 buy 两个指令合并到一个交易中，一次签名提交
+   * Merges the create and buy instructions into a single transaction, submitted with one signature
    *
    * @param {Object} params - Creation and buy parameters
    * @param {Keypair} params.mint - Token mint keypair
@@ -259,12 +259,12 @@ class TokenModule {
    * @param {anchor.BN} params.buyTokenAmount - Amount of tokens to buy
    * @param {anchor.BN} params.maxSolAmount - Maximum SOL to spend
    *
-   * === 第二阶段新增：高级版池子可选参数（5个参数必须全部提供或全部不提供）===
-   * @param {anchor.BN} [params.customLpSol] - 自定义流动池SOL数量（lamports，9位精度）
-   * @param {anchor.BN} [params.customLpToken] - 自定义流动池Token数量（最小单位，9位精度）
-   * @param {number} [params.customBorrowRatio] - 自定义借贷池代币占比（5-30表示5%-30%）
-   * @param {number} [params.customBorrowDuration] - 自定义借贷时长（秒）
-   * @param {number} [params.customFee] - 自定义手续费率（1000-5000 basis points，表示1%-5%）
+   * === Phase 2 addition: advanced pool optional parameters (all 5 must be provided together or none at all) ===
+   * @param {anchor.BN} [params.customLpSol] - Custom liquidity pool SOL amount (lamports, 9-digit precision)
+   * @param {anchor.BN} [params.customLpToken] - Custom liquidity pool Token amount (smallest unit, 9-digit precision)
+   * @param {number} [params.customBorrowRatio] - Custom borrow pool token ratio (5-30 means 5%-30%)
+   * @param {number} [params.customBorrowDuration] - Custom borrow duration (seconds)
+   * @param {number} [params.customFee] - Custom fee rate (1000-5000 basis points, representing 1%-5%)
    *
    * @param {Object} options - Optional parameters
    * @param {number} options.computeUnits - Compute units limit, default 1800000
@@ -278,7 +278,7 @@ class TokenModule {
     payer,
     buyTokenAmount,
     maxSolAmount,
-    // 高级版池子可选参数（5个参数必须全部提供或全部不提供）
+    // Advanced pool optional parameters (all 5 must be provided together or none at all)
     customLpSol = null,
     customLpToken = null,
     customBorrowRatio = null,
@@ -297,12 +297,12 @@ class TokenModule {
       maxSolAmount: maxSolAmount.toString()
     });
 
-    // 1. 参数验证
+    // 1. Parameter validation
     if (!anchor.BN.isBN(buyTokenAmount) || !anchor.BN.isBN(maxSolAmount)) {
       throw new Error('buyTokenAmount and maxSolAmount must be anchor.BN type');
     }
 
-    // 2. 调用 create 方法获取 create 交易（传递所有自定义参数）
+    // 2. Call the create method to get the create transaction (passing all custom parameters)
     console.log('Step 1: Building create transaction...');
     const createResult = await this.create({
       mint,
@@ -310,7 +310,7 @@ class TokenModule {
       symbol,
       uri,
       payer,
-      // 传递自定义流动池参数（5个参数）
+      // Pass custom liquidity pool parameters (5 parameters)
       customLpSol,
       customLpToken,
       customBorrowRatio,
@@ -318,16 +318,16 @@ class TokenModule {
       customFee
     });
 
-    // 3. 从 params 账户读取手续费接收地址
-    // 因为此时 curve_account 还未创建，无法从链上读取
+    // 3. Read the fee recipient address from the params account
+    // Because curve_account has not been created yet, it cannot be read from chain
     console.log('Step 2: Fetching fee recipient accounts from params...');
 
-    // 直接从 SDK 配置中获取手续费接收账户（这些在 SDK 初始化时已经设置）
-    // 避免使用 program.account.params.fetch() 因为可能有 provider 配置问题
+    // Get the fee recipient accounts directly from the SDK configuration (these are set during SDK initialization)
+    // Avoid using program.account.params.fetch() because there may be provider configuration issues
     const feeRecipientAccount = this.sdk.feeRecipient;
     const baseFeeRecipientAccount = this.sdk.baseFeeRecipient;
 
-    // 验证这些账户已配置
+    // Validate that these accounts are configured
     if (!feeRecipientAccount || !baseFeeRecipientAccount) {
       throw new Error('Fee recipient accounts not configured in SDK options');
     }
@@ -336,17 +336,17 @@ class TokenModule {
     console.log('  Partner fee recipient:', feeRecipientAccount.toString());
     console.log('  Base fee recipient:', baseFeeRecipientAccount.toString());
 
-    // 4. 准备 buy 所需的额外账户
+    // 4. Prepare the extra accounts required for buy
     console.log('Step 3: Calculating buy-related accounts...');
     const mintPubkey = mint.publicKey;
 
-    // 计算用户代币账户
+    // Calculate user token account
     const userTokenAccount = await getAssociatedTokenAddress(
       mintPubkey,
       payer
     );
 
-    // 计算 cooldown PDA
+    // Calculate cooldown PDA
     const [cooldownPDA] = PublicKey.findProgramAddressSync(
       [
         Buffer.from('trade_cooldown'),
@@ -356,7 +356,7 @@ class TokenModule {
       this.sdk.programId
     );
 
-    // 计算 orderbook PDAs (复用 create 中计算的值)
+    // Calculate orderbook PDAs (reuse the values calculated in create)
     const [upOrderbook] = PublicKey.findProgramAddressSync(
       [Buffer.from('up_orderbook'), mintPubkey.toBuffer()],
       this.sdk.programId
@@ -371,7 +371,7 @@ class TokenModule {
     console.log('  User token account:', userTokenAccount.toString());
     console.log('  Cooldown PDA:', cooldownPDA.toString());
 
-    // 5. 检查用户代币账户是否存在，创建 ATA 指令
+    // 5. Check if the user token account exists, create ATA instruction
     console.log('Step 4: Checking if user token account exists...');
     const userTokenAccountInfo = await this.sdk.connection.getAccountInfo(userTokenAccount);
     const createAtaIx = userTokenAccountInfo === null
@@ -391,7 +391,7 @@ class TokenModule {
       console.log('  User token account already exists');
     }
 
-    // 6. 构建 buy 指令
+    // 6. Build the buy instruction
     console.log('Step 5: Building buy instruction...');
     const buyIx = await this.sdk.program.methods
       .buy(buyTokenAmount, maxSolAmount)
@@ -415,31 +415,31 @@ class TokenModule {
       })
       .instruction();
 
-    // 7. 合并交易：create + buy
+    // 7. Merge transactions: create + buy
     console.log('Step 6: Merging create and buy transactions...');
     const transaction = new Transaction();
 
-    // 设置计算单元限制
+    // Set compute unit limit
     const modifyComputeUnits = ComputeBudgetProgram.setComputeUnitLimit({
       units: computeUnits
     });
     transaction.add(modifyComputeUnits);
 
-    // 添加 create 交易的所有指令（跳过 create 中的计算单元指令）
+    // Add all instructions from the create transaction (skip the compute unit instruction in create)
     createResult.transaction.instructions.forEach(ix => {
-      // 跳过 create 交易中的计算单元指令（我们已经添加了）
+      // Skip the compute unit instruction in the create transaction (we already added it)
       if (ix.programId.equals(ComputeBudgetProgram.programId)) {
         return;
       }
       transaction.add(ix);
     });
 
-    // 添加 ATA 创建指令（如果需要）
+    // Add ATA creation instruction (if needed)
     if (createAtaIx) {
       transaction.add(createAtaIx);
     }
 
-    // 添加 buy 指令 
+    // Add buy instruction
     transaction.add(buyIx);
 
     console.log('CreateAndBuy transaction built successfully:');
@@ -447,14 +447,14 @@ class TokenModule {
     console.log('  Compute units:', computeUnits);
     console.log('  Signers required:', [payer.toString(), mint.publicKey.toString()]);
 
-    // 8. 返回合并后的交易
+    // 8. Return the merged transaction
     return {
       transaction,
-      signers: [mint],  // mint keypair 需要签名
+      signers: [mint],  // mint keypair needs to sign
       accounts: {
-        // create 的账户
+        // create accounts
         ...createResult.accounts,
-        // buy 的账户
+        // buy accounts
         userTokenAccount,
         cooldown: cooldownPDA,
         feeRecipientAccount,

package/src/modules/tools.js

@@ -1,7 +1,7 @@
 const anchor = require('@coral-xyz/anchor');
 const { PublicKey, SystemProgram, SYSVAR_RENT_PUBKEY, Transaction } = require('@solana/web3.js');
 const { getAssociatedTokenAddress, TOKEN_PROGRAM_ID, ASSOCIATED_TOKEN_PROGRAM_ID } = require('@solana/spl-token');
-// 统一使用 buffer 包，所有平台一致
+// Uniformly use the buffer package, consistent across all platforms
 const { Buffer } = require('buffer');
 
 /**