Skip to Content

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

ReactuseSignTransaction

useSignTransaction

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

Usage

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

Parameters

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

Return Type

NameTypeDefault
signTransactionUseMutateFunction<{ rawTransaction: Uint8Array<ArrayBufferLike>; authenticator: AccountAuthenticator; }, Error, SignTransactionParameters, unknown> | UseMutateFunction<...> | UseMutateFunction<...> | UseMutateFunction<...>
signTransactionAsyncUseMutateAsyncFunction<{ rawTransaction: Uint8Array<ArrayBufferLike>; authenticator: AccountAuthenticator; }, Error, SignTransactionParameters, unknown> | UseMutateAsyncFunction<...> | UseMutateAsyncFunction<...> | UseMutateAsyncFunction<...>
data{ rawTransaction: Uint8Array<ArrayBufferLike>; authenticator: AccountAuthenticator; } | undefined
variablesSignTransactionParameters | undefined
errorError | null
isErrorboolean
isIdleboolean
isPendingboolean
isSuccessboolean
status"idle" | "pending" | "error" | "success"
mutateUseMutateFunction<{ rawTransaction: Uint8Array<ArrayBufferLike>; authenticator: AccountAuthenticator; }, Error, SignTransactionParameters, unknown> | UseMutateFunction<...> | UseMutateFunction<...> | UseMutateFunction<...>
reset(() => void) | (() => void) | (() => void) | (() => void)
contextunknown
failureCountnumber
failureReasonError | null
isPausedboolean
submittedAtnumber
mutateAsyncUseMutateAsyncFunction<{ rawTransaction: Uint8Array<ArrayBufferLike>; authenticator: AccountAuthenticator; }, Error, SignTransactionParameters, unknown> | UseMutateAsyncFunction<...> | UseMutateAsyncFunction<...> | UseMutateAsyncFunction<...>
Last updated on