Skip to content

Commit d09320c

Browse files
Merge pull request #10 from Quantum3-Labs/docs/update-documentation-on-useScaffoldContract
docs: update documentation on use scaffold contract
2 parents 2d3c953 + 9f68ad3 commit d09320c

File tree

2 files changed

+175
-301
lines changed

2 files changed

+175
-301
lines changed

docs/hooks/useScaffoldContract.md

+7
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,12 @@ sidebar_position: 6
44

55
# useScaffoldContract
66

7+
:::caution
8+
9+
Currently only works with read functions. We are working to get the write operations running as soon as possible. We apologize for the inconvenience.
10+
11+
:::
12+
713
Use this hook to get your contract instance by providing the contract name. It enables you to interact with your contract methods.
814
For reading data or sending transactions, it's recommended to use `useScaffoldReadContract` and `useScaffoldWriteContract`.
915

@@ -39,4 +45,5 @@ This example uses the `useScaffoldContract` hook to obtain a contract instance f
3945
## Return Value
4046

4147
- `data`: An instance of the contract, which can be used to call `read` and `write` methods of the contract.
48+
4249
- `isLoading` : Boolean indicating if the contract is being loaded.

0 commit comments

Comments
 (0)