https://github.com/AztecProtocol/aztec-nr

https://github.com/AztecProtocol/aztec-nr

Last synced: 3 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/AztecProtocol/aztec-nr
• Owner: AztecProtocol
• License: apache-2.0
• Created: 2023-09-13T13:18:54.000Z (about 1 year ago)
• Default Branch: master
• Last Pushed: 2024-05-23T02:13:28.000Z (6 months ago)
• Last Synced: 2024-05-23T03:29:19.960Z (6 months ago)
• Language: Rust
• Size: 1.56 MB
• Stars: 89
• Watchers: 9
• Forks: 19
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


  


  
Aztec.nr


  


    Aztec Smart Contract Framework

  


  


    

    

    

    

  



# Aztec.nr

`Aztec-nr` is a [Noir](https://noir-lang.org) framework for smart contracts on [Aztec](aztec.network).

### Directory Structure

```

.

├── aztec               // The core of the aztec framework

├── easy-private-state  // A library for easily creating private state

├── safe-math           // A library for safe arithmetic

└── value-note          // A library for storing arbitrary values

```

## Installing Aztec-nr libraries

```toml

[package]

name = "your_contract"

authors = ["you! ;) "]

compiler_version = ""

type = "contract"

[dependencies]

# To install the aztec framework (required to create aztec contracts).

aztec = { git = "https://github.com/AztecProtocol/aztec-nr", tag = "master" , directory = "aztec" }

# Optional libraries

easy_private_state = { git = "https://github.com/AztecProtocol/aztec-nr", tag = "master" , directory = "easy-private-state" }

value_note = { git = "https://github.com/AztecProtocol/aztec-nr", tag = "master" , directory = "value-note" }

```

## Prerequisites

To use `Aztec.nr` you must have [Noir](https://noir-lang.org/) installed. Noir is a general purpose programming language for creating zero-knowledge-proofs. `Aztec.nr` supercharges the Noir language with Aztec Smart Contract capabilities.

### Quick Installation

The fastest way to install is with [noirup](https://noir-lang.org/docs/getting_started/installation/#installing-noirup).

To use `Aztec-nr` the `aztec` version of `Noir` is required (Note; this version is temporarily required if you would like to use `#[aztec()]` macros).

Once noirup is installed, you can run the following:

```bash

noirup -v NARGO_VERSION_COMPATIBLE_WITH_YOUR_SANDBOX

```

Replace `NARGO_VERSION_COMPATIBLE_WITH_YOUR_SANDBOX` with the version from the output of `aztec-cli get-node-info`:

```bash

aztec-cli get-node-info

```

For more installation options, please view [Noir's getting started.](https://noir-lang.org/docs/getting_started/installation/other_install_methods)