chore: add examples and readme updates from hc #7
Conversation
jzaki
changed the title
* main: fix: update to support noir 0.34.0 (#6) decoder now works for byte values that are 8 bits, not just 7 bits
| Prove it, for example with default backend Barretenberg: | ||
| ``` | ||
| bb prove -b ./target/example2.json -w ./target/base64.gz -o ./target/proof | ||
| ``` | ||
|
|
||
| To verify, we need to export the verification key: | ||
|
|
||
| ```bash | ||
| bb write_vk -b ./target/example2.json -o ./target/vk | ||
| ``` | ||
|
|
||
| And verify: | ||
|
|
||
| ```bash | ||
| bb verify -k ./target/vk -p ./target/proof | ||
| ``` | ||
| If verification passed, you see nothing. Otherwise there is an error. |
There was a problem hiding this comment.
We shouldn't include documentation on how to generate proofs on Noir libraries. We can centralize that into one place and then any library documentation should only teach how to interact with the library through Noir code.
There was a problem hiding this comment.
These tests can be moved into the main library package (and we'll then get them tested in CI)
| # Costs | ||
| See more examples in `lib.nr` and the `examples` folder. | ||
|
|
||
| ## Conversion explainer |
| ### `fn base64_encode` | ||
| Takees an input byte array of ASCII characters and produces an output byte array of base64-encoded characters. The 6-bit base64 characters are packed into a concatenated byte array (e.g. 4 bytes of ASCII produce 3 bytes of encoded Base64) | ||
| - Noir ≥v0.34.0 | ||
| - Compatible version of a proving backend, eg Barretenberg |
There was a problem hiding this comment.
Let's remove references to the backend here. If we push people towards the Nargo docs then that can teach them about the need for a proving backend.
We're going to get a lot of duplicated documentation which will fall out of sync otherwise.
There was a problem hiding this comment.
I'm not clear on what this example is showing over example1
Description
Problem*
Related AztecProtocol/dev-rel#365
Summary*
Additional Context
PR Checklist*
cargo fmton default settings.