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.

Sign up for GitHub

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

feat: Noir >=1.0.0 #36

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

feat: Noir >=1.0.0 #36

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
cd5ef58
update noir v1.0.0
jtriley-eth Dec 4, 2024
62af504
add deps
jtriley-eth Dec 4, 2024
3d1fc1d
typo
jtriley-eth Dec 4, 2024
af8c7a6
fix
jtriley-eth Dec 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,17 @@

A Base64 encoding/decoding library written in Noir which can encode arbitrary byte arrays into Base64 and decode Base64-encoded byte arrays (e.g. `"SGVsbG8gV29ybGQ=".as_bytes()`).

## Noir Version Compatibility

We have tested this library with Noir nightly, 0.36.0, and 1.0.0-beta.0
Copy link

Choose a reason for hiding this comment

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

Suggested change
We have tested this library with Noir nightly, 0.36.0, and 1.0.0-beta.0
This library is tested with all Noir stable releases from v0.36.0.


## Dependencies

- Noir >=1.0.0
- Barretenberg ≥v0.56.1

Refer to [Noir's docs](https://noir-lang.org/docs/getting_started/quick_start) and [Barretenberg's docs](https://github.com/AztecProtocol/aztec-packages/blob/master/barretenberg/cpp/src/barretenberg/bb/readme.md#installation) for installation steps.
Comment on lines +5 to +14
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
## Noir Version Compatibility
We have tested this library with Noir nightly, 0.36.0, and 1.0.0-beta.0
## Dependencies
- Noir >=1.0.0
- Barretenberg ≥v0.56.1
Refer to [Noir's docs](https://noir-lang.org/docs/getting_started/quick_start) and [Barretenberg's docs](https://github.com/AztecProtocol/aztec-packages/blob/master/barretenberg/cpp/src/barretenberg/bb/readme.md#installation) for installation steps.
## Noir Version Compatibility
We have tested this library with Noir nightly, 0.36.0, and 1.0.0-beta.0
Refer to [Noir's docs](https://noir-lang.org/docs/getting_started/quick_start) for installation steps.

As a general rule, I don't think that any noir libararies should be specifying versions of the backend to use (or even mentioning barretenberg at all).

The reasoning being that the version of the backend which the user should use is purely dependent on the version of nargo they're using (and unaffected by the library) so it should be documented elsewhere. If we add references to barretenberg here then we need to keep this up-to-date across N different libraries which is creating more work for ourselves.


## Usage
### Configuration
Start by selecting the encoder or decoder for your configuration. These are defined separately so that only one lookup table will be instantiated at a time, since many cases will require either an encoder or a decoder but not both.
Expand Down
Loading