mention about config object for useScaffoldWriteContract hook (#109)

Co-authored-by: Pabl0cks <[email protected]>
scaffold-eth · Dec 18, 2024 · cde0ef9 · cde0ef9
1 parent db92d14
commit cde0ef9
Showing 1 changed file with 16 additions and 9 deletions.
diff --git a/docs/hooks/useScaffoldWriteContract.md b/docs/hooks/useScaffoldWriteContract.md
@@ -10,7 +10,15 @@ Use this hook to send a transaction to your smart contract to write data or perf
 const { writeContractAsync: writeYourContractAsync } = useScaffoldWriteContract({ contractName: "YourContract" });
 ```
 
-The first argument is name of the contract to write to and the second argument is wagmi's `useWriteContract` hook [parameters object](https://wagmi.sh/react/api/hooks/useWriteContract#parameters).
+The following configuration options can be passed to the hook:
+
+## Configuration
+
+| Parameter                          | Type     | Description                                                                                                                |
+| :--------------------------------- | :------- | :------------------------------------------------------------------------------------------------------------------------- |
+| **contractName**                   | `string` | Name of the contract to write to.                                                                                          |
+| **chainId** (optional)             | `string` | Id of the chain the contract lives on. Defaults to [`targetNetworks[0].id`](/deploying/deploy-nextjs-app#--targetnetworks) |
+| **writeContractParams** (optional) | `object` | wagmi's `useWriteContract` hook [parameters object](https://wagmi.sh/react/api/hooks/useWriteContract#parameters)          |
 
 To send the transaction, you can call the `writeContractAsync` function returned by the hook (which we instance as `writeYourContractAsync`). Here's an example usage:
 
@@ -39,14 +47,13 @@ Below is the configuration for `writeContractAsync` function:
 
 ## Configuration
 
-| Parameter                          | Type        | Description                                                                                                                |
-| :--------------------------------- | :---------- | :------------------------------------------------------------------------------------------------------------------------- |
-| **functionName**                   | `string`    | Name of the function to call.                                                                                              |
-| **args** (optional)                | `unknown[]` | Array of arguments to pass to the function (if accepts any). Types are inferred from contract's function parameters.       |
-| **value** (optional)               | `bigint`    | Amount of ETH to send with the transaction (for payable functions only).                                                   |
-| **onBlockConfirmation** (optional) | `function`  | Callback function to execute when the transaction is confirmed.                                                            |
-| **blockConfirmations** (optional)  | `number`    | Number of block confirmations to wait for before considering transaction to be confirmed (default : 1).                    |
-| **chainId** (optional)             | `string`    | Id of the chain the contract lives on. Defaults to [`targetNetworks[0].id`](/deploying/deploy-nextjs-app#--targetnetworks) |
+| Parameter                          | Type        | Description                                                                                                          |
+| :--------------------------------- | :---------- | :------------------------------------------------------------------------------------------------------------------- |
+| **functionName**                   | `string`    | Name of the function to call.                                                                                        |
+| **args** (optional)                | `unknown[]` | Array of arguments to pass to the function (if accepts any). Types are inferred from contract's function parameters. |
+| **value** (optional)               | `bigint`    | Amount of ETH to send with the transaction (for payable functions only).                                             |
+| **onBlockConfirmation** (optional) | `function`  | Callback function to execute when the transaction is confirmed.                                                      |
+| **blockConfirmations** (optional)  | `number`    | Number of block confirmations to wait for before considering transaction to be confirmed (default : 1).              |
 
 You can also pass other arguments accepted by [writeContractAsync from wagmi](https://wagmi.sh/react/api/hooks/useWriteContract#mutate-async).