@1llet.xyz/erc4337-gasless-sdk 0.2.0 → 0.4.1

package/README.md

@@ -17,20 +17,14 @@ yarn add @1llet.xyz/erc4337-gasless-sdk viem
 Define the chain configuration (including your Bundler URL and Paymaster).
 
 ```typescript
-import { type ChainConfig } from "@1llet.xyz/erc4337-gasless-sdk";
-import { baseSepolia } from "viem/chains";
-
-const config: ChainConfig = {
-  chain: baseSepolia,
-  // Your Bundler URL (must support ERC-4337 methods)
-  bundlerUrl: "https://api.yourbundler.com/rpc", 
-  // Optional: Override RPC URL (defaults to chain.rpcUrls.default)
-  // rpcUrl: "https://sepolia.base.org",
-  
-  // Addresses are automatically resolved for supported chains (Base, Base Sepolia)
-  // You can override them if needed:
-  // factoryAddress: "0x...", 
-};
+// 1. Import Config (Chain Registry)
+import { BASE_SEPOLIA, type ChainConfig } from "@1llet.xyz/erc4337-gasless-sdk";
+import { AccountAbstraction } from "@1llet.xyz/erc4337-gasless-sdk";
+
+// 2. Initialize
+const aa = new AccountAbstraction(BASE_SEPOLIA);
+
+await aa.connect();
 ```
 
 ### 2. Initialize & Connect
@@ -163,14 +157,31 @@ const receipt = await aa.sendBatchTransaction([
 ]);
 
 // 3. Transfer ERC-20 Tokens (Helper)
-// Automatically encodes the transfer call
-const receipt = await aa.transfer(
-    usdcAddress, 
-    recipientAddress, 
-    1000000n // 1 USDC
-);
+// Automatically encodes the
+// 1. Transfer ERC-20 (USDC)
+await aa.transfer("USDC", recipient, amount);
+
+// 2. Transfer Native Token (ETH)
+// The SDK detects the "ETH" symbol and sends a native transaction
+await aa.transfer("ETH", recipient, amount);
+```
+
+// 2. Transfer Native Token (ETH)
+// The SDK detects the "ETH" symbol and sends a native transaction
+await aa.transfer("ETH", recipient, amount);
 ```
 
+### Funding the Account
+
+Easily deposit ETH from the connected wallet (EOA) to the Smart Account.
+
+```typescript
+// Deposit 0.1 ETH
+const txHash = await aa.deposit(100000000000000000n);
+```
+
+### High-Level Methods
+
 ### Error Decoding
 The SDK now automatically tries to decode cryptic "0x..." errors from the EntryPoint into readable messages like:
 - `Smart Account Error: Transfer amount exceeds balance`

package/dist/index.d.mts

