gokite-aa-sdk 1.0.2 → 1.0.3

package/README.md

@@ -18,7 +18,7 @@ import { ethers } from 'ethers';
 const sdk = new GokiteAASDK(
   'kite_testnet',
   'https://rpc-testnet.gokite.ai',
-  'https://bundler-service.staging.gokite.ai/rpc/' // bundler URL
+  'http://localhost:14337/rpc/' // bundler URL
 );
 
 // Owner address (from your social login SDK)

package/dist/example.d.ts

@@ -1,47 +1,181 @@
 import { GokiteAASDK } from './gokite-aa-sdk';
 import "dotenv/config";
+declare function initializeSDK(): GokiteAASDK;
 declare function handleAAError(error: any): {
     type: string;
     message: string;
     details?: any;
 };
 /**
- * ClientAgentVault Integration Tests
+ * Transfer ERC20 tokens from AA wallet to another address
+ * 从AA钱包转账ERC20代币到其他地址
  *
- * these tests show how to use the AA wallet to:
- * 1. deploy the ClientAgentVault proxy contract (via performCreate)
- * 2. configure spending rules (Spending Rules)
- * 3. view spending rules (read-only)
- * 4. withdraw funds (withdrawFunds)
- * 5. check token balance (read-only)
+ * @param eoa - User's EOA address (from Privy)
+ * @param to - Recipient address
+ * @param amount - Amount to transfer
+ * @param tokenAddress - Token contract address
+ * @param tokenDecimals - Token decimals (usually 18)
+ * @param signFunction - Signing function from Privy
+ */
+export declare function transferERC20(eoa: string, to: string, amount: string, tokenAddress: string, tokenDecimals: number | undefined, signFunction: (userOpHash: string) => Promise<string>): Promise<{
+    success: boolean;
+    transactionHash: string | undefined;
+    message: string;
+    error?: undefined;
+} | {
+    success: boolean;
+    error: string | undefined;
+    message: string;
+    transactionHash?: undefined;
+} | {
+    success: boolean;
+    error: {
+        type: string;
+        message: string;
+        details?: any;
+    };
+    message: string;
+    transactionHash?: undefined;
+}>;
+/**
+ * 部署KitePass合约
  *
- * how to use:
- * - modify the contract addresses and parameters as needed
+ * @param eoa - User's EOA address
+ * @param signFunction - Signing function from Privy
+ * @returns Deployed KitePass address
  */
-declare function clientAgentVaultIntegrationTests(): Promise<void>;
+export declare function deployKitePass(eoa: string, signFunction: (userOpHash: string) => Promise<string>): Promise<{
+    success: boolean;
+    proxyAddress?: string;
+    error?: any;
+}>;
 /**
- * Test 1: Deploy ClientAgentVault Proxy via AA wallet's performCreate
+ * Configure spending rules for KitePass
+ *  setSpendingRules方法会先清除现有的rules，然后设置新的rules
+ * 1. 新增/修改：需要先获取现有的rules，然后append新的rules，或者在现有rules的基础上修改
+ * 2. 删除：需要先获取现有的rules，然后删除对应的rules
+ *
+ * @param eoa - User's EOA address
+ * @param kitepassAddress - KitePass proxy address
+ * @param rules - Spending rules to configure
+ * @param signFunction - Signing function
+ */
+export declare function configureSpendingRules(eoa: string, kitepassAddress: string, signFunction: (userOpHash: string) => Promise<string>): Promise<{
+    success: boolean;
+    transactionHash: string | undefined;
+    error?: undefined;
+} | {
+    success: boolean;
+    error: string | undefined;
+    transactionHash?: undefined;
+} | {
+    success: boolean;
+    error: {
+        type: string;
+        message: string;
+        details?: any;
+    };
+    transactionHash?: undefined;
+}>;
+/**
+ * View current spending rules (read-only)
+ * 查看当前消费规则（只读）
  */
