Skip to Content

🚧 These packages are still in development and may change rapidly as they are developed.

ReactuseSubmitTransaction

useSubmitTransaction

Hook for submitting a transaction. The hook will use the default signer from the AptosJSProClient.

Usage

import { useSubmitTransaction, useClients, useSignTransaction, } from "@aptos-labs/react"; import { Account } from "@aptos-labs/ts-sdk"; export default function App() { const { client } = useClients(); const recipient = Account.generate(); const { mutateAsync: signTransaction } = useSignTransaction(); const { mutate: submitTransaction, data: transactionResult, isPending: isSubmitting, isSuccess: isSubmitted, } = useSubmitTransaction(); const handleSignAndSubmitTransaction = async () => { const transaction = await client.buildTransaction({ data: { function: "0x1::aptos_account::transfer", functionArguments: [recipient.accountAddress, 100], }, }); const signedTransaction = await signTransaction({ transaction }); submitTransaction({ senderAuthenticator: signedTransaction.authenticator, transaction, }); }; return ( <div> <button onClick={handleSignAndSubmitTransaction} disabled={isPending}> Sign and Submit Transaction </button> {isSubmitting && <p>Submitting transaction...</p>} {isSubmitted && <p>Transaction hash: {transactionResult?.hash}</p>} </div> ); }

Parameters

NameTypeDefault
throwOnErrorboolean | ((error: Error) => boolean)
mutationFnMutationFunction<PendingTransactionResponse, SubmitTransactionParameters>
mutationKeyreadonly unknown[]
onMutate(variables: SubmitTransactionParameters) => unknown
onSuccess(data: PendingTransactionResponse, variables: SubmitTransactionParameters, context: unknown) => unknown
onError(error: Error, variables: SubmitTransactionParameters, context: unknown) => unknown
onSettled(data: PendingTransactionResponse | undefined, error: Error | null, variables: SubmitTransactionParameters, context: unknown) => unknown
retryRetryValue<Error>
retryDelayRetryDelayValue<Error>
networkModeNetworkMode
gcTimenumber
metaRecord<string, unknown>
scopeMutationScope

Return Type

NameTypeDefault
submitTransactionUseMutateFunction<PendingTransactionResponse, Error, SubmitTransactionParameters, unknown>
submitTransactionAsyncUseMutateAsyncFunction<PendingTransactionResponse, Error, SubmitTransactionParameters, unknown>
dataPendingTransactionResponse | undefined
variablesSubmitTransactionParameters | undefined
errorError | null
isErrorboolean
isIdleboolean
isPendingboolean
isSuccessboolean
status"idle" | "pending" | "error" | "success"
mutateUseMutateFunction<PendingTransactionResponse, Error, SubmitTransactionParameters, unknown>
reset(() => void) | (() => void) | (() => void) | (() => void)
contextunknown
failureCountnumber
failureReasonError | null
isPausedboolean
submittedAtnumber
mutateAsyncUseMutateAsyncFunction<PendingTransactionResponse, Error, SubmitTransactionParameters, unknown>
Last updated on