Skip to main content

useScaffoldWriteContract

Use this hook to send a transaction to your smart contract to write data or perform an action.

const { write: writeYourContractAsync } = useScaffoldWriteContract({
contractName: "YourContract",
});

The following configuration options can be passed to the hook:

Configuration

ParameterTypeRequiredDescription
contractNamestringYesName of the contract to write to.
blockConfirmationsnumberNoNumber of block confirmations to wait for (default: 1).
gasLimitbigintNoTransaction gas limit.

To send the transaction, you can call the writeYourContractAsync function returned by the hook. Here's an example usage:

<Button
onPress={async () => {
try {
await writeYourContractAsync({
functionName: "setGreeting",
args: ["The value to set"],
value: parseEther("0.1"),
});
} catch (e) {
console.error("Error setting greeting:", e);
}
}}
>
Set Greeting
</Button>

This example sends a transaction to the YourContract smart contract to call the setGreeting function with the arguments passed in args. The writeYourContractAsync function sends the transaction to the smart contract.

Below is the configuration for writeYourContractAsync function:

Configuration

ParameterTypeRequiredDescription
functionNamestringYesName of the function to be called.
argsunknown[]NoArray of arguments to pass to the function (if accepts any). Types are inferred from contract's function parameters.
valuebigintNoValue in ETH that will be sent with transaction (for payable functions only).

Return Values

  • The loading state is stored in the isLoading property.
  • The mining state is stored in the isMining property.
  • writeContract functions send the transaction to the smart contract but doesn't return a promise.
  • writeContractAsync function sends the transaction to the smart contract and returns a promise that resolves when transactions is successful.