feat: Documentation and CI configuration for Solidity #36
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
tchataigner
force-pushed
the
issue-34
branch
3 times, most recently
from
06e640b
to
1cad5b5
Compare
* feat: Add scaffolding for Plonk verification in Solidity * feat: Add Plonk contract * tests: Add more negative Solidity testing * feat: Add Rust program for Solidity contract generating * chore: Update Cargo.lock * chore: Update Plonk contract according to 'e48c01ec' tag of Sphinx * chore: Formatting * feat: Introduce downloading from our AWS private bucket * feat: Update Foundry project to use sphinx-contracts dependency * chore: Rename SP1 -> Sphinx
Signed-off-by: Thomas Chataigner <tom.chataigner@yahoo.fr>
Signed-off-by: Thomas Chataigner <tom.chataigner@yahoo.fr>
Signed-off-by: Thomas Chataigner <tom.chataigner@yahoo.fr>
wwared
approved these changes
Jun 21, 2024
| Our Light Client is able to produce SNARK proofs that can be verified on-chain. This section will cover how to run the | ||
| benchmarks for the on-chain verification. | ||
|
|
||
| To be able to execute such tests our repository contains a project called `solidity` is based |
There was a problem hiding this comment.
Suggested change
| To be able to execute such tests our repository contains a project called `solidity` is based | |
| To be able to execute such tests our repository contains a project called `solidity` that is based |
Comment on lines
+16
to
+17
| Make sure that you have properly set up the `sphinx-contracts` submodule. If you haven't done so, you can do it by | ||
| running the following command: |
There was a problem hiding this comment.
Something to keep in mind: sphinx-contracts is still a private repository, so there's the question of how we'll handle access to it and how to deal with it in the released source.
In the released source, we can vendor in the repository and make sure it's included in its entirety at the right commit. Alternatively, we just ensure to give access to everyone relevant to the repository, which we will probably need to do anyway
|
|
||
| > **Note** | ||
| > | ||
| > You might be encountering issue with updating `sphinx-contracts` Foundry dependency, in this case try manually |
There was a problem hiding this comment.
Suggested change
| > You might be encountering issue with updating `sphinx-contracts` Foundry dependency, in this case try manually | |
| > You might be encountering issue when updating the `sphinx-contracts` Foundry dependency, in this case try manually |
tchataigner
added a commit
that referenced
this pull request
Jun 24, 2024
* feat: Update Sphinx and replace Groth16 with Plonk (#23) * feat: Solidity verification of light client proofs with Plonk (#28) * feat: Add scaffolding for Plonk verification in Solidity * feat: Add Plonk contract * tests: Add more negative Solidity testing * feat: Add Rust program for Solidity contract generating * chore: Update Cargo.lock * chore: Update Plonk contract according to 'e48c01ec' tag of Sphinx * chore: Formatting * feat: Introduce downloading from our AWS private bucket * feat: Update Foundry project to use sphinx-contracts dependency * chore: Rename SP1 -> Sphinx * chore: Add README for Solidity verification * feat: Add CI configuration for Solidity * ci: solidity tests on all PR Signed-off-by: Thomas Chataigner <tom.chataigner@yahoo.fr> * chore: update programs Signed-off-by: Thomas Chataigner <tom.chataigner@yahoo.fr> * docs: move documentation to mdBook Signed-off-by: Thomas Chataigner <tom.chataigner@yahoo.fr> --------- Signed-off-by: Thomas Chataigner <tom.chataigner@yahoo.fr> Co-authored-by: wwared <wwared@users.noreply.github.com> Co-authored-by: Thomas Chataigner <tom.chataigner@yahoo.fr>
wwared
added a commit
that referenced
this pull request
Jun 24, 2024
* feat: Update Sphinx and replace Groth16 with Plonk (#23) * feat: Solidity verification of light client proofs with Plonk (#28) * feat: Add scaffolding for Plonk verification in Solidity * feat: Add Plonk contract * tests: Add more negative Solidity testing * feat: Add Rust program for Solidity contract generating * chore: Update Cargo.lock * chore: Update Plonk contract according to 'e48c01ec' tag of Sphinx * chore: Formatting * feat: Introduce downloading from our AWS private bucket * feat: Update Foundry project to use sphinx-contracts dependency * chore: Rename SP1 -> Sphinx * chore: Add README for Solidity verification * feat: Add CI configuration for Solidity * ci: solidity tests on all PR Signed-off-by: Thomas Chataigner <tom.chataigner@yahoo.fr> * chore: update programs Signed-off-by: Thomas Chataigner <tom.chataigner@yahoo.fr> * docs: move documentation to mdBook Signed-off-by: Thomas Chataigner <tom.chataigner@yahoo.fr> --------- Signed-off-by: Thomas Chataigner <tom.chataigner@yahoo.fr> Co-authored-by: wwared <wwared@users.noreply.github.com> Co-authored-by: Thomas Chataigner <tom.chataigner@yahoo.fr>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR aims to fix #34 (at least partially because the final documentation needs to be properly integrated into mdbook which is currently only in
devbranch) by introducing README with basic information about Solidity verification of proofs generated by inclusion and epoch-change programs as well as CI configuration for Foundry testing