@@ -0,0 +1,275 @@
+import { Chain, Address, Hash, Hex } from 'viem';
+
+interface Token {
+    symbol: string;
+    decimals: number;
+    address: Address;
+}
+interface ChainConfig {
+    chain: Chain;
+    rpcUrl?: string;
+    bundlerUrl: string;
+    entryPointAddress?: Address;
+    factoryAddress?: Address;
+    paymasterAddress?: Address;
+    tokens: Token[];
+}
+interface UserOperation {
+    sender: Address;
+    nonce: bigint;
+    initCode: Hex;
+    callData: Hex;
+    callGasLimit: bigint;
+    verificationGasLimit: bigint;
+    preVerificationGas: bigint;
+    maxFeePerGas: bigint;
+    maxPriorityFeePerGas: bigint;
+    paymasterAndData: Hex;
+    signature: Hex;
+}
+interface GasEstimate {
+    callGasLimit: string;
+    verificationGasLimit: string;
+    preVerificationGas: string;
+    maxFeePerGas: string;
+    maxPriorityFeePerGas: string;
+}
+interface UserOpReceipt {
+    userOpHash: Hash;
+    sender: Address;
+    success: boolean;
+    actualGasCost: string;
+    receipt: {
+        transactionHash: Hash;
+        blockNumber: string;
+    };
+}
+interface ApprovalSupportResult {
+    type: "permit" | "approve" | "none";
+    gasCost?: string;
+    fundingNeeded?: string;
+    fundedAmount?: string;
+}
+
+/**
+ * ERC-4337 Account Abstraction Client
+ */
+declare class AccountAbstraction {
+    private owner;
+    private smartAccountAddress;
+    private chainConfig;
+    private publicClient;
+    private bundlerClient;
+    private tokenService;
+    private userOpBuilder;
+    private entryPointAddress;
+    private factoryAddress;
+    constructor(chainConfig: ChainConfig);
+    /**
+     * Connect to MetaMask and get the owner address
+     */
+    connect(): Promise<{
+        owner: Address;
+        smartAccount: Address;
+    }>;
+    /**
+     * Get the Smart Account address for an owner
+     */
+    getSmartAccountAddress(owner: Address): Promise<Address>;
+    /**
+     * Check if the Smart Account is deployed
+     */
+    isAccountDeployed(): Promise<boolean>;
+    getTokenAddress(token: string | Address): Address;
+    getUsdcBalance(): Promise<bigint>;
+    getEoaUsdcBalance(): Promise<bigint>;
+    getAllowance(): Promise<bigint>;
+    deployAccount(): Promise<UserOpReceipt>;
+    sendTransaction(tx: {
+        target: Address;
+        value?: bigint;
+        data?: Hex;
+    }): Promise<UserOpReceipt>;
+    sendBatchTransaction(txs: {
+        target: Address;
+        value?: bigint;
+        data?: Hex;
+    }[]): Promise<UserOpReceipt>;
+    deposit(amount: bigint): Promise<Hash>;
+    transfer(token: Address | string, recipient: Address, amount: bigint): Promise<UserOpReceipt>;
+    /**
+     * Approve a token for the Smart Account
+     */
+    approveToken(token: Address, spender: Address, amount?: bigint): Promise<Hash | "NOT_NEEDED">;
+    buildUserOperationBatch(transactions: any[]): Promise<UserOperation>;
+    signUserOperation(userOp: UserOperation): Promise<UserOperation>;
+    sendUserOperation(userOp: UserOperation): Promise<Hash>;
+    waitForUserOperation(hash: Hash, timeout?: number): Promise<UserOpReceipt>;
+    requestApprovalSupport(token: Address, spender: Address, amount: bigint): Promise<ApprovalSupportResult>;
+    private decodeError;
+    getOwner(): `0x${string}` | null;
+    getSmartAccount(): `0x${string}` | null;
+}
+declare global {
+    interface Window {
+        ethereum?: {
+            request: (args: {
+                method: string;
+                params?: unknown[];
+            }) => Promise<unknown>;
+            on: (event: string, callback: (args: unknown) => void) => void;
+            removeListener: (event: string, callback: (args: unknown) => void) => void;
+        };
+    }
+}
+
+declare class BundlerClient {
+    private bundlerUrl;
+    private chainId;
+    private entryPointAddress;
+    constructor(config: ChainConfig, entryPointAddress: Address);
+    private call;
+    estimateGas(userOp: Partial<UserOperation>): Promise<GasEstimate>;
+    sendUserOperation(userOp: UserOperation): Promise<Hash>;
+    waitForUserOperation(userOpHash: Hash, timeout?: number): Promise<UserOpReceipt>;
+    requestApprovalSupport(token: Address, owner: Address, spender: Address, amount: bigint): Promise<ApprovalSupportResult>;
+}
+
+declare const BASE_MAINNET: ChainConfig;
+declare const BASE_SEPOLIA: ChainConfig;
+declare const CHAIN_CONFIGS: Record<number, ChainConfig>;
+
+declare const entryPointAbi: readonly [{
+    readonly inputs: readonly [{
+        readonly name: "sender";
+        readonly type: "address";
+    }, {
+        readonly name: "key";
+        readonly type: "uint192";
+    }];
+    readonly name: "getNonce";
+    readonly outputs: readonly [{
+        readonly name: "nonce";
+        readonly type: "uint256";
+    }];
+    readonly stateMutability: "view";
+    readonly type: "function";
+}];
+declare const smartAccountAbi: readonly [{
+    readonly inputs: readonly [{
+        readonly name: "target";
+        readonly type: "address";
+    }, {
+        readonly name: "value";
+        readonly type: "uint256";
+    }, {
+        readonly name: "data";
+        readonly type: "bytes";
+    }];
+    readonly name: "execute";
+    readonly outputs: readonly [];
+    readonly stateMutability: "nonpayable";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [{
+        readonly name: "targets";
+        readonly type: "address[]";
+    }, {
+        readonly name: "values";
+        readonly type: "uint256[]";
+    }, {
+        readonly name: "datas";
+        readonly type: "bytes[]";
+    }];
+    readonly name: "executeBatch";
+    readonly outputs: readonly [];
+    readonly stateMutability: "nonpayable";
+    readonly type: "function";
+}];
+declare const erc20Abi: readonly [{
+    readonly inputs: readonly [{
+        readonly name: "account";
+        readonly type: "address";
+    }];
+    readonly name: "balanceOf";
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint256";
+    }];
+    readonly stateMutability: "view";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [{
+        readonly name: "to";
+        readonly type: "address";
+    }, {
+        readonly name: "amount";
+        readonly type: "uint256";
+    }];
+    readonly name: "transfer";
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "bool";
+    }];
+    readonly stateMutability: "nonpayable";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [{
+        readonly name: "spender";
+        readonly type: "address";
+    }, {
+        readonly name: "amount";
+        readonly type: "uint256";
+    }];
+    readonly name: "approve";
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "bool";
+    }];
+    readonly stateMutability: "nonpayable";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [{
+        readonly name: "owner";
+        readonly type: "address";
+    }, {
+        readonly name: "spender";
+        readonly type: "address";
+    }];
+    readonly name: "allowance";
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint256";
+    }];
+    readonly stateMutability: "view";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [{
+        readonly name: "from";
+        readonly type: "address";
+    }, {
+        readonly name: "to";
+        readonly type: "address";
+    }, {
+        readonly name: "amount";
+        readonly type: "uint256";
+    }];
+    readonly name: "transferFrom";
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "bool";
+    }];
+    readonly stateMutability: "nonpayable";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [];
+    readonly name: "decimals";
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint8";
+    }];
+    readonly stateMutability: "view";
+    readonly type: "function";
+}];
+
+export { AccountAbstraction, BASE_MAINNET, BASE_SEPOLIA, BundlerClient, CHAIN_CONFIGS, type ChainConfig, type Token, type UserOpReceipt, type UserOperation, entryPointAbi, erc20Abi, smartAccountAbi };

