useSendTransactions

The useSendTransactions hook enables sending a set of transactions as a UserOperation on behalf of the user's Embedded Account.

Import

import { useSendTransactions } from "@alchemy/aa-alchemy/react";

Usage

useSendTransactions.tsx

import {
  useSendTransactions,
  useSmartAccountClient,
} from "@alchemy/aa-alchemy/react";
import { toHex } from "viem";
 
export function ComponentWithSendTransactions() {
  /**
   * Assumes the app has context of a signer with an authenticated user
   * by using the `AlchemyAccountProvider` from `@alchemy/aa-alchemy/react`.
   */
  const { client } = useSmartAccountClient({
    type: "MultiOwnerModularAccount",
  });
  const { sendTransactions, isSendingTransactions } = useSendTransactions({
    client,
    onSuccess: (hash) => {
      // [optional] Do something with the hash
    },
    onError: (error) => {
      // [optional] Do something with the error
    },
    // [optional] ...additional mutationArgs
  });
 
  return (
    <div>
      <button
        onClick={() =>
          sendTransactions({
            requests: [
              {
                from: "0xACCOUNT_ADDRESS",
                to: "0xTARGET_ADDRESS",
                data: "0x",
                value: toHex(0n),
              },
            ],
            // ... other parameters (account, context, overrides)
          })
        }
        disabled={isSendingTransactions}
      >
        {isSendingTransactions ? "Sending..." : "Send Txns"}
      </button>
    </div>
  );
}

Params

client

AlchemySmartAccountClient | undefined A AlchemySmartAccountClient with methods to interact with an Alchemy smart account.

...mutationArgs

You can optionally specify any of the React Query useMutation parameters as parameters to this hook.

Return Type

import { type UseSendTransactions } from "@alchemy/aa-alchemy/react";

Returns an object containing the following state.

sendTransactions

UseMutateFunction A React query mutation function to send a Transactions as a UserOperation. It returns a SendTransactionsResult object.

SendTransactionsResult

types.ts

// [!include ~/../packages/core/src/client/types.ts:SendTransactionsResult]

It takes in SendTransactionsParameters which has the following type:

SendTransactionsParameters

types.ts

export type SendTransactionsParameters<
  TAccount extends SmartContractAccount | undefined,
  TContext extends UserOperationContext | undefined =
    | UserOperationContext
    | undefined,
  TEntryPointVersion extends GetEntryPointFromAccount<TAccount> = GetEntryPointFromAccount<TAccount>
> = {
  requests: RpcTransactionRequest[];
} & GetAccountParameter<TAccount> &
  GetContextParameter<TContext> &
  UserOperationOverridesParameter<TEntryPointVersion>;

sendTransactionsAsync

UseMutateAsyncFunction A React query async mutation function to send a Transactions as a UserOperation. Via an awaitable promise, it returns a SendTransactionsResult object shown above.

sendTransactionsResult

An transaction hash if the mutation has run successfully, undefined otherwise.

isSendingTransactions

boolean A flag that determines whether the mutation is still running or not.

error

Error | null A field that relays any errors from the mutation. It is null if there is no error.