anchor-sdk 0.1.36

package/dist/index.d.ts

@@ -0,0 +1,341 @@
+import { Address, type TransactionReceipt } from "viem";
+import { AnchorPayClient } from "./AnchorPayClient";
+import { AnchorERC1155Client } from "./AnchorERC1155Client";
+import { AnchorApiClientV2 } from "./AnchorApiClientV2";
+import { AnchorSDKConfig, PaymentOptions, SignedMintRequest } from "./types";
+/**
+ * Anchor SDK
+ * 用于与 AnchorPay 和 AnchorERC1155 合约交互的 SDK
+ */
+export declare class AnchorSDK {
+    private publicClient;
+    private walletClient?;
+    private account?;
+    private network;
+    private config;
+    /** Anchor 合约地址 */
+    private contracts;
+    /** AnchorPay 客户端 */
+    anchorPay: AnchorPayClient;
+    /** AnchorERC1155 客户端 */
+    anchorERC1155: AnchorERC1155Client;
+    /** Anchor API 客户端 */
+    anchorApi?: AnchorApiClientV2;
+    /**
+     * 创建 Anchor SDK 实例
+     * @param config SDK 配置
+     */
+    constructor(config: AnchorSDKConfig);
+    /**
+     * 设置 Token 过期回调
+     * @param callback Token 过期回调函数
+     */
+    setTokenExpiredCallback(callback: (error: Error) => void): void;
+    /**
+     * 设置钱包客户端
+     * 在 SDK 初始化后动态更新钱包客户端和账户
+     * @param walletClient 新的钱包客户端
+     */
+    setWalletClient(signerOrWalletClient: any): this;
+    /**
+     * 初始化公共客户端
+     * @param provider 提供者（URL或Web3提供者）
+     * @returns 公共客户端
+     */
+    private initializePublicClient;
+    /**
+     * 初始化钱包客户端
+     * @param signer 签名者
+     * @returns 钱包客户端
+     */
+    private initializeWalletClient;
+    /**
+     * 从签名者获取账户
+     * @param signer 签名者
+     * @returns 账户
+     */
+    private getAccountFromSigner;
+    /**
+     * 从网络信息创建Chain对象
+     * @param network 网络信息
+     * @returns Chain对象
+     */
+    private createChainFromNetwork;
+    /**
+     * 购买 Badge（使用 ETH，直接使用签名请求）
+     * @param signedRequest 签名铸造请求
+     * @param receiptAddress 接收地址，如果提供，将作为 ERC20 转账的接收地址使用
+     * @param options 支付选项
+     * @returns 如果直接发送交易，返回交易收据；否则返回交易数据
+     */
+    buyBadgeWithETHWithSignedRequest(signedRequest: SignedMintRequest, receiptAddress: string, options?: PaymentOptions): Promise<TransactionReceipt | {
+        to: string;
+        data: string;
+        value: bigint;
+    }>;
+    /**
+     * 购买 Badge（使用 ERC20 代币，直接使用签名请求）
+     * @param signedRequest 签名铸造请求
+     * @param receiptAddress 接收地址，如果提供，将作为接收地址使用
+     * @param options 支付选项
+     * @returns 如果直接发送交易，返回交易收据；否则返回交易数据
+     */
+    buyBadgeWithERC20WithSignedRequest(signedRequest: SignedMintRequest, receiptAddress: string, options?: PaymentOptions): Promise<TransactionReceipt | {
+        to: string;
+        data: string;
+        value: bigint;
+    }>;
+    /**
+     * 使用 ETH 购买徽章
+     * @param customerAddress 客户地址
+     * @param contractAddress NFT 地址
+     * @param tokenId 代币 ID
+     * @param quantity 数量
+     * @param receiptAddress 接收地址，如果提供，将作为接收地址使用
+     * @param options 支付选项
+     * @returns 如果直接发送交易，返回交易收据；否则返回交易数据
+     */
+    buyBadgeWithETH(customerAddress: string, contractAddress: string, tokenId: string | number | bigint, quantity: string | number | bigint | undefined, receiptAddress: string, options?: PaymentOptions): Promise<TransactionReceipt | {
+        to: string;
+        data: string;
+        value: bigint;
+    }>;
+    /**
+     * 使用自定义签名数据购买徽章（ETH）
+     * @param signedRequest 用户自己组装的签名铸造请求
+     * @param receiptAddress 接收地址，如果提供，将作为接收地址使用
+     * @param options 支付选项
+     * @returns 如果直接发送交易，返回交易收据；否则返回交易数据
+     */
+    buyBadgeWithETHWithCustomSignature(signedRequest: {
+        to: string;
+        tokenId: string | number | bigint;
+        quantity: string | number | bigint;
+        price: string | number | bigint;
+        currency?: string;
+        validityEndTimestamp?: string | number | bigint;
+        validityStartTimestamp?: string | number | bigint;
+        uid: string;
+        signature: string;
+        chainId?: string;
+        projectHandle?: string;
+    }, receiptAddress: string, options?: PaymentOptions): Promise<TransactionReceipt | {
+        to: string;
+        data: string;
+        value: bigint;
+    }>;
+    /**
+     * 使用 ERC20 代币购买徽章
+     * @param customerAddress 客户地址
+     * @param contractAddress NFT 地址
+     * @param tokenId 代币 ID
+     * @param quantity 数量
+     * @param currency ERC20 代币地址
+     * @param receiptAddress 接收地址，如果提供，将作为接收地址使用
+     * @param options 支付选项
+     * @returns 如果直接发送交易，返回交易收据；否则返回交易数据
+     */
+    buyBadgeWithERC20(customerAddress: string, contractAddress: string, tokenId: string | number | bigint, quantity: string | number | bigint | undefined, currency: string, receiptAddress: string, options?: PaymentOptions): Promise<TransactionReceipt | {
+        to: string;
+        data: string;
+        value: bigint;
+    }>;
+    /**
+     * 使用自定义签名数据购买徽章（ERC20）
+     * @param signedRequest 用户自己组装的签名铸造请求
+     * @param receiptAddress 接收地址，如果提供，将作为 ERC20 转账的接收地址使用
+     * @param options 支付选项
+     * @returns 如果直接发送交易，返回交易收据；否则返回交易数据
+     */
+    buyBadgeWithERC20WithCustomSignature(signedRequest: {
+        to: string;
+        tokenId: string | number | bigint;
+        quantity: string | number | bigint;
+        price: string | number | bigint;
+        currency?: string;
+        validityEndTimestamp?: string | number | bigint;
+        validityStartTimestamp?: string | number | bigint;
+        uid: string;
+        signature: string;
+        chainId?: string;
+        projectHandle?: string;
+    }, receiptAddress: string, options?: PaymentOptions): Promise<TransactionReceipt | {
+        to: string;
+        data: string;
+        value: bigint;
+    }>;
+    /**
+     * 支付方法，使用 ETH 进行支付
+     * @deprecated 请使用 sendPayment 方法代替。sendPayment 提供了更灵活的支付选项和更好的类型支持。
+     * @param orderId 订单 ID
+     * @param amount 支付金额
+     * @param receiptAddress 接收地址，如果提供，将作为接收地址使用
+     * @param options 支付选项
+     * @returns 如果直接发送交易，返回交易收据；否则返回交易数据
+     */
+    pay(orderId: string, amount: string | number | bigint, receiptAddress: string, options?: PaymentOptions): Promise<TransactionReceipt | {
+        to: string;
+        data: string;
+        value: bigint;
+    }>;
+    /**
+     * 支付方法，使用 ETH 进行支付
+     * @param params 支付参数
+     * @param params.callData 自定义数据
+     * @param params.amount 支付金额
+     * @param params.receiptAddress 接收地址
+     * @param params.contractName 合约名称（可选）
+     * @param params.options 支付选项（可选）
+     * @returns 如果直接发送交易，返回交易收据；否则返回交易数据
+     */
+    sendPaymentWithNativeToken(params: {
+        callData: `0x${string}`;
+        amount: string | number | bigint;
+        receiptAddress: string;
+        contractName?: string;
+        options?: PaymentOptions;
+    }): Promise<TransactionReceipt | {
+        to: string;
+        data: string;
+        value: bigint;
+    }>;
+    /**
+     * 支付方法，使用 ERC20 代币进行支付
+     * @param params 支付参数
+     * @param params.callData 自定义数据
+     * @param params.amount 支付金额
+     * @param params.receiptAddress 接收地址
+     * @param params.tokenAddress ERC20 代币地址
+     * @param params.contractName 合约名称（可选）
+     * @param params.options 支付选项（可选）
+     * @returns 如果直接发送交易，返回交易收据；否则返回交易数据数组
+     */
+    sendPaymentWithERC20(params: {
+        callData: `0x${string}`;
+        amount: string | number | bigint;
+        receiptAddress: string;
+        tokenAddress: string;
+        contractName?: string;
+        options?: PaymentOptions;
+    }): Promise<TransactionReceipt | {
+        to: string;
+        data: string;
+        value: bigint;
+    }>;
+    /**
+     * 编码用户数据
+     * @param orderId 订单 ID
+     * @returns 编码后的数据
+     */
+    private encodeUserData;
+    /**
+     * 铸造免费 Badge
+     * 从后端获取签名铸造请求，然后调用合约铸造
+     * @param customerAddress 客户地址
+     * @param contractAddress NFT 地址
+     * @param tokenIds badge 的 tokenId 数组
+     * @param options 选项，可以控制是否直接发送交易
+     * @returns 如果直接发送交易，返回交易收据；否则返回交易数据
+     */
+    mintFreeBadge(customerAddress: string, contractAddress: string, tokenIds: string[], options?: {
+        sendTransaction?: boolean;
+    }): Promise<TransactionReceipt | {
+        to: string;
+        data: string;
+        value: bigint;
+    } | {
+        to: string;
+        data: string;
+        value: bigint;
+    }[]>;
+    /**
+     * 铸造免费 Badge（直接使用签名请求）
+     * @param signedRequest 签名铸造请求
+     * @param options 选项，可以控制是否直接发送交易
+     * @returns 如果直接发送交易，返回交易收据；否则返回交易数据
+     */
+    mintFreeBadgeWithSignedRequest(signedRequest: SignedMintRequest, options?: {
+        sendTransaction?: boolean;
+    }): Promise<TransactionReceipt | {
+        to: string;
+        data: string;
+        value: bigint;
+    }>;
+    /**
+     * 获取 ERC20 代币批准的交易数据（用于 AA 模式）
+     * @param tokenAddress ERC20 代币地址
+     * @param amount 批准金额
+     * @param spender 花费者地址（默认为 AnchorPay 合约地址）
+     * @returns 交易数据对象，包含 to、data 和 value 字段
+     */
+    getERC20ApprovalData(tokenAddress: Address, amount: bigint, spender?: Address): {
+        to: string;
+        data: string;
+        value: bigint;
+    };
+    /**
+     * 验证铸造请求
+     * @param request 铸造请求
+     */
+    private validateMintRequest;
+    /**
+     * 处理交易哈希
+     * 在交易确认后调用该方法可加快交易处理
+     * @param txHash 交易哈希
+     * @returns 处理结果或 undefined（如果 API 客户端不可用）
+     */
+    processTransactionHash(txHash: string): Promise<import("./generated/Api").WebResultTransactionHashProcess | undefined>;
+    /**
+     * 批量铸造徽章（V2）
+     * @param customerAddress 客户地址
+     * @param contractAddress NFT 合约地址
+     * @param tokenIds 代币 ID 列表
+     * @param options 选项，可以控制是否直接发送交易
+     * @returns 如果直接发送交易，返回最后一个交易收据；AA 模式返回所有交易数据数组
+     */
+    batchMintBadge(customerAddress: string, contractAddress: string, tokenIds: string[], options?: {
+        sendTransaction?: boolean;
+    }): Promise<TransactionReceipt | {
+        to: string;
+        data: string;
+        value: bigint;
+    }[]>;
+    /**
+     * 批量铸造徽章（Multicall V2）
+     * @param customerAddress 客户地址
+     * @param contractAddress NFT 合约地址
+     * @param tokenIds 代币 ID 列表
+     * @param options 选项，可以控制是否直接发送交易
+     * @returns 如果直接发送交易，返回交易收据；AA 模式返回 multicall 交易数据
+     */
+    batchMintBadgeWithMulticall(customerAddress: string, contractAddress: string, tokenIds: string[], options?: {
+        sendTransaction?: boolean;
+    }): Promise<TransactionReceipt | {
+        to: string;
+        data: string;
+        value: bigint;
+    }>;
+    /**
+     * 批量铸造免费徽章（Multicall）
+     * 从后端获取签名铸造请求，然后使用 multicall 批量铸造
+     * @param customerAddress 客户地址
+     * @param contractAddress NFT 合约地址
+     * @param tokenIds badge 的 tokenId 数组
+     * @param options 选项，可以控制是否直接发送交易
+     * @returns 如果直接发送交易，返回交易收据；AA 模式返回 multicall 交易数据
+     */
+    mintFreeBadgeWithMulticall(customerAddress: string, contractAddress: string, tokenIds: string[], options?: {
+        sendTransaction?: boolean;
+    }): Promise<TransactionReceipt | {
+        to: string;
+        data: string;
+        value: bigint;
+    }>;
+}
+export * from "./types";
+export * from "./constants";
+export { AnchorPayClient } from "./AnchorPayClient";
+export { AnchorApiClientV2 } from "./AnchorApiClientV2";
+export { AnchorERC1155Client } from "./AnchorERC1155Client";
+export * from "./react";
+export * from "./generated/Api";