This repository has been archived by the owner on Apr 20, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 14
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
update installation docs to use noirup
- Loading branch information
1 parent
01d1aad
commit 051dc60
Showing
1 changed file
with
86 additions
and
122 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,178 +1,142 @@ | ||
| # Installation | ||
|
|
||
| There are two approaches to install Nargo: | ||
| We'll download Nargo through `noirup`, a command line tool for managing Noir versions and associated tools. You'll need an internet connection for the download. | ||
|
|
||
| - [Option 1: Binaries](#option-1-binaries) | ||
| - [Option 2: Compile from Source](#option-2-compile-from-source) | ||
| > Note: `noirup` currently only supports Linux and macOS. If you're using Windows, please see the section TODO | ||
| Optionally you can also install [Noir VS Code extension] for syntax highlighting. | ||
|
|
||
| ## Option 1: Binaries | ||
| ## Installing `noirup` on Linux or macOS | ||
|
|
||
| ### Step 1 | ||
|
|
||
| Paste and run the following in the terminal to extract and install the binary: | ||
|
|
||
| > **macOS / Linux:** If you are prompted with `Permission denied` when running commands, prepend `sudo` and re-run it. | ||
| #### macOS (Apple Silicon) | ||
| If you’re using Linux or macOS, open a terminal and enter the following command: | ||
|
|
||
| ```bash | ||
| mkdir -p $HOME/.nargo/bin && \ | ||
| curl -o $HOME/.nargo/bin/nargo-aarch64-apple-darwin.tar.gz -L https://github.com/noir-lang/noir/releases/download/nightly/nargo-aarch64-apple-darwin.tar.gz && \ | ||
| tar -xvf $HOME/.nargo/bin/nargo-aarch64-apple-darwin.tar.gz -C $HOME/.nargo/bin/ && \ | ||
| echo '\nexport PATH=$PATH:$HOME/.nargo/bin' >> ~/.zshrc && \ | ||
| source ~/.zshrc | ||
| curl -L https://github.com/noir-lang/noirup/releases/download/v0.1.1/noirup | bash | ||
| ``` | ||
|
|
||
| #### macOS (Intel) | ||
| The command downloads a script and starts the installation of the `noirup` tool. If the install is successful, the following line will appear: | ||
|
|
||
| ```bash | ||
| mkdir -p $HOME/.nargo/bin && \ | ||
| curl -o $HOME/.nargo/bin/nargo-x86_64-apple-darwin.tar.gz -L https://github.com/noir-lang/noir/releases/download/nightly/nargo-x86_64-apple-darwin.tar.gz && \ | ||
| tar -xvf $HOME/.nargo/bin/nargo-x86_64-apple-darwin.tar.gz -C $HOME/.nargo/bin/ && \ | ||
| echo '\nexport PATH=$PATH:$HOME/.nargo/bin' >> ~/.zshrc && \ | ||
| source ~/.zshrc | ||
| ``` | ||
|
|
||
| #### Windows (PowerShell) | ||
|
|
||
| Open PowerShell as Administrator and run: | ||
|
|
||
| ```sh | ||
| mkdir -f -p "$env:USERPROFILE\.nargo\bin\"; ` | ||
| Invoke-RestMethod -Method Get -Uri https://github.com/noir-lang/noir/releases/download/nightly/nargo-x86_64-pc-windows-msvc.zip -Outfile "$env:USERPROFILE\.nargo\bin\nargo-x86_64-pc-windows-msvc.zip"; ` | ||
| Expand-Archive -Path "$env:USERPROFILE\.nargo\bin\nargo-x86_64-pc-windows-msvc.zip" -DestinationPath "$env:USERPROFILE\.nargo\bin\"; ` | ||
| $Reg = "Registry::HKLM\System\CurrentControlSet\Control\Session Manager\Environment"; ` | ||
| $OldPath = (Get-ItemProperty -Path "$Reg" -Name PATH).Path; ` | ||
| $NewPath = $OldPath + ’;’ + "$env:USERPROFILE\.nargo\bin\"; ` | ||
| Set-ItemProperty -Path "$Reg" -Name PATH –Value "$NewPath"; ` | ||
| $env:Path = [System.Environment]::GetEnvironmentVariable("Path","Machine") + ";" + [System.Environment]::GetEnvironmentVariable("Path","User") | ||
| Detected your preferred shell is bash and added noirup to PATH. Run 'source /home/user/.bashrc' or start a new terminal session to use noirup. | ||
| Then, simply run 'noirup' to install Nargo. | ||
| ``` | ||
|
|
||
| #### Linux (Bash) | ||
| See [GitHub Releases](https://github.com/noir-lang/noir/releases/tag/nightly) for additional platform specific binaries. | ||
| The installation of `noirup` can be verified by running the command | ||
|
|
||
| ```bash | ||
| mkdir -p $HOME/.nargo/bin && \ | ||
| curl -o $HOME/.nargo/bin/nargo-x86_64-unknown-linux-gnu.tar.gz -L https://github.com/noir-lang/noir/releases/download/nightly/nargo-x86_64-unknown-linux-gnu.tar.gz && \ | ||
| tar -xvf $HOME/.nargo/bin/nargo-x86_64-unknown-linux-gnu.tar.gz -C $HOME/.nargo/bin/ && \ | ||
| echo '\nexport PATH=$PATH:$HOME/.nargo/bin' >> ~/.bashrc && \ | ||
| source ~/.bashrc | ||
| $ noirup --help | ||
| The installer for Nargo. | ||
| Update or revert to a specific Nargo version with ease. | ||
| USAGE: | ||
| noirup <OPTIONS> | ||
| OPTIONS: | ||
| -h, --help Print help information | ||
| -v, --version Install a specific version | ||
| -b, --branch Install a specific branch | ||
| -P, --pr Install a specific Pull Request | ||
| -C, --commit Install a specific commit | ||
| -r, --repo Install from a remote GitHub repo (uses default branch if no other options are set) | ||
| -p, --path Install a local repository | ||
| ``` | ||
| ### Step 2 | ||
| ## Installing Nargo | ||
| Check if the installation was successful by running `nargo --help`. | ||
| Once `noirup` has been installed there are two approaches of installing Nargo. Either installing one of the prebuilt binaries distributed by the Noir team or building from source. | ||
| > **macOS:** If you are prompted with an OS alert, right-click and open the _nargo_ executable from Finder. Close the new terminal popped up and `nargo` should now be accessible. | ||
| Prebuilt binaries are much easier to install however the backend runs within WASM which impacts performance. Building from source runs the backend natively and so is recommended in performance critical scenarios. | ||
| For a successful installation, you should see something similar to the following after running the command: | ||
| ## Prebuilt Binaries | ||
| ``` | ||
| $ nargo --help | ||
| Noir's package manager | ||
| Usage: nargo <COMMAND> | ||
| Noirup allows installation of prebuilt binaries for stable releases of Noir. For example, you can install the `0.3.2` release of Nargo by running the command | ||
| Commands: | ||
| check Checks the constraint system for errors | ||
| codegen-verifier Generates a Solidity verifier smart contract for the program | ||
| compile Compile the program and its secret execution trace into ACIR format | ||
| new Create a new binary project | ||
| execute Executes a circuit to calculate its return value | ||
| prove Create proof for this program. The proof is returned as a hex encoded string | ||
| verify Given a proof and a program, verify whether the proof is valid | ||
| test Run the tests for this program | ||
| gates Counts the occurrences of different gates in circuit | ||
| help Print this message or the help of the given subcommand(s) | ||
| ```bash | ||
| noirup -v 0.3.2 | ||
| ``` | ||
| ## Option 2: Compile from Source | ||
| ### Setup | ||
| See [GitHub Releases](https://github.com/noir-lang/noir/releases/) to see other versions which can be installed. | ||
| 1. Install [Git] and [Rust]. | ||
| ### Updating Nargo | ||
| 2. Download Noir's source code from Github by running: | ||
| Once Nargo is installed via `noirup`, updating to a newly released version is easy. From your shell, run the same command again with the version of Nargo you wish to install. | ||
| ```bash | ||
| git clone [email protected]:noir-lang/noir.git | ||
| ``` | ||
| ```bash | ||
| noirup -v 0.4.0 | ||
| ``` | ||
| 3. Change directory into the Noir project by running: | ||
| ## Compilation from Source | ||
| ```bash | ||
| cd noir | ||
| ``` | ||
| ### Installing dependencies | ||
| There are then two approaches to proceed, differing in how the proving backend is installed: | ||
| In order to compile Nargo `noirup` requires access to [Git] and [Rust] so these must be installed. As well as the dependencies for Nargo you must install the dependencies for the [Barretenberg] proving backend. | ||
| ### Option 2.1: Install Executable with WASM backend | ||
| #### macOS | ||
| 4. Install Nargo by running: | ||
| Installing through [Homebrew] is recommended: | ||
| ```bash | ||
| cargo install --locked --path=crates/nargo --no-default-features --features plonk_bn254_wasm | ||
| ``` | ||
| ```bash | ||
| brew install cmake llvm libomp | ||
| ``` | ||
| ### Option 2.2: Install Executable with Native Backend | ||
| #### Ubuntu (Linux) | ||
| The [barretenberg] proving backend is written in C++, hence compiling it from source would first require certain dependencies to be installed. | ||
| ```bash | ||
| sudo apt update && sudo apt install clang lld cmake libomp-dev | ||
| ``` | ||
| 4. Install [CMake], [LLVM] and [OpenMP]: | ||
| Other variants of Linux will need to adjust the commands for their package manager. | ||
| #### macOS | ||
| ### Compilation | ||
| Installing through [Homebrew] is recommended: | ||
| Once all of Nargo's and Barretenberg's dependencies are installed, you can compile Nargo by calling | ||
| ```bash | ||
| brew install cmake llvm libomp | ||
| ``` | ||
| ```bash | ||
| noirup -c 29b1f7d # Commit hash of 0.3.2 release | ||
| ``` | ||
| #### Ubuntu (Linux) | ||
| ### Verifying installation | ||
| ```bash | ||
| sudo apt update && sudo apt install clang lld cmake libomp-dev | ||
| ``` | ||
| Check if the installation was successful by running `nargo --help`. | ||
| Other variants of Linux will need to adjust the commands for their package manager. | ||
| > **macOS:** If you are prompted with an OS alert, right-click and open the _nargo_ executable from Finder. Close the new terminal popped up and `nargo` should now be accessible. | ||
| #### Windows | ||
| For a successful installation, you should see something similar to the following after running the command: | ||
| ```sh | ||
| TBC | ||
| ``` | ||
| ``` | ||
| $ nargo --help | ||
| nargo 0.3.2 | ||
| 5. Install Nargo by running: | ||
| Usage: nargo <COMMAND> | ||
| ```bash | ||
| cargo install --locked --path=crates/nargo | ||
| ``` | ||
| Commands: | ||
| check Checks the constraint system for errors | ||
| codegen-verifier Generates a Solidity verifier smart contract for the program | ||
| compile Compile the program and its secret execution trace into ACIR format | ||
| new Create a new binary project | ||
| execute Executes a circuit to calculate its return value | ||
| prove Create proof for this program. The proof is returned as a hex encoded string | ||
| verify Given a proof and a program, verify whether the proof is valid | ||
| test Run the tests for this program | ||
| gates Counts the occurrences of different gates in circuit | ||
| help Print this message or the help of the given subcommand(s) | ||
| ``` | ||
| ### Verify Installation | ||
| ## Installing on Windows | ||
| 6. Check if the installation was successful by running `nargo --help`: | ||
| While it's not possible to install Nargo using `noirup` on Windows, the Noir team does distribute prebuilt binaries on Windows. | ||
| ``` | ||
| $ nargo --help | ||
| Noir's package manager | ||
| In order to install the latest version of Nargo, open PowerShell as Administrator and run: | ||
| Usage: nargo <COMMAND> | ||
| ```sh | ||
| mkdir -f -p "$env:USERPROFILE\.nargo\bin\"; ` | ||
| Invoke-RestMethod -Method Get -Uri https://github.com/noir-lang/noir/releases/download/nightly/nargo-x86_64-pc-windows-msvc.zip -Outfile "$env:USERPROFILE\.nargo\bin\nargo-x86_64-pc-windows-msvc.zip"; ` | ||
| Expand-Archive -Path "$env:USERPROFILE\.nargo\bin\nargo-x86_64-pc-windows-msvc.zip" -DestinationPath "$env:USERPROFILE\.nargo\bin\"; ` | ||
| $Reg = "Registry::HKLM\System\CurrentControlSet\Control\Session Manager\Environment"; ` | ||
| $OldPath = (Get-ItemProperty -Path "$Reg" -Name PATH).Path; ` | ||
| $NewPath = $OldPath + ’;’ + "$env:USERPROFILE\.nargo\bin\"; ` | ||
| Set-ItemProperty -Path "$Reg" -Name PATH –Value "$NewPath"; ` | ||
| $env:Path = [System.Environment]::GetEnvironmentVariable("Path","Machine") + ";" + [System.Environment]::GetEnvironmentVariable("Path","User") | ||
| ``` | ||
| Commands: | ||
| check Checks the constraint system for errors | ||
| codegen-verifier Generates a Solidity verifier smart contract for the program | ||
| compile Compile the program and its secret execution trace into ACIR format | ||
| new Create a new binary project | ||
| execute Executes a circuit to calculate its return value | ||
| prove Create proof for this program. The proof is returned as a hex encoded string | ||
| verify Given a proof and a program, verify whether the proof is valid | ||
| test Run the tests for this program | ||
| gates Counts the occurrences of different gates in circuit | ||
| help Print this message or the help of the given subcommand(s) | ||
| ``` | ||
| [git]: https://git-scm.com/book/en/v2/Getting-Started-Installing-Git | ||
| [rust]: https://www.rust-lang.org/tools/install | ||
|
|
||