From 0c6a72d46532de1b46afd00987373787219c6ea0 Mon Sep 17 00:00:00 2001 From: Paterson <86971279+paterson1@users.noreply.github.com> Date: Tue, 9 Jan 2024 13:14:16 -0300 Subject: [PATCH] Fix broken links --- docs/docs/dev_docs/contracts/layout.md | 4 ++-- docs/docs/dev_docs/contracts/main.md | 2 +- docs/docs/dev_docs/contracts/syntax/functions.md | 2 +- docs/docs/dev_docs/contracts/syntax/main.md | 2 +- docs/docs/dev_docs/contracts/workflow.md | 2 +- docs/docs/dev_docs/getting_started/aztecnr-getting-started.md | 2 +- docs/docs/dev_docs/wallets/writing_an_account_contract.md | 2 +- yarn-project/aztec-nr/README.md | 2 +- 8 files changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/docs/dev_docs/contracts/layout.md b/docs/docs/dev_docs/contracts/layout.md index 839bf28b8f5..d1fa4a7254a 100644 --- a/docs/docs/dev_docs/contracts/layout.md +++ b/docs/docs/dev_docs/contracts/layout.md @@ -20,7 +20,7 @@ contract MyContract { } ``` :::info A note for vanilla Noir devs -There is no [`main()`](https://noir-lang.org/getting_started/breakdown/#mainnr) function within a Noir `contract` scope. More than one function can be an entrypoint. +There is no [`main()`](https://noir-lang.org/docs/getting_started/breakdown/#mainnr) function within a Noir `contract` scope. More than one function can be an entrypoint. ::: ## Directory structure @@ -34,5 +34,5 @@ Here's a common layout for a basic Aztec.nr Contract project: └── Nargo.toml <-- package and dependency management ``` -- See the vanilla Noir docs for [more info on packages](https://noir-lang.org/modules_packages_crates/crates_and_packages). +- See the vanilla Noir docs for [more info on packages](https://noir-lang.org/docs/modules_packages_crates/crates_and_packages). - You can review the structure of a complete contract in the token contract tutorial [here](../tutorials/writing_token_contract.md). diff --git a/docs/docs/dev_docs/contracts/main.md b/docs/docs/dev_docs/contracts/main.md index 00b11485ce8..d95211b3cd8 100644 --- a/docs/docs/dev_docs/contracts/main.md +++ b/docs/docs/dev_docs/contracts/main.md @@ -28,7 +28,7 @@ For those coming from vanilla Noir, the version used for aztec.nr is tracked sep ## Install `nargo` (recommended) -`aztec-nargo` comes with the Noir compiler, so installing `nargo` is not required, however it is recommended as it provides a better developer experience for writing contracts. You will need nargo installed to take advantage of the [Noir Language Server](https://noir-lang.org/nargo/language_server), which provides syntax highlighting and formatting for your Aztec contracts. +`aztec-nargo` comes with the Noir compiler, so installing `nargo` is not required, however it is recommended as it provides a better developer experience for writing contracts. You will need nargo installed to take advantage of the [Noir Language Server](https://noir-lang.org/docs/nargo/language_server), which provides syntax highlighting and formatting for your Aztec contracts. You can install `nargo` with the following commands: diff --git a/docs/docs/dev_docs/contracts/syntax/functions.md b/docs/docs/dev_docs/contracts/syntax/functions.md index 615c144c44f..4a2cfdf753f 100644 --- a/docs/docs/dev_docs/contracts/syntax/functions.md +++ b/docs/docs/dev_docs/contracts/syntax/functions.md @@ -81,7 +81,7 @@ As alluded to earlier, a private function operates on private information, and i ## `unconstrained` functions -Unconstrained functions are an underlying part of Noir - a deeper explanation can be found [here](https://noir-lang.org/language_concepts/unconstrained). But in short, they are functions which are not directly constrained and therefore should be seen as untrusted! That they are untrusted means that, for security, the developer must make sure to constrain them when used! +Unconstrained functions are an underlying part of Noir - a deeper explanation can be found [here](https://noir-lang.org/docs/language_concepts/unconstrained). But in short, they are functions which are not directly constrained and therefore should be seen as untrusted! That they are untrusted means that, for security, the developer must make sure to constrain them when used! Beyond using them inside your other functions, they are convenient for providing an interface that reads storage, applies logic and returns values to a UI or test. Below is a snippet from exposing the `balance_of_private` function from a token implementation, which allows a user to easily read their balance, similar to the `balanceOf` function in the ERC20 standard. diff --git a/docs/docs/dev_docs/contracts/syntax/main.md b/docs/docs/dev_docs/contracts/syntax/main.md index 599c19d379d..cf30952f290 100644 --- a/docs/docs/dev_docs/contracts/syntax/main.md +++ b/docs/docs/dev_docs/contracts/syntax/main.md @@ -5,7 +5,7 @@ import { AztecPackagesVersion } from "@site/src/components/Version"; [Noir](https://noir-lang.org/) is a language which is agnostic to proof systems and use cases. Rather than baking Aztec-specific keywords and smart contract types directly into Noir (which would break this agnosticism), we have developed a framework -- written in Noir -- whose types and methods provide rich smart contract semantics. -On top of [Noir's stdlib](https://noir-lang.org/standard_library/cryptographic_primitives/), we provide [Aztec.nr](https://github.com/AztecProtocol/aztec-packages/tree/master/yarn-project/aztec-nr) for writing contracts on Aztec. +On top of [Noir's stdlib](https://noir-lang.org/docs/standard_library/cryptographic_primitives/), we provide [Aztec.nr](https://github.com/AztecProtocol/aztec-packages/tree/master/yarn-project/aztec-nr) for writing contracts on Aztec. Aztec.nr contains abstractions which remove the need to understand the low-level Aztec protocol. Notably, it provides: diff --git a/docs/docs/dev_docs/contracts/workflow.md b/docs/docs/dev_docs/contracts/workflow.md index f0d9bbe1b9d..60c6ab02461 100644 --- a/docs/docs/dev_docs/contracts/workflow.md +++ b/docs/docs/dev_docs/contracts/workflow.md @@ -15,7 +15,7 @@ title: Contract Workflow ## Unit Tests -[Test individual noir functions](https://noir-lang.org/nargo/testing). +[Test individual noir functions](https://noir-lang.org/docs/nargo/testing). ## Deploy diff --git a/docs/docs/dev_docs/getting_started/aztecnr-getting-started.md b/docs/docs/dev_docs/getting_started/aztecnr-getting-started.md index abc144a5f62..a0e4b2f6f47 100644 --- a/docs/docs/dev_docs/getting_started/aztecnr-getting-started.md +++ b/docs/docs/dev_docs/getting_started/aztecnr-getting-started.md @@ -208,7 +208,7 @@ Congratulations, you have now written, compiled, and deployed your first Aztec.n ## Install `nargo` (recommended) -The CLI comes with the Noir compiler, so installing `nargo` is not required, however it is recommended as it provides a better developer experience for writing contracts. You will need nargo installed to take advantage of the [Noir Language Server](https://noir-lang.org/nargo/language_server), which provides syntax highlighting and formatting for your Aztec contracts. +The CLI comes with the Noir compiler, so installing `nargo` is not required, however it is recommended as it provides a better developer experience for writing contracts. You will need nargo installed to take advantage of the [Noir Language Server](https://noir-lang.org/docs/nargo/language_server), which provides syntax highlighting and formatting for your Aztec contracts. You will also need `nargo` if you want to run unit tests in Noir. diff --git a/docs/docs/dev_docs/wallets/writing_an_account_contract.md b/docs/docs/dev_docs/wallets/writing_an_account_contract.md index ea4cb859c19..adce1fbe0fd 100644 --- a/docs/docs/dev_docs/wallets/writing_an_account_contract.md +++ b/docs/docs/dev_docs/wallets/writing_an_account_contract.md @@ -76,7 +76,7 @@ As you can see in the snippet above, to fill in this base class, we need to defi In our case, the auth witness will be generated by Schnorr-signing over the message identifier using the hardcoded key. To do this, we are using the `Schnorr` signer from the `@aztec/circuits.js` package to sign over the payload hash. This signer maps to exactly the same signing scheme that Noir's standard library expects in `schnorr::verify_signature`. :::info -More signing schemes are available in case you want to experiment with other types of keys. Check out Noir's [documentation on cryptographic primitives](https://noir-lang.org/standard_library/cryptographic_primitives). +More signing schemes are available in case you want to experiment with other types of keys. Check out Noir's [documentation on cryptographic primitives](https://noir-lang.org/docs/standard_library/cryptographic_primitives). ::: ## Trying it out diff --git a/yarn-project/aztec-nr/README.md b/yarn-project/aztec-nr/README.md index a228f280565..cef96af66e3 100644 --- a/yarn-project/aztec-nr/README.md +++ b/yarn-project/aztec-nr/README.md @@ -53,7 +53,7 @@ value_note = { git = "https://github.com/AztecProtocol/aztec-nr", tag = "master" 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/getting_started/nargo_installation#option-1-noirup). +The fastest way to install is with [noirup](https://noir-lang.org/docs/getting_started/nargo_installation#option-1-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).