package/dist/index.d.ts

@@ -0,0 +1,275 @@
+import { Chain, Address, Hash, Hex } from 'viem';
+
+interface Token {
+    symbol: string;
+    decimals: number;
+    address: Address;
+}
+interface ChainConfig {
+    chain: Chain;
+    rpcUrl?: string;
+    bundlerUrl: string;
+    entryPointAddress?: Address;
+    factoryAddress?: Address;
+    paymasterAddress?: Address;
+    tokens: Token[];
+}
+interface UserOperation {
+    sender: Address;
+    nonce: bigint;
+    initCode: Hex;
+    callData: Hex;
+    callGasLimit: bigint;
+    verificationGasLimit: bigint;
+    preVerificationGas: bigint;
+    maxFeePerGas: bigint;
+    maxPriorityFeePerGas: bigint;
+    paymasterAndData: Hex;
+    signature: Hex;
+}
+interface GasEstimate {
+    callGasLimit: string;
+    verificationGasLimit: string;
+    preVerificationGas: string;
+    maxFeePerGas: string;
+    maxPriorityFeePerGas: string;
+}
+interface UserOpReceipt {
+    userOpHash: Hash;
+    sender: Address;
+    success: boolean;
+    actualGasCost: string;
+    receipt: {
+        transactionHash: Hash;
+        blockNumber: string;
+    };
+}
+interface ApprovalSupportResult {
+    type: "permit" | "approve" | "none";
+    gasCost?: string;
+    fundingNeeded?: string;
+    fundedAmount?: string;
+}
+
+/**
+ * ERC-4337 Account Abstraction Client
+ */
+declare class AccountAbstraction {
+    private owner;
+    private smartAccountAddress;
+    private chainConfig;
+    private publicClient;
+    private bundlerClient;
+    private tokenService;
+    private userOpBuilder;
+    private entryPointAddress;
+    private factoryAddress;
+    constructor(chainConfig: ChainConfig);
+    /**
+     * Connect to MetaMask and get the owner address
+     */
+    connect(): Promise<{
+        owner: Address;
+        smartAccount: Address;
+    }>;
+    /**
+     * Get the Smart Account address for an owner
+     */
+    getSmartAccountAddress(owner: Address): Promise<Address>;
+    /**
+     * Check if the Smart Account is deployed
+     */
+    isAccountDeployed(): Promise<boolean>;
+    getTokenAddress(token: string | Address): Address;
+    getUsdcBalance(): Promise<bigint>;
+    getEoaUsdcBalance(): Promise<bigint>;
+    getAllowance(): Promise<bigint>;
+    deployAccount(): Promise<UserOpReceipt>;
+    sendTransaction(tx: {
+        target: Address;
+        value?: bigint;
+        data?: Hex;
+    }): Promise<UserOpReceipt>;
+    sendBatchTransaction(txs: {
+        target: Address;
+        value?: bigint;
+        data?: Hex;
+    }[]): Promise<UserOpReceipt>;
+    deposit(amount: bigint): Promise<Hash>;
+    transfer(token: Address | string, recipient: Address, amount: bigint): Promise<UserOpReceipt>;
+    /**
+     * Approve a token for the Smart Account
+     */
+    approveToken(token: Address, spender: Address, amount?: bigint): Promise<Hash | "NOT_NEEDED">;
+    buildUserOperationBatch(transactions: any[]): Promise<UserOperation>;
+    signUserOperation(userOp: UserOperation): Promise<UserOperation>;
+    sendUserOperation(userOp: UserOperation): Promise<Hash>;
+    waitForUserOperation(hash: Hash, timeout?: number): Promise<UserOpReceipt>;
+    requestApprovalSupport(token: Address, spender: Address, amount: bigint): Promise<ApprovalSupportResult>;
+    private decodeError;
+    getOwner(): `0x${string}` | null;
+    getSmartAccount(): `0x${string}` | null;
+}
+declare global {
+    interface Window {
+        ethereum?: {
+            request: (args: {
+                method: string;
+                params?: unknown[];
+            }) => Promise<unknown>;
+            on: (event: string, callback: (args: unknown) => void) => void;
+            removeListener: (event: string, callback: (args: unknown) => void) => void;
+        };
+    }
+}
+
+declare class BundlerClient {
+    private bundlerUrl;
+    private chainId;
+    private entryPointAddress;
+    constructor(config: ChainConfig, entryPointAddress: Address);
+    private call;
+    estimateGas(userOp: Partial<UserOperation>): Promise<GasEstimate>;
+    sendUserOperation(userOp: UserOperation): Promise<Hash>;
+    waitForUserOperation(userOpHash: Hash, timeout?: number): Promise<UserOpReceipt>;
+    requestApprovalSupport(token: Address, owner: Address, spender: Address, amount: bigint): Promise<ApprovalSupportResult>;
+}
+
+declare const BASE_MAINNET: ChainConfig;
+declare const BASE_SEPOLIA: ChainConfig;
+declare const CHAIN_CONFIGS: Record<number, ChainConfig>;
+
+declare const entryPointAbi: readonly [{
+    readonly inputs: readonly [{
+        readonly name: "sender";
+        readonly type: "address";
+    }, {
+        readonly name: "key";
+        readonly type: "uint192";
+    }];
+    readonly name: "getNonce";
+    readonly outputs: readonly [{
+        readonly name: "nonce";
+        readonly type: "uint256";
+    }];
+    readonly stateMutability: "view";
+    readonly type: "function";
+}];
+declare const smartAccountAbi: readonly [{
+    readonly inputs: readonly [{
+        readonly name: "target";
+        readonly type: "address";
+    }, {
+        readonly name: "value";
+        readonly type: "uint256";
+    }, {
+        readonly name: "data";
+        readonly type: "bytes";
+    }];
+    readonly name: "execute";
+    readonly outputs: readonly [];
+    readonly stateMutability: "nonpayable";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [{
+        readonly name: "targets";
+        readonly type: "address[]";
+    }, {
+        readonly name: "values";
+        readonly type: "uint256[]";
+    }, {
+        readonly name: "datas";
+        readonly type: "bytes[]";
+    }];
+    readonly name: "executeBatch";
+    readonly outputs: readonly [];
+    readonly stateMutability: "nonpayable";
+    readonly type: "function";
+}];
+declare const erc20Abi: readonly [{
+    readonly inputs: readonly [{
+        readonly name: "account";
+        readonly type: "address";
+    }];
+    readonly name: "balanceOf";
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint256";
+    }];
+    readonly stateMutability: "view";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [{
+        readonly name: "to";
+        readonly type: "address";
+    }, {
+        readonly name: "amount";
+        readonly type: "uint256";
+    }];
+    readonly name: "transfer";
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "bool";
+    }];
+    readonly stateMutability: "nonpayable";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [{
+        readonly name: "spender";
+        readonly type: "address";
+    }, {
+        readonly name: "amount";
+        readonly type: "uint256";
+    }];
+    readonly name: "approve";
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "bool";
+    }];
+    readonly stateMutability: "nonpayable";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [{
+        readonly name: "owner";
+        readonly type: "address";
+    }, {
+        readonly name: "spender";
+        readonly type: "address";
+    }];
+    readonly name: "allowance";
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint256";
+    }];
+    readonly stateMutability: "view";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [{
+        readonly name: "from";
+        readonly type: "address";
+    }, {
+        readonly name: "to";
+        readonly type: "address";
+    }, {
+        readonly name: "amount";
+        readonly type: "uint256";
+    }];
+    readonly name: "transferFrom";
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "bool";
+    }];
+    readonly stateMutability: "nonpayable";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [];
+    readonly name: "decimals";
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint8";
+    }];
+    readonly stateMutability: "view";
+    readonly type: "function";
+}];
+
+export { AccountAbstraction, BASE_MAINNET, BASE_SEPOLIA, BundlerClient, CHAIN_CONFIGS, type ChainConfig, type Token, type UserOpReceipt, type UserOperation, entryPointAbi, erc20Abi, smartAccountAbi };