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

Jump to bottom

bbup to query nargo --version and lookup a compatible version of bb to install if no version is provided. #8530

Closed
TomAFrench opened this issue Sep 13, 2024 · 2 comments · Fixed by #9073
Closed

bbup to query nargo --version and lookup a compatible version of bb to install if no version is provided. #8530

TomAFrench opened this issue Sep 13, 2024 · 2 comments · Fixed by #9073
Assignees
@signorecello
Labels
A-installation Area: issues relating to installing / building something. A-ux/devex Area: relates to external ux / devex. (Users typically are devs) (See also A-internal-devex) C-bb-bin Component: Barretenberg executable binary

Comments

@TomAFrench
Copy link
Member

Currently the only tracking of the compatibility between nargo and bb versions is done in the docs readme and users are expected to copy this across into the CLI.

An alternative solution is that we put this into a json file or similar (or even just leave it as a plain text file), and if no version is specified by the user we have bbup query nargo --version, extract the version number and then perform a lookup against this mapping file on github. bbup can then go download a compatible version of bb for the version of nargo the user has installed.
@github-project-automation github-project-automation bot moved this to Todo in A3 Sep 13, 2024
@Savio-Sou Savio-Sou added A-ux/devex Area: relates to external ux / devex. (Users typically are devs) (See also A-internal-devex) C-bb-bin Component: Barretenberg executable binary A-installation Area: issues relating to installing / building something. C-noir Component: Noir/Nargo labels Oct 3, 2024
@Savio-Sou
Copy link
Member

Savio-Sou commented Oct 3, 2024 •
edited
Loading

Happy Case:

  1. Dev runs bbup
  2. bbup checks for the Nargo version installed locally
    1. If Nargo exists, install the corresponding bb version
    2. If Nargo does not exist, install the latest stable version of Nargo + install the corresponding bb version

Stretch goal (nice-to-have, not required to close this issue):

  1. Dev runs bbup --noir-version 0.34.0
  2. bbup automatically installs bb 0.55.0 (the version tested compatible with Noir 0.34.0)

@Savio-Sou
Copy link
Member

Does this Issue also imply a prerequisite Issue that ensures:

  • bb tests against Noir versions
  • bb stores a list of bb <> Noir version compatibilities

@Savio-Sou Savio-Sou mentioned this issue Oct 8, 2024
Closed
@signorecello signorecello mentioned this issue Oct 8, 2024
Merged
@Savio-Sou Savio-Sou removed the C-noir Component: Noir/Nargo label Oct 8, 2024
@Savio-Sou Savio-Sou mentioned this issue Oct 8, 2024
Merged
4 tasks
signorecello added a commit that referenced this issue Oct 10, 2024
@signorecello @Savio-Sou
chore(docs): rewriting bbup script, refactoring bb readme for clarity (…
662b61e 
…#9073)

## Description

Closes #8530

Closes #7511
#7525 as no longer
useful / relevant

This PR updates the Barretenberg README with more information about the
project, its installation, usage, and development.

It also refactors `bbup` with `commander` to match the rest of the
repository's CLI tooling.

## Changes

### bb readme
- Added a project banner and reorganized the README structure
- Expanded usage instructions for UltraHonk and MegaHonk

### bbup
- Refactored bbup installation script and related files
- Included detailed installation instructions in its README

## Testing

`bbup` won't change much so it is deployed manually on `npm`. You can
try it immediately with:

```bash
curl -L bbup.dev | bash
bbup
```

---------

Co-authored-by: Savio <[email protected]>
@github-project-automation github-project-automation bot moved this from Todo to Done in A3 Oct 10, 2024
@iAmMichaelConnor iAmMichaelConnor removed this from A3 Oct 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@signorecello signorecello

Labels
A-installation Area: issues relating to installing / building something. A-ux/devex Area: relates to external ux / devex. (Users typically are devs) (See also A-internal-devex) C-bb-bin Component: Barretenberg executable binary
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

chore(docs): rewriting bbup script, refactoring bb readme for clarity AztecProtocol/aztec-packages
3 participants
@TomAFrench @signorecello @Savio-Sou