Merge pull request #38 from Scaffold-Stark/docs/update-based-on-new-p…

…arser docs: update based on new parser
Scaffold-Stark · Nov 29, 2024 · 4a2c7b3 · 4a2c7b3
2 parents 026790d + e8686fd
commit 4a2c7b3
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 10 deletions.
diff --git a/docs/hooks/useScaffoldMultiWriteContract.md b/docs/hooks/useScaffoldMultiWriteContract.md
@@ -28,6 +28,21 @@ This example sends multiple transactions to the specified smart contracts to cal
 ## Usage Example
 
 ```tsx
+const { sendAsync } = useScaffoldMultiWriteContract({
+  calls: [
+    {
+      contractName: "YourContract1",
+      functionName: "setGreeting",
+      args: ["Hello"],
+    },
+    {
+      contractName: "YourContract2",
+      functionName: "setCounter",
+      args: [42],
+    },
+  ],
+});
+
 <button
   className="btn btn-primary"
   onClick={async () => {
@@ -39,17 +54,17 @@ This example sends multiple transactions to the specified smart contracts to cal
   }}
 >
   Send Transactions
-</button>
+</button>;
 ```
 
 This example demonstrates how to use the `sendAsync`function to send multiple transactions to the specified smart contracts, calling the functions with the arguments passed in calls.
 
 ## Configuration
 
-| Parameter              | Type                 | Description                                                                                                                   |
-| :--------------------- | :------------------- | :---------------------------------------------------------------------------------------------------------------------------- |
-| **calls**              | `Calldata[]`         | Array of configuration objects for the contract calls. Each object should contain `contractName`, `functionName`, and `args`. |
-| **options** (optional) | `InvocationsDetails` | Additional options for the transactions.                                                                                      |
+| Parameter              | Type                 | Description                                                                                                                                                                                                        |
+| :--------------------- | :------------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| **calls**              | `Calldata[]`         | Array of configuration objects for the contract calls. Each object should contain `contractName`, `functionName`, and `args`. For special datatypes such as `enums`, you can pass in enum types from `starknet.js` |
+| **options** (optional) | `InvocationsDetails` | Additional options for the transactions.                                                                                                                                                                           |
 
 ## Call Object Configuration
 

diff --git a/docs/hooks/useScaffoldWriteContract.md b/docs/hooks/useScaffoldWriteContract.md
@@ -40,11 +40,11 @@ In this example, the updateGreeting function of the YourContract is called with
 
 ## Configuration
 
-| Parameter           | Type        | Description                                                                                                      |
-| :------------------ | :---------- | :--------------------------------------------------------------------------------------------------------------- |
-| **contractName**    | `string`    | Name of the contract to write to.                                                                                |
-| **functionName**    | `string`    | Name of the function to call.                                                                                    |
-| **args** (optional) | `unknown[]` | Array of arguments to pass to the function (if any). Types are inferred from the contract's function parameters. |
+| Parameter           | Type        | Description                                                                                                                                                                                           |
+| :------------------ | :---------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| **contractName**    | `string`    | Name of the contract to write to.                                                                                                                                                                     |
+| **functionName**    | `string`    | Name of the function to call.                                                                                                                                                                         |
+| **args** (optional) | `unknown[]` | Array of arguments to pass to the function (if any). Types are inferred from the contract's function parameters. For special datatypes such as `enums`, you can pass in enum types from `starknet.js` |
 
 ## Return Values