useSubmitTransaction
Submit a transaction on a Move module.
Usage
Call this hook with the module name as argument. To send a transaction, use submitTransaction
with the function name and function arguments as input.
import useSubmitTransaction from "~~/hooks/scaffold-move/useSubmitTransaction";
const { submitTransaction, transactionResponse, transactionInProcess } = useSubmitTransaction("onchain_bio");
await submitTransaction("register", ["my name", "example text"]);
This example executes the register
function on the ONCHAIN_BIO Move module, with two string arguments.
Parameters
Parameter | Type | Description |
---|---|---|
functionName | string | Name of the function to call |
args (optional) | any[] | Array of arguments to pass to the function. Empty when no arguments are needed. |
Return Value
transactionInProcess
: A bool, indicating whether or not the transaction is in process.transactionResponse
: The response is eitherTransactionResponseOnSubmission
orTransactionResponseOnError
.
export type TransactionResponseOnSubmission = {
transactionSubmitted: true;
transactionHash: string;
success: boolean; // indicates if the transaction submitted but failed or not
message?: string; // error message if the transaction failed
};
export type TransactionResponseOnError = {
transactionSubmitted: false;
message: string;
};