Skip to main content

useScaffoldContractWrite

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

const { writeAsync, isLoading, isMining } = useScaffoldContractWrite({
  contractName: "YourContract",
  functionName: "setGreeting",
  args: ["The value to set"],
  // For payable functions
  value: parseEther("0.1"),
  // The number of block confirmations to wait for before considering transaction to be confirmed (default : 1).
  blockConfirmations: 1,
  // The callback function to execute when the transaction is confirmed.
  onBlockConfirmation: txnReceipt => {
    console.log("Transaction blockHash", txnReceipt.blockHash);
  },
});

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

<button className="btn btn-primary" onClick={() => writeAsync()}>
  Send TX
</button>

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

It is also possible to pass arguments imperatively to the writeAsync function:

<button className="btn btn-primary" onClick={() => writeAsync({ args: ["Dynamic value"], value: parseEther("0.2") })}>
  Send TX
</button>

Parameters​

Along with contractName and functionName, if the function accepts any arguments, they can be passed in the args array. Apart from extra arguments like blockConfirmations and onBlockConfirmation you can also pass other arguments accepted by useContractWrite wagmi hook.

Return Values​

  • writeAsync function sends the transaction to the smart contract.
  • isMining property indicates whether the transaction is currently being mined.
  • The extended object includes properties inherited from wagmi useContractWrite. You can check the useContractWrite return values documentation to check the types.