@1llet.xyz/erc4337-gasless-sdk 0.1.0

package/dist/index.d.mts

@@ -0,0 +1,326 @@
+import { Chain, Address, Hex, Hash } from 'viem';
+
+interface ChainConfig {
+    chain: Chain;
+    rpcUrl: string;
+    bundlerUrl: string;
+    entryPointAddress: Address;
+    factoryAddress: Address;
+    paymasterAddress: Address;
+    usdcAddress: Address;
+}
+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;
+    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 (counterfactual)
+     */
+    getSmartAccountAddress(owner: Address): Promise<Address>;
+    /**
+     * Check if the Smart Account is deployed
+     */
+    isAccountDeployed(): Promise<boolean>;
+    /**
+     * Get the USDC balance of the Smart Account
+     */
+    getUsdcBalance(): Promise<bigint>;
+    /**
+     * Get the EOA's USDC balance
+     */
+    getEoaUsdcBalance(): Promise<bigint>;
+    /**
+     * Get the allowance of the Smart Account to spend the EOA's USDC
+     */
+    getAllowance(): Promise<bigint>;
+    /**
+     * Get the nonce for the Smart Account
+     */
+    getNonce(): Promise<bigint>;
+    /**
+     * Build initCode for account deployment
+     */
+    buildInitCode(): Hex;
+    /**
+     * Estimate gas for a UserOperation
+     */
+    estimateGas(userOp: Partial<UserOperation>): Promise<GasEstimate>;
+    /**
+     * Build a UserOperation for Batched Execution (e.g. USDC Transfer + Fee)
+     */
+    buildUserOperationBatch(transactions: {
+        target: Address;
+        value: bigint;
+        data: Hex;
+    }[]): Promise<UserOperation>;
+    /**
+     * Build a UserOperation to ONLY deploy the account (empty callData)
+     */
+    buildDeployUserOperation(): Promise<UserOperation>;
+    /**
+     * Calculate the UserOperation hash
+     */
+    getUserOpHash(userOp: UserOperation): Hex;
+    /**
+     * Sign a UserOperation with MetaMask
+     */
+    signUserOperation(userOp: UserOperation): Promise<UserOperation>;
+    /**
+     * Send a signed UserOperation to the bundler
+     */
+    sendUserOperation(userOp: UserOperation): Promise<Hash>;
+    /**
+     * Wait for a UserOperation to be confirmed
+     */
+    waitForUserOperation(userOpHash: Hash, timeout?: number): Promise<UserOpReceipt>;
+    /**
+     * Request support for token approval (fund if needed)
+     */
+    requestApprovalSupport(token: Address, spender: Address, amount: bigint): Promise<ApprovalSupportResult>;
+    getOwner(): Address | null;
+    getSmartAccount(): Address | 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 const DEFAULT_ENTRYPOINT = "0x5FF137D4b0FDCD49DcA30c7CF57E578a026d2789";
+declare const DEFAULT_FACTORY = "0x9406Cc6185a346906296840746125a0E44976454";
+declare const factoryAbi: readonly [{
+    readonly inputs: readonly [{
+        readonly name: "owner";
+        readonly type: "address";
+    }, {
+        readonly name: "salt";
+        readonly type: "uint256";
+    }];
+    readonly name: "getAccountAddress";
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "address";
+    }];
+    readonly stateMutability: "view";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [{
+        readonly name: "owner";
+        readonly type: "address";
+    }, {
+        readonly name: "salt";
+        readonly type: "uint256";
+    }];
+    readonly name: "isAccountDeployed";
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "bool";
+    }];
+    readonly stateMutability: "view";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [{
+        readonly name: "owner";
+        readonly type: "address";
+    }, {
+        readonly name: "salt";
+        readonly type: "uint256";
+    }];
+    readonly name: "createAccount";
+    readonly outputs: readonly [{
+        readonly name: "account";
+        readonly type: "address";
+    }];
+    readonly stateMutability: "nonpayable";
+    readonly type: "function";
+}];
+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, type ApprovalSupportResult, type ChainConfig, DEFAULT_ENTRYPOINT, DEFAULT_FACTORY, type GasEstimate, type UserOpReceipt, type UserOperation, entryPointAbi, erc20Abi, factoryAbi, smartAccountAbi };

