Skip to content

walnuthq/noir-libs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

54 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

noir-libs: Noir Package Manager CLI

noir-libs is a CLI application for the Noir Package Manager noir-libs.org.

Installation

Install the CLI: curl -s https://raw.githubusercontent.com/walnuthq/noir-libs/main/install.sh | bash

Usage: noir-libs --help

Features

The following features are supported:

  • Add a package from the package repository to a project: noir-libs add <package_name>@<package-version>. If no version is specified, the latest version will be fetched e.g. noir-libs add aztec
  • Remove a package from a project: noir-libs remove <package_name>

Supported packages

All supported packages are available at noir-libs.org.

Package locations

Fetched packages are stored in a cache folder. The exact location depends on the operating system:

  • Linux: /home/user/.cache/noir-libs/
  • macOS: /Users/user/Library/Application Support/com.walnut.noir-libs/
  • Windows: C:\Users\Alice\AppData\Local\walnut\noir-libs

Building from source

Build noir-libs using the following command: cargo build --release.

Testing

  1. Get the example package example.tar.gz from tests/test_files and extract it to an unrelated folder.
  2. Ensure you have everything set up for Aztec development.
  3. Try compiling the example with: aztec-nargo compile. It should fail due to missing dependencies.
  4. Install noir-libs by following the instructions in the Installation section above.
  5. In your example folder, add the necessary dependencies using the following commands:
    1. noir-libs add easy_private_state
    2. noir-libs add aztec
    3. noir-libs add value_note
  6. Compile again with aztec-nargo compile
  7. Check that everything worked this time.

Acknowledgments

A lot of inspiration for noir-libs was taken from scarb, built by Software Mansion.