-
Notifications
You must be signed in to change notification settings - Fork 236
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
chore(docs): rename to aztec.nr #1943
Changes from 2 commits
b59b466
02a142d
4549d16
c28479b
c48508a
b560bf9
3337995
45493f6
ee7c615
9bef08e
86e8a0c
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,7 +2,7 @@ | |
|
||
## What is Aztec.nr? | ||
|
||
**Aztec.nr** is a library for writing Aztec smart contracts. | ||
**Aztec.nr** is a framework for writing Aztec smart contracts. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Interesting. I am good with this distinction There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. In the state_model.md doc, it says "The goal of the Aztec.nr smart contract library" -- should that say framework or am I missing the distinction? |
||
|
||
## Nomenclature | ||
|
||
|
@@ -12,17 +12,17 @@ A **smart contract** is just a collection of persistent state variables, and a c | |
|
||
An **Aztec smart contract** is a smart contract with **private** state variables and **private** functions. | ||
|
||
**Aztec.nr** is a library for writing Aztec smart contracts, written in Noir. | ||
**Aztec.nr** is a framework for writing Aztec smart contracts, written in Noir. | ||
|
||
# Getting started | ||
|
||
## Install Noir | ||
|
||
To write a Noir Contract, you need to write Noir, and to write Noir, you need to [install Nargo](https://noir-lang.org/getting_started/nargo_installation). | ||
To write an Aztec.nr contract, you need to write Noir, and to write Noir, you need to [install Nargo](https://noir-lang.org/getting_started/nargo_installation). | ||
|
||
## Install Noir tooling | ||
|
||
There are a number of tools to make writing Noir Contracts more pleasant. See [here](https://github.com/noir-lang/awesome-noir#get-coding). | ||
There are a number of tools to make writing Aztec.nr contracts more pleasant. See [here](https://github.com/noir-lang/awesome-noir#get-coding). | ||
|
||
## Quick start | ||
|
||
|
@@ -31,7 +31,7 @@ Starter kit | |
::: | ||
|
||
|
||
## Example Noir Contract | ||
## Example Aztec.nr Contract | ||
|
||
In keeping with the origins of blockchain, here's an example of a simple private token contract. Everyone's balances are private. | ||
|
||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,2 @@ | ||
See Noir docs for Noir types. | ||
See [state_variables](./state_variables.md) for Noir Contract state variable types. | ||
See [state_variables](./state_variables.md) for Aztec.nr state variable types. |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
# Noir contract workflow | ||
# Aztec.nr smart contract workflow | ||
|
||
## Write | ||
|
||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
must be some AI in your find replace :D