Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add recipe for Read Contracts #31

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

od-hunter
Copy link

@od-hunter od-hunter commented Oct 6, 2024

Add recipe for Read Contract

Fixes #22

Types of change

  • Bug
  • Enhancement
  • Documentation

@od-hunter
Copy link
Author

@metalboyrick please review

@Nadai2010
Copy link
Collaborator

Hi @od-hunter, I really liked your documentation, we look forward to the changes and final review. Thanks

Copy link
Collaborator

@metalboyrick metalboyrick left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor changes and you're good!

};
```

By following this guide, you have successfully implemented a contract reader in your dApp that fetches and displays data from a deployed contract using the [`useScaffoldReactContract`](https://github.com/Scaffold-Stark/scaffold-stark-2/blob/main/packages/nextjs/hooks/scaffold-stark/useScaffoldReadContract.ts) hook.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Typo (useScaffoldReactContract should be useScaffoldReadContract)

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please keep the convention consistent with the other files!

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@od-hunter I meant the file name. My bad for the unclear message.

ReadContractDataFromNetwork.md --> read-contract-data.md

(would prefer this shorter name too)

@od-hunter
Copy link
Author

@metalboyrick @Nadai2010, thank you both for your review.

@metalboyrick, I wasn’t entirely clear on the 'convention consistency' feedback, but I’ve made some recent changes that I hope align with your expectations. If not, I would appreciate further clarification to ensure I implement the conventions consistently.

@od-hunter
Copy link
Author

@metalboyrick, I’ve renamed the document to align with the naming conventions used in the other files.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add recipe for Read Contracts
3 participants