-declare function DeployClientAgentVaultProxy(sdk: GokiteAASDK, eoa: string, aa: string, signFunction: any): Promise<string | null>;
+export declare function viewSpendingRules(kitepassAddress: string): Promise<{
+    success: boolean;
+    rules: any;
+    error?: undefined;
+} | {
+    success: boolean;
+    error: string;
+    rules?: undefined;
+}>;
 /**
- * Test 2: Configure Spending Rules
+ * Withdraw funds from KitePass
+ * 从KitePass提取资金
  */
-declare function ConfigureSpendingRules(sdk: GokiteAASDK, owner: string, proxyAddress: string, signFunction: any): Promise<void>;
+export declare function withdrawFunds(eoa: string, kitepassAddress: string, amount: string, tokenAddress: string | undefined, signFunction: (userOpHash: string) => Promise<string>): Promise<{
+    success: boolean;
+    transactionHash: string | undefined;
+    error?: undefined;
+} | {
+    success: boolean;
+    error: string | undefined;
+    transactionHash?: undefined;
+} | {
+    success: boolean;
+    error: {
+        type: string;
+        message: string;
+        details?: any;
+    };
+    transactionHash?: undefined;
+}>;
 /**
- * Test 3: View Spending Rules (Read-only, no transaction sent)
+ * Check token balance (read-only)
+ * 查看代币余额（只读）
  */
-declare function ViewSpendingRules(sdk: GokiteAASDK, proxyAddress: string): Promise<void>;
+export declare function checkTokenBalance(address: string, tokenAddress?: string): Promise<{
+    success: boolean;
+    balance: string;
+    symbol: any;
+    decimals: any;
+    address: string;
+    error?: undefined;
+} | {
+    success: boolean;
+    error: string;
+    balance?: undefined;
+    symbol?: undefined;
+    decimals?: undefined;
+    address?: undefined;
+}>;
+export interface ServiceInfo {
+    serviceOwner: string;
+    priceModel: number;
+    unitPrice: number;
+    provider: string;
+    metadata: string;
+    name: string;
+    isPublic: boolean;
+}
 /**
- * Test 4: Withdraw Funds
+ * Register a service in the service registry
+ * 在服务注册表中注册服务
+ *
+ * @param eoa - Service owner's EOA address
+ * @param serviceId - Service ID (bytes32)
+ * @param serviceInfo - Service information
+ * @param signFunction - Signing function
  */
-declare function WithdrawFunds(sdk: GokiteAASDK, owner: string, proxyAddress: string, signFunction: any): Promise<void>;
+export declare function registerService(eoa: string, serviceId: string, serviceInfo: ServiceInfo, signFunction: (userOpHash: string) => Promise<string>): Promise<{
+    success: boolean;
+    transactionHash: string | undefined;
+    serviceId: string;
+    error?: undefined;
+} | {
+    success: boolean;
+    error: string | undefined;
+    transactionHash?: undefined;
+    serviceId?: undefined;
+} | {
+    success: boolean;
+    error: {
+        type: string;
+        message: string;
+        details?: any;
+    };
+    transactionHash?: undefined;
+    serviceId?: undefined;
+}>;
 /**
- * Test 5: Check Token Balance (Read-only)
+ * Get TransparentUpgradeableProxy bytecode
+ * 获取透明可升级代理字节码
  */
-declare function CheckTokenBalance(sdk: GokiteAASDK, proxyAddress: string): Promise<void>;
+declare function getTransparentProxyBytecode(): string;
 /**
- * Legacy example for basic AA operations
+ * Parse ContractCreated event from transaction logs
+ * 从交易日志中解析合约创建事件
  */
-declare function basicExample(): Promise<void>;
-export { clientAgentVaultIntegrationTests, basicExample, DeployClientAgentVaultProxy, ConfigureSpendingRules, ViewSpendingRules, WithdrawFunds, CheckTokenBalance, handleAAError, };
-export declare const example: typeof basicExample;
+declare function parseContractCreatedEvent(transactionHash: string): Promise<string | null>;
+export { initializeSDK, handleAAError, getTransparentProxyBytecode, parseContractCreatedEvent };