UNPKG

@abstract-foundation/agw-client

Version:
65 lines 3.26 kB
import { type Account, type Address, type Client, type Hex, type PublicClient, type Transport, type WalletClient } from 'viem'; import { type ChainEIP712, type SignEip712TransactionReturnType } from 'viem/zksync'; import type { CustomPaymasterHandler } from '../types/customPaymaster.js'; import type { SignTransactionBatchParameters } from '../types/signTransactionBatch.js'; /** * Function to sign a batch of transactions in a single call using the connected Abstract Global Wallet. * * @example * ```tsx * import { useAbstractClient } from "@abstract-foundation/agw-react"; * import { encodeFunctionData, parseUnits } from "viem"; * * export default function SignTransactionBatch() { * const { data: agwClient } = useAbstractClient(); * * async function signTransactionBatch() { * if (!agwClient) return; * * // Sign a batch of multiple transactions in a single call * const rawTransaction = await agwClient.signTransactionBatch({ * calls: [ * // 1. Simple ETH transfer * { * to: "0x1234567890123456789012345678901234567890", * value: parseUnits("0.1", 18), // 0.1 ETH * }, * // 2. Contract interaction * { * to: "0xabcdef0123456789abcdef0123456789abcdef01", * data: encodeFunctionData({ * abi: [ * { * name: "transfer", * type: "function", * inputs: [ * { name: "to", type: "address" }, * { name: "amount", type: "uint256" } * ], * outputs: [{ type: "bool" }], * stateMutability: "nonpayable" * } * ], * functionName: "transfer", * args: ["0x9876543210987654321098765432109876543210", parseUnits("10", 18)] * }) * } * ] * }); * * console.log("Serialized transaction:", rawTransaction); * } * } * ``` * * @param parameters - Parameters for signing a batch of transactions * @param parameters.calls - An array of transaction requests. Each transaction can include: * - to: The recipient address (required) * - data: Contract code or method call with encoded args * - value: Amount in wei to send * @param parameters.paymaster - Address of the paymaster smart contract that will pay the gas fees * @param parameters.paymasterInput - Input data to the paymaster * @returns The transaction hash of the submitted transaction batch */ export declare function signTransactionBatch<chain extends ChainEIP712 | undefined = ChainEIP712 | undefined, account extends Account | undefined = Account | undefined, chainOverride extends ChainEIP712 | undefined = ChainEIP712 | undefined>(client: Client<Transport, ChainEIP712, Account>, signerClient: WalletClient<Transport, ChainEIP712, Account>, publicClient: PublicClient<Transport, ChainEIP712>, parameters: SignTransactionBatchParameters<chain, account, chainOverride>, validator: Address, validationHookData?: Record<string, Hex>, customPaymasterHandler?: CustomPaymasterHandler | undefined, isPrivyCrossApp?: boolean): Promise<SignEip712TransactionReturnType>; //# sourceMappingURL=signTransactionBatch.d.ts.map