moltspay 0.2.0 → 0.2.1

package/dist/wallet/index.d.mts

@@ -103,21 +103,21 @@ declare class SecureWallet {
 }
 
 /**
- * createWallet - 为 Agent 创建新钱包
+ * createWallet - Create a new wallet for Agent
  *
- * 功能：
- * - 生成新的以太坊钱包
- * - 安全存储私钥（加密或明文，取决于配置）
- * - 返回钱包地址（不返回私钥）
+ * Features:
+ * - Generate new Ethereum wallet
+ * - Securely store private key (encrypted or plaintext, depending on config)
+ * - Return wallet address (never return private key)
  */
 interface CreateWalletOptions {
-    /** 存储路径，默认 ~/.moltspay/wallet.json */
+    /** Storage path, default ~/.moltspay/wallet.json */
     storagePath?: string;
-    /** 加密密码（可选，不提供则明文存储） */
+    /** Encryption password (optional, plaintext if not provided) */
     password?: string;
-    /** 钱包标签/名称 */
+    /** Wallet label/name */
     label?: string;
-    /** 如果钱包已存在，是否覆盖 */
+    /** Overwrite if wallet exists */
     overwrite?: boolean;
 }
 interface WalletData {
@@ -125,11 +125,11 @@ interface WalletData {
     label?: string;
     createdAt: string;
     encrypted: boolean;
-    /** 加密后的私钥或明文私钥 */
+    /** Encrypted or plaintext private key */
     privateKey: string;
-    /** 加密用的 IV */
+    /** Encryption IV */
     iv?: string;
-    /** 加密用的 salt */
+    /** Encryption salt */
     salt?: string;
 }
 interface CreateWalletResult {
@@ -137,28 +137,28 @@ interface CreateWalletResult {
     address?: string;
     storagePath?: string;
     error?: string;
-    /** 是否是新创建的（false 表示加载了已有钱包） */
+    /** Whether newly created (false means loaded existing) */
     isNew?: boolean;
 }
 /**
- * 创建新钱包
+ * Create new wallet
  *
  * @example
  * ```typescript
- * // 创建未加密钱包
+ * // Create unencrypted wallet
  * const result = await createWallet();
- * console.log('钱包地址:', result.address);
+ * console.log('Wallet address:', result.address);
  *
- * // 创建加密钱包
+ * // Create encrypted wallet
  * const result = await createWallet({ password: 'mySecurePassword' });
  *
- * // 指定存储路径
+ * // Specify storage path
  * const result = await createWallet({ storagePath: './my-wallet.json' });
  * ```
  */
 declare function createWallet(options?: CreateWalletOptions): CreateWalletResult;
 /**
- * 加载已有钱包
+ * Load existing wallet
  */
 declare function loadWallet(options?: {
     storagePath?: string;
@@ -170,61 +170,61 @@ declare function loadWallet(options?: {
     error?: string;
 };
 /**
- * 获取钱包地址（不需要密码）
+ * Get wallet address (no password required)
  */
 declare function getWalletAddress(storagePath?: string): string | null;
 /**
- * 检查钱包是否存在
+ * Check if wallet exists
  */
 declare function walletExists(storagePath?: string): boolean;
 
 /**
- * PermitWallet - 使用 Boss 授权的 Permit 进行支付
+ * PermitWallet - Pay using Boss's Permit authorization
  *
- * 场景：
- * - Agent 没有自己的 USDC，但 Boss 给了 Permit 授权
- * - Agent 使用 Permit 签名 + 自己的钱包执行 transferFrom
- * - Agent 只需要少量 ETH 付 gas，USDC 从 Boss 钱包扣除
+ * Scenario:
+ * - Agent doesn't have USDC, but Boss gave a Permit authorization
+ * - Agent uses Permit signature + own wallet to execute transferFrom
+ * - Agent only needs small amount of ETH for gas, USDC is deducted from Boss's wallet
  */
 
 interface PermitData {
-    /** Boss 的钱包地址（USDC 持有者） */
+    /** Boss's wallet address (USDC holder) */
     owner: string;
-    /** Agent 的钱包地址（被授权者） */
+    /** Agent's wallet address (authorized spender) */
     spender: string;
-    /** 授权金额（USDC，6位小数的原始值） */
+    /** Authorized amount (USDC, raw 6 decimal value) */
     value: string;
-    /** 过期时间戳 */
+    /** Expiration timestamp */
     deadline: number;
-    /** 签名 v */
+    /** Signature v */
     v: number;
-    /** 签名 r */
+    /** Signature r */
     r: string;
-    /** 签名 s */
+    /** Signature s */
     s: string;
 }
 interface PermitWalletConfig {
     chain?: ChainName;
-    /** Agent 的私钥（用于执行交易） */
+    /** Agent's private key (for executing transactions) */
     privateKey?: string;
-    /** 从文件加载私钥 */
+    /** Load private key from file */
     walletPath?: string;
-    /** 解密密码 */
+    /** Decryption password */
     walletPassword?: string;
     rpcUrl?: string;
 }
 interface TransferWithPermitParams {
-    /** 收款地址 */
+    /** Recipient address */
     to: string;
-    /** 金额（USDC） */
+    /** Amount (USDC) */
     amount: number;
-    /** Boss 签署的 Permit 数据 */
+    /** Boss-signed Permit data */
     permit: PermitData;
 }
 interface TransferWithPermitResult extends TransferResult {
-    /** Permit 交易 hash */
+    /** Permit transaction hash */
     permitTxHash?: string;
-    /** Transfer 交易 hash */
+    /** Transfer transaction hash */
     transferTxHash?: string;
 }
 declare class PermitWallet {
@@ -236,21 +236,21 @@ declare class PermitWallet {
     private usdcContract;
     constructor(config?: PermitWalletConfig);
     /**
-     * 检查 Permit 是否有效
+     * Check if Permit is valid (current allowance)
      */
     checkPermitAllowance(owner: string): Promise<string>;
     /**
-     * 使用 Permit 授权进行支付
+     * Pay using Permit authorization
      *
-     * 流程：
-     * 1. 调用 permit() 让合约记录 Boss 的授权
-     * 2. 调用 transferFrom() 从 Boss 钱包转账到收款方
+     * Flow:
+     * 1. Call permit() to record Boss's authorization in the contract
+     * 2. Call transferFrom() to transfer from Boss's wallet to recipient
      *
      * @example
      * ```typescript
      * const wallet = new PermitWallet({ chain: 'base' });
      *
-     * // Boss 签署的 permit 数据
+     * // Boss-signed permit data
      * const permit = {
      *   owner: '0xBOSS...',
      *   spender: wallet.address,
@@ -270,16 +270,16 @@ declare class PermitWallet {
      */
     transferWithPermit(params: TransferWithPermitParams): Promise<TransferWithPermitResult>;
     /**
-     * 获取 ETH 余额（用于支付 gas）
+     * Get ETH balance (for gas)
      */
     getGasBalance(): Promise<string>;
     /**
-     * 检查是否有足够的 gas
+     * Check if there's enough gas
      */
     hasEnoughGas(minEth?: number): Promise<boolean>;
 }
 /**
- * 格式化 Permit 请求消息（发给 Boss）
+ * Format Permit request message (to send to Boss)
  */
 declare function formatPermitRequest(params: {
     agentAddress: string;

package/dist/wallet/index.d.ts

@@ -103,21 +103,21 @@ declare class SecureWallet {
 }
 
 /**
- * createWallet - 为 Agent 创建新钱包
+ * createWallet - Create a new wallet for Agent
  *
- * 功能：
- * - 生成新的以太坊钱包
- * - 安全存储私钥（加密或明文，取决于配置）
- * - 返回钱包地址（不返回私钥）
+ * Features:
+ * - Generate new Ethereum wallet
+ * - Securely store private key (encrypted or plaintext, depending on config)
+ * - Return wallet address (never return private key)
  */
 interface CreateWalletOptions {
-    /** 存储路径，默认 ~/.moltspay/wallet.json */
+    /** Storage path, default ~/.moltspay/wallet.json */
     storagePath?: string;
-    /** 加密密码（可选，不提供则明文存储） */
+    /** Encryption password (optional, plaintext if not provided) */
     password?: string;
-    /** 钱包标签/名称 */
+    /** Wallet label/name */
     label?: string;
-    /** 如果钱包已存在，是否覆盖 */
+    /** Overwrite if wallet exists */
     overwrite?: boolean;
 }
 interface WalletData {
@@ -125,11 +125,11 @@ interface WalletData {
     label?: string;
     createdAt: string;
     encrypted: boolean;
-    /** 加密后的私钥或明文私钥 */
+    /** Encrypted or plaintext private key */
     privateKey: string;
-    /** 加密用的 IV */
+    /** Encryption IV */
     iv?: string;
-    /** 加密用的 salt */
+    /** Encryption salt */
     salt?: string;
 }
 interface CreateWalletResult {
@@ -137,28 +137,28 @@ interface CreateWalletResult {
     address?: string;
     storagePath?: string;
     error?: string;
-    /** 是否是新创建的（false 表示加载了已有钱包） */
+    /** Whether newly created (false means loaded existing) */
     isNew?: boolean;
 }
 /**
- * 创建新钱包
+ * Create new wallet
  *
  * @example
  * ```typescript
- * // 创建未加密钱包
+ * // Create unencrypted wallet
  * const result = await createWallet();
- * console.log('钱包地址:', result.address);
+ * console.log('Wallet address:', result.address);
  *
- * // 创建加密钱包
+ * // Create encrypted wallet
  * const result = await createWallet({ password: 'mySecurePassword' });
  *
- * // 指定存储路径
+ * // Specify storage path
  * const result = await createWallet({ storagePath: './my-wallet.json' });
  * ```
  */
 declare function createWallet(options?: CreateWalletOptions): CreateWalletResult;
 /**
- * 加载已有钱包
+ * Load existing wallet
  */
 declare function loadWallet(options?: {
     storagePath?: string;
@@ -170,61 +170,61 @@ declare function loadWallet(options?: {
     error?: string;
 };
 /**
- * 获取钱包地址（不需要密码）
+ * Get wallet address (no password required)
  */
 declare function getWalletAddress(storagePath?: string): string | null;
 /**
- * 检查钱包是否存在
+ * Check if wallet exists
  */
 declare function walletExists(storagePath?: string): boolean;
 
 /**
- * PermitWallet - 使用 Boss 授权的 Permit 进行支付
+ * PermitWallet - Pay using Boss's Permit authorization
  *
- * 场景：
- * - Agent 没有自己的 USDC，但 Boss 给了 Permit 授权
- * - Agent 使用 Permit 签名 + 自己的钱包执行 transferFrom
- * - Agent 只需要少量 ETH 付 gas，USDC 从 Boss 钱包扣除
+ * Scenario:
+ * - Agent doesn't have USDC, but Boss gave a Permit authorization
+ * - Agent uses Permit signature + own wallet to execute transferFrom
+ * - Agent only needs small amount of ETH for gas, USDC is deducted from Boss's wallet
  */
 
 interface PermitData {
-    /** Boss 的钱包地址（USDC 持有者） */
+    /** Boss's wallet address (USDC holder) */
     owner: string;
-    /** Agent 的钱包地址（被授权者） */
+    /** Agent's wallet address (authorized spender) */
     spender: string;
-    /** 授权金额（USDC，6位小数的原始值） */
+    /** Authorized amount (USDC, raw 6 decimal value) */
     value: string;
-    /** 过期时间戳 */
+    /** Expiration timestamp */
     deadline: number;
-    /** 签名 v */
+    /** Signature v */
     v: number;
-    /** 签名 r */
+    /** Signature r */
     r: string;
-    /** 签名 s */
+    /** Signature s */
     s: string;
 }
 interface PermitWalletConfig {
     chain?: ChainName;
-    /** Agent 的私钥（用于执行交易） */
+    /** Agent's private key (for executing transactions) */
     privateKey?: string;
-    /** 从文件加载私钥 */
+    /** Load private key from file */
     walletPath?: string;
-    /** 解密密码 */
+    /** Decryption password */
     walletPassword?: string;
     rpcUrl?: string;
 }
 interface TransferWithPermitParams {
-    /** 收款地址 */
+    /** Recipient address */
     to: string;
-    /** 金额（USDC） */
+    /** Amount (USDC) */
     amount: number;
-    /** Boss 签署的 Permit 数据 */
+    /** Boss-signed Permit data */
     permit: PermitData;
 }
 interface TransferWithPermitResult extends TransferResult {
-    /** Permit 交易 hash */
+    /** Permit transaction hash */
     permitTxHash?: string;
-    /** Transfer 交易 hash */
+    /** Transfer transaction hash */
     transferTxHash?: string;
 }
 declare class PermitWallet {
@@ -236,21 +236,21 @@ declare class PermitWallet {
     private usdcContract;
     constructor(config?: PermitWalletConfig);
     /**
-     * 检查 Permit 是否有效
+     * Check if Permit is valid (current allowance)
      */
     checkPermitAllowance(owner: string): Promise<string>;
     /**
-     * 使用 Permit 授权进行支付
+     * Pay using Permit authorization
      *
-     * 流程：
-     * 1. 调用 permit() 让合约记录 Boss 的授权
-     * 2. 调用 transferFrom() 从 Boss 钱包转账到收款方
+     * Flow:
+     * 1. Call permit() to record Boss's authorization in the contract
+     * 2. Call transferFrom() to transfer from Boss's wallet to recipient
      *
      * @example
      * ```typescript
      * const wallet = new PermitWallet({ chain: 'base' });
      *
-     * // Boss 签署的 permit 数据
+     * // Boss-signed permit data
      * const permit = {
      *   owner: '0xBOSS...',
      *   spender: wallet.address,
@@ -270,16 +270,16 @@ declare class PermitWallet {
      */
     transferWithPermit(params: TransferWithPermitParams): Promise<TransferWithPermitResult>;
     /**
-     * 获取 ETH 余额（用于支付 gas）
+     * Get ETH balance (for gas)
      */
     getGasBalance(): Promise<string>;
     /**
-     * 检查是否有足够的 gas
+     * Check if there's enough gas
      */
     hasEnoughGas(minEth?: number): Promise<boolean>;
 }
 /**
- * 格式化 Permit 请求消息（发给 Boss）
+ * Format Permit request message (to send to Boss)
  */
 declare function formatPermitRequest(params: {
     agentAddress: string;

package/dist/wallet/index.js

@@ -773,24 +773,24 @@ var PermitWallet = class {
     );
   }
   /**
-   * 检查 Permit 是否有效
+   * Check if Permit is valid (current allowance)
    */
   async checkPermitAllowance(owner) {
     const allowance = await this.usdcContract.allowance(owner, this.address);
     return (Number(allowance) / 1e6).toFixed(2);
   }
   /**
-   * 使用 Permit 授权进行支付
+   * Pay using Permit authorization
    * 
-   * 流程：
-   * 1. 调用 permit() 让合约记录 Boss 的授权
-   * 2. 调用 transferFrom() 从 Boss 钱包转账到收款方
+   * Flow:
+   * 1. Call permit() to record Boss's authorization in the contract
+   * 2. Call transferFrom() to transfer from Boss's wallet to recipient
    * 
    * @example
    * ```typescript
    * const wallet = new PermitWallet({ chain: 'base' });
    * 
-   * // Boss 签署的 permit 数据
+   * // Boss-signed permit data
    * const permit = {
    *   owner: '0xBOSS...',
    *   spender: wallet.address,
@@ -913,14 +913,14 @@ var PermitWallet = class {
     }
   }
   /**
-   * 获取 ETH 余额（用于支付 gas）
+   * Get ETH balance (for gas)
    */
   async getGasBalance() {
     const balance = await this.provider.getBalance(this.address);
     return import_ethers3.ethers.formatEther(balance);
   }
   /**
-   * 检查是否有足够的 gas
+   * Check if there's enough gas
    */
   async hasEnoughGas(minEth = 1e-3) {
     const balance = await this.getGasBalance();
@@ -932,17 +932,17 @@ function formatPermitRequest(params) {
   const chainConfig = getChain(chain);
   const deadline = Math.floor(Date.now() / 1e3) + deadlineHours * 3600;
   const value = BigInt(Math.floor(amount * 1e6)).toString();
-  return `\u{1F510} **USDC \u652F\u4ED8\u989D\u5EA6\u6388\u6743\u8BF7\u6C42**
+  return `\u{1F510} **USDC Spending Allowance Request**
 
-${reason ? `**\u7528\u9014:** ${reason}
+${reason ? `**Purpose:** ${reason}
 ` : ""}
-**\u6388\u6743\u8BE6\u60C5:**
-- \u88AB\u6388\u6743\u5730\u5740 (Agent): \`${agentAddress}\`
-- \u6388\u6743\u91D1\u989D: ${amount} USDC
-- \u6709\u6548\u671F: ${deadlineHours} \u5C0F\u65F6
-- \u94FE: ${chainConfig.name}
+**Authorization Details:**
+- Authorized address (Agent): \`${agentAddress}\`
+- Amount: ${amount} USDC
+- Valid for: ${deadlineHours} hours
+- Chain: ${chainConfig.name}
 
-**\u8BF7\u4F7F\u7528\u94B1\u5305\u7B7E\u7F72\u4EE5\u4E0B EIP-2612 Permit:**
+**Please sign the following EIP-2612 Permit with your wallet:**
 
 \`\`\`json
 {
@@ -972,9 +972,9 @@ ${reason ? `**\u7528\u9014:** ${reason}
 }
 \`\`\`
 
-\u7B7E\u540D\u540E\uFF0C\u8BF7\u5C06 { v, r, s, deadline } \u53D1\u7ED9 Agent\u3002
+After signing, send { v, r, s, deadline } to the Agent.
 
-\u26A0\uFE0F \u6CE8\u610F\uFF1A\u6B64\u6388\u6743\u4EC5\u5141\u8BB8 Agent \u4ECE\u60A8\u7684\u94B1\u5305\u652F\u4ED8\u6700\u591A ${amount} USDC\uFF0C\u4E0D\u4F1A\u6CC4\u9732\u79C1\u94A5\u3002`;
+\u26A0\uFE0F Note: This authorization only allows the Agent to spend up to ${amount} USDC from your wallet. Your private key is never exposed.`;
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {