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

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

wants to merge 4 commits into from

Conversation

jtriley-eth
Copy link
Contributor

Description

Updates noir version to 1.0.0

Problem*

Closes #34

PR Checklist*

  • I have tested the changes locally.
  • I have formatted the changes with Prettier and/or cargo fmt on default settings.

@jtriley-eth
Copy link
Contributor Author

nightly failure is a compiler bug, should be fixed in next nightly

Copy link
Member

@TomAFrench TomAFrench left a comment

Choose a reason for hiding this comment

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

We don't need to bump the minimum supported version if the library is still compatible with it, otherwise this becomes a breaking change.

We can just add 1.0.0-beta.0 to the test matrix

@jtriley-eth
Copy link
Contributor Author

added 0.36.0 back to test matrix, reverted Nargo toml file changes, & added section for compat

Comment on lines +5 to +14
## 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.
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.

@@ -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

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.

@Savio-Sou
Copy link

Superseded by #37?

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 "Noir Version Compatibility" section in README + Update to Noir v1.0.0-beta.0
3 participants