package/dist/index.d.ts

@@ -0,0 +1,326 @@
+import { Chain, Address, Hex, Hash } from 'viem';
+
+interface ChainConfig {
+    chain: Chain;
+    rpcUrl: string;
+    bundlerUrl: string;
+    entryPointAddress: Address;
+    factoryAddress: Address;
+    paymasterAddress: Address;
+    usdcAddress: Address;
+}
+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;
+    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 (counterfactual)
+     */
+    getSmartAccountAddress(owner: Address): Promise<Address>;
+    /**
+     * Check if the Smart Account is deployed
+     */
+    isAccountDeployed(): Promise<boolean>;
+    /**
+     * Get the USDC balance of the Smart Account
+     */
+    getUsdcBalance(): Promise<bigint>;
+    /**
+     * Get the EOA's USDC balance
+     */
+    getEoaUsdcBalance(): Promise<bigint>;
+    /**
+     * Get the allowance of the Smart Account to spend the EOA's USDC
+     */
+    getAllowance(): Promise<bigint>;
+    /**
+     * Get the nonce for the Smart Account
+     */
+    getNonce(): Promise<bigint>;
+    /**
+     * Build initCode for account deployment
+     */
+    buildInitCode(): Hex;
+    /**
+     * Estimate gas for a UserOperation
+     */
+    estimateGas(userOp: Partial<UserOperation>): Promise<GasEstimate>;
+    /**
+     * Build a UserOperation for Batched Execution (e.g. USDC Transfer + Fee)
+     */
+    buildUserOperationBatch(transactions: {
+        target: Address;
+        value: bigint;
+        data: Hex;
+    }[]): Promise<UserOperation>;
+    /**
+     * Build a UserOperation to ONLY deploy the account (empty callData)
+     */
+    buildDeployUserOperation(): Promise<UserOperation>;
+    /**
+     * Calculate the UserOperation hash
+     */
+    getUserOpHash(userOp: UserOperation): Hex;
+    /**
+     * Sign a UserOperation with MetaMask
+     */
+    signUserOperation(userOp: UserOperation): Promise<UserOperation>;
+    /**
+     * Send a signed UserOperation to the bundler
+     */
+    sendUserOperation(userOp: UserOperation): Promise<Hash>;
+    /**
+     * Wait for a UserOperation to be confirmed
+     */
+    waitForUserOperation(userOpHash: Hash, timeout?: number): Promise<UserOpReceipt>;
+    /**
+     * Request support for token approval (fund if needed)
+     */
+    requestApprovalSupport(token: Address, spender: Address, amount: bigint): Promise<ApprovalSupportResult>;
+    getOwner(): Address | null;
+    getSmartAccount(): Address | 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 const DEFAULT_ENTRYPOINT = "0x5FF137D4b0FDCD49DcA30c7CF57E578a026d2789";
+declare const DEFAULT_FACTORY = "0x9406Cc6185a346906296840746125a0E44976454";
+declare const factoryAbi: readonly [{
+    readonly inputs: readonly [{
+        readonly name: "owner";
+        readonly type: "address";
+    }, {
+        readonly name: "salt";
+        readonly type: "uint256";
+    }];
+    readonly name: "getAccountAddress";
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "address";
+    }];
+    readonly stateMutability: "view";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [{
+        readonly name: "owner";
+        readonly type: "address";
+    }, {
+        readonly name: "salt";
+        readonly type: "uint256";
+    }];
+    readonly name: "isAccountDeployed";
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "bool";
+    }];
+    readonly stateMutability: "view";
+    readonly type: "function";
+}, {
+    readonly inputs: readonly [{
+        readonly name: "owner";
+        readonly type: "address";
+    }, {
+        readonly name: "salt";
+        readonly type: "uint256";
+    }];
+    readonly name: "createAccount";
+    readonly outputs: readonly [{
+        readonly name: "account";
+        readonly type: "address";
+    }];
+    readonly stateMutability: "nonpayable";
+    readonly type: "function";
+}];
+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, type ApprovalSupportResult, type ChainConfig, DEFAULT_ENTRYPOINT, DEFAULT_FACTORY, type GasEstimate, type UserOpReceipt, type UserOperation, entryPointAbi, erc20Abi, factoryAbi, smartAccountAbi };