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

Solidity verifier #235

Merged
merged 9 commits into from
Oct 26, 2023
Merged

Solidity verifier #235

merged 9 commits into from
Oct 26, 2023

Conversation

faytey
Copy link
Contributor

@faytey faytey commented Oct 25, 2023

Added the solidity verifier chapter according to Remo's presentation, kindy review and update me on any changes needed or corrections. Thanks

@omarespejel omarespejel merged commit 1f1ba1d into starknet-edu:main Oct 26, 2023
1 check failed
@omarespejel
Copy link
Collaborator

Hey @faytey! Thank you very much I will review it while I am editing the style and come back with feedback if necessary.

@omarespejel
Copy link
Collaborator

omarespejel commented Oct 29, 2023

Hey @faytey,

Firstly, I appreciate your dedication and the contribution you've made to the Starknet Book. I've reviewed the PR and think we're about 66% on track to getting it where it needs to be.

I've implemented minor format and style modifications in your contribution, ensuring the core essence remains unchanged. You can review the changes I made [here](https://github.com/starknet-edu/starknetbook/blob/main/src/ch03-06-solidity-verifier.md).

Here's some feedback to refine and enhance it:

  1. General Enhancement: I encourage you to think holistically and detail-oriented when adding content. We aim for a comprehensive approach; our goal is for the students to grasp the content without getting puzzled by the images alone. It would be beneficial to explain and illustrate as clearly as possible how everything interconnects.
  2. Image References: It appears the images in your PR aren't displaying correctly. Kindly download the relevant images and place them in the src/img/ directory with the other images (check the Sequencers chapter for an example on how to show them). Subsequently, please reference them in the text to ensure they display appropriately.
  3. Sharp Verifier Contract Map: The “Sharp Verifier Contract Map” section could benefit from a more detailed description of the associated images. It would significantly enhance the reader's understanding.
  4. Constructor Parameters of Key Contracts: In the “Constructor Parameters of Key Contracts” section, it would be helpful to delve deeper into the images' descriptions. Please elaborate on the constructor parameters and their significance.
  5. Interconnection of Contracts: We need a clear exposition on how the different contracts interrelate and collectively form a cohesive system.

Thank you once again for your contribution. Looking forward to seeing the refined version!

@faytey
Copy link
Contributor Author

faytey commented Oct 29, 2023

OOOOPPss, lots of adjustments, so sorry I thought the images would explain the concepts better. Now I know better and would adjust it the most I can. Thanks, I will revert by tomorrow

imgbot bot pushed a commit to hardiktheprogrammer/starknetbook that referenced this pull request Jan 28, 2024
* Initializing the solidity verifier sub chapter

* adding foundational topics to boost knowledge

* adding verifiers and sequencers explanations

* adding provers and STARK explanations

* adding SHARP explanations

* adding solidity verifiers intro

* adding prehistoric verifier

* adding solidity verifier contracts

* adding verifiers etherscan addresses as links
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.

None yet

2 participants