@abstract-foundation/agw-client
Version:
Abstract Global Wallet Client SDK
76 lines • 4.2 kB
TypeScript
import { type Account, type Address, type Client, type PublicClient, type SendTransactionRequest, type SendTransactionReturnType, type Transport, type WalletClient } from 'viem';
import { type ChainEIP712 } from 'viem/zksync';
import type { CustomPaymasterHandler } from '../types/customPaymaster.js';
import type { SendTransactionBatchParameters } from '../types/sendTransactionBatch.js';
import type { SignTransactionBatchParameters } from '../types/signTransactionBatch.js';
export declare function getBatchTransactionObject<chain extends ChainEIP712 | undefined = ChainEIP712 | undefined, account extends Account | undefined = Account | undefined, chainOverride extends ChainEIP712 | undefined = ChainEIP712 | undefined, request extends SendTransactionRequest<chain, chainOverride> = SendTransactionRequest<chain, chainOverride>>(address: Address, parameters: SendTransactionBatchParameters<request> | SignTransactionBatchParameters<chain, account, chainOverride>): any;
/**
* Function to send 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 SendTransactionBatch() {
* const { data: agwClient } = useAbstractClient();
*
* async function sendTransactionBatch() {
* if (!agwClient) return;
*
* // Batch multiple transactions in a single call
* const hash = await agwClient.sendTransactionBatch({
* 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("Transaction hash:", hash);
* }
* }
* ```
*
* @param parameters - Parameters for sending a batch of transactions
* @param parameters.calls - An array of transaction requests. Each transaction can include:
* - to: The recipient address (required)
* - from: The sender address (defaults to the AGW address)
* - data: Contract code or method call with encoded args
* - gas: Gas provided for execution
* - nonce: Unique transaction identifier
* - value: Amount in wei to send
* - maxFeePerGas: Total fee per gas
* - maxPriorityFeePerGas: Priority fee per gas
* - gasPerPubdata: Gas per byte of data
* - factoryDeps: Bytecodes of contract dependencies
* - customSignature: Custom transaction signature
* - type: Transaction type
* @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 sendTransactionBatch<chain extends ChainEIP712 | undefined = ChainEIP712 | undefined, chainOverride extends ChainEIP712 | undefined = ChainEIP712 | undefined, request extends SendTransactionRequest<chain, chainOverride> = SendTransactionRequest<chain, chainOverride>>(client: Client<Transport, ChainEIP712, Account>, signerClient: WalletClient<Transport, ChainEIP712, Account>, publicClient: PublicClient<Transport, ChainEIP712>, parameters: SendTransactionBatchParameters<request>, isPrivyCrossApp?: boolean, customPaymasterHandler?: CustomPaymasterHandler | undefined): Promise<SendTransactionReturnType>;
//# sourceMappingURL=sendTransactionBatch.d.ts.map