feat(docs): set up noir contracts in getting-started #1770

rahul-kothari · 2023-08-23T13:26:22Z

Fix #1699 - there was no set-up guide for noir contracts on getting started

Don't see a point to explain how to write, compile or deploy when these are already covered in multiple other places

rahul-kothari · 2023-08-23T13:36:04Z

@dan-aztec once the aztec-cli unbox command is ready, the sandbox.md and noir_contracts.md files in getting-started definitely need updates!

iAmMichaelConnor · 2023-08-23T13:38:03Z

I think we're 95% sure that the noir-libs/ directory will be branded as a library called 'Aztec.nr'. We could start introducing that name?

rahul-kothari · 2023-08-23T16:55:52Z

@iAmMichaelConnor done on the entire getting-started section

Maddiaa0

Overall solid section, ive a few minor nits

docs/docs/dev_docs/getting_started/noir.md

docs/docs/dev_docs/getting_started/noir_contracts.md

Maddiaa0 · 2023-08-24T20:03:03Z

docs/docs/dev_docs/getting_started/noir_contracts.md

+:::
+
+### Dependencies
+1. You will need the Noir build tool `nargo`, which you can install via [`noirup`](https://github.com/noir-lang/noirup). Make sure you install the `aztec` version of nargo:


nit: I would alter this section such that the bullet points are supported by sentences, rather than being sentences.

Nargo
nargo install instructions ...

Sandbox
Sandbox installation instructions / link

Starter repo
Link to starter repo

Maddiaa0 · 2023-08-24T20:04:23Z

docs/docs/dev_docs/getting_started/noir_contracts.md

+mkdir contracts
+```
+
+All contract projects will reside within this folder.


Might be worth noting that it does not need to live in contracts, this is just a style choice

docs/docs/dev_docs/getting_started/noir_contracts.md

Maddiaa0 · 2023-08-24T20:08:23Z

docs/docs/dev_docs/getting_started/noir_contracts.md

+
+3. Build the aztec.nr library on your machine.
+
+For this, clone the `aztec-packages` repository (which is the monorepo where the library resides) and build it anywhere on your machine


TODO: make an issue to adjust this, we need the library to be hosted elsewhere before launching

For sure. Removing step 3 entirely, and adding the git repo in toml should be the way to go.

Suggested change

For this, clone the `aztec-packages` repository (which is the monorepo where the library resides) and build it anywhere on your machine

For this, clone the `aztec-packages` repository (which is the monorepo where the library resides) and build it anywhere on your machine.

updated -> nargo.toml can now directly talk to a directory in a gh repo!

Maddiaa0 · 2023-08-24T20:12:13Z

docs/docs/dev_docs/getting_started/noir_contracts.md

+
+You are now ready to write your own contracts! 
+
+You can replace the content of the generated file `example_contract/src/main.nr` with your contract code.


Worth noting the current nargo new output is just a main file. We need to tell them to add the contract scope (granted that may be said in the linked next steps section below ) ( if it is ignore this )

This seems like something that should the starter-kit should handle or aztec cli init or just template on gh.

Contract scope replalcement is explained in another link

Maddiaa0 · 2023-08-24T20:17:17Z

docs/docs/dev_docs/getting_started/sandbox.md

@@ -6,7 +6,7 @@ import Image from "@theme/IdealImage";

 ## Introduction

-The Aztec Sandbox aims to provide a local development system against which you can build and test Noir contracts in a fast, safe, and free environment.
+The Aztec Sandbox aims to provide a local development system against which you can build and test Aztec.nr (read "aztec-noir") contracts in a fast, safe, and free environment.


I dont think the Aztec.nr distinction should be made here.

Agree. Think it is fine to leave it out, readers will figure out when they hit the page named Aztec.nr just a second later.

LHerskind

Inconsistent use of . at numbered lists at the end, and think it would be more easily to tell steps apart with a smaller heading instead of the list like that.

docs/docs/dev_docs/getting_started/sandbox.md

docs/docs/dev_docs/getting_started/noir_contracts.md

LHerskind · 2023-08-25T09:27:56Z

docs/sidebars.js

@@ -195,6 +195,7 @@ const sidebars = {
        "dev_docs/getting_started/noir",
        "dev_docs/getting_started/sandbox",
        "dev_docs/getting_started/cli",
+        "dev_docs/getting_started/noir_contracts",


Ordering wise, you could probably move this up above the cli. Logically, would like it to be right after noir, but since you are showing things into sandbox directories probably fine to have it there.

This is more a comment/reflection that something that necessarily needs changing.

LHerskind · 2023-08-25T09:30:32Z

docs/docs/dev_docs/getting_started/sandbox.md

@@ -6,7 +6,7 @@ import Image from "@theme/IdealImage";

 ## Introduction

-The Aztec Sandbox aims to provide a local development system against which you can build and test Noir contracts in a fast, safe, and free environment.
+The Aztec Sandbox aims to provide a local development system against which you can build and test Aztec.nr (read "aztec-noir") contracts in a fast, safe, and free environment.


Agree. Think it is fine to leave it out, readers will figure out when they hit the page named Aztec.nr just a second later.

LHerskind · 2023-08-25T09:33:21Z

docs/docs/dev_docs/getting_started/noir_contracts.md

+noirup -v aztec
+```
+
+2. [Have a running sandbox and a code repo to interact with it](./sandbox.md)


Would probably use a small header rather than the list. When looking over the steps it "vanishes in the crowd". Also would benefit by #1770 (comment).

LHerskind · 2023-08-25T09:41:54Z

docs/docs/dev_docs/getting_started/noir_contracts.md

+
+You are now ready to write your own contracts! 
+
+You can replace the content of the generated file `example_contract/src/main.nr` with your contract code.


This seems like something that should the starter-kit should handle or aztec cli init or just template on gh.

docs/docs/dev_docs/getting_started/noir_contracts.md

LHerskind · 2023-08-25T09:42:56Z

docs/docs/dev_docs/getting_started/noir_contracts.md

+
+3. Build the aztec.nr library on your machine.
+
+For this, clone the `aztec-packages` repository (which is the monorepo where the library resides) and build it anywhere on your machine


Suggested change

For this, clone the `aztec-packages` repository (which is the monorepo where the library resides) and build it anywhere on your machine

For this, clone the `aztec-packages` repository (which is the monorepo where the library resides) and build it anywhere on your machine.

iAmMichaelConnor · 2023-08-26T17:20:41Z

docs/docs/dev_docs/getting_started/noir.md

@@ -16,6 +16,8 @@ Noir is designed for accessible and flexible development of provable programs. I
 Noir is a public good for developing ZK-provable programs and is independent from building products on the existing Aztec network.
 :::

+While "Vanilla" Noir will be used to write circuits, we have created a library on top of Noir that will be used to write smart contracts on top of the Aztec Sandbox. Since noir files use the `.nr` extension, we are calling this library "Aztec.nr".


Is this page a duplicate of the landing page of the proper Noir docs? If so, we should probably replace all the text of this page with a link to Noir's docs.

Co-authored-by: Maddiaa <[email protected]> Co-authored-by: Lasse Herskind <[email protected]>

LHerskind

Fixed the broken link.

🤖 I have created a new Aztec Packages release --- ## [0.1.0-alpha52](v0.1.0-alpha51...v0.1.0-alpha52) (2023-09-05) ### Features * **docs:** set up noir contracts in getting-started ([#1770](#1770)) ([33eb99d](33eb99d)) ### Bug Fixes * Complete JS call stacks across ACVM wasm boundaries ([#2013](#2013)) ([8e84e46](8e84e46)) * deploy_ecr calculating CONTENT_HASH ([#2024](#2024)) ([edee198](edee198)) * Option to fail silently when retrying ([#2015](#2015)) ([453c9c1](453c9c1)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

rahul-kothari requested a review from iAmMichaelConnor August 23, 2023 13:26

rahul-kothari changed the title ~~get started on noir contracts~~ feat(docs): set up noir contracts in getting-started Aug 23, 2023

rahul-kothari force-pushed the rk/noir_sc_docs branch from 2e5b07a to a2742c4 Compare August 23, 2023 16:55

rahul-kothari requested review from LHerskind and Maddiaa0 August 24, 2023 15:42

Maddiaa0 reviewed Aug 24, 2023

View reviewed changes

LHerskind reviewed Aug 25, 2023

View reviewed changes

iAmMichaelConnor reviewed Aug 26, 2023

View reviewed changes

Maddiaa0 self-assigned this Aug 30, 2023

rahul-kothari force-pushed the rk/noir_sc_docs branch from 69a8dee to 33be50b Compare September 1, 2023 20:03

ludamad force-pushed the master branch from e2c543c to 0036e07 Compare September 3, 2023 22:02

rahul-kothari and others added 4 commits September 3, 2023 19:43

get started on noir contracts

a521531

use aztec.nr

f6cafdb

Apply suggestions from code review

489d80b

Co-authored-by: Maddiaa <[email protected]> Co-authored-by: Lasse Herskind <[email protected]>

update per comments

771bc0a

rahul-kothari force-pushed the rk/noir_sc_docs branch from b0df6dd to 771bc0a Compare September 4, 2023 02:43

rahul-kothari added 2 commits September 4, 2023 10:13

remove Noir.md in getting-started

1577f47

Merge branch 'master' into rk/noir_sc_docs

de51ea8

rahul-kothari enabled auto-merge (squash) September 4, 2023 17:14

rahul-kothari requested review from iAmMichaelConnor, Maddiaa0 and LHerskind September 4, 2023 17:14

chore: fix broken link

3dd0b1d

LHerskind approved these changes Sep 5, 2023

View reviewed changes

rahul-kothari merged commit 33eb99d into master Sep 5, 2023

rahul-kothari deleted the rk/noir_sc_docs branch September 5, 2023 15:24

github-actions bot mentioned this pull request Sep 5, 2023

chore(master): release 0.1.0-alpha52 #2020

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(docs): set up noir contracts in getting-started #1770

feat(docs): set up noir contracts in getting-started #1770

rahul-kothari commented Aug 23, 2023 •

edited

Loading

rahul-kothari commented Aug 23, 2023

iAmMichaelConnor commented Aug 23, 2023

rahul-kothari commented Aug 23, 2023

Maddiaa0 left a comment

Maddiaa0 Aug 24, 2023

Maddiaa0 Aug 24, 2023

Maddiaa0 Aug 24, 2023

LHerskind Aug 25, 2023

LHerskind Aug 25, 2023

rahul-kothari Sep 4, 2023

Maddiaa0 Aug 24, 2023

LHerskind Aug 25, 2023

rahul-kothari Sep 4, 2023

Maddiaa0 Aug 24, 2023

LHerskind Aug 25, 2023

LHerskind left a comment

LHerskind Aug 25, 2023

LHerskind Aug 25, 2023

LHerskind Aug 25, 2023

LHerskind Aug 25, 2023

LHerskind Aug 25, 2023

iAmMichaelConnor Aug 26, 2023

LHerskind left a comment


		3. Build the aztec.nr library on your machine.

		For this, clone the `aztec-packages` repository (which is the monorepo where the library resides) and build it anywhere on your machine


		You are now ready to write your own contracts!

		You can replace the content of the generated file `example_contract/src/main.nr` with your contract code.

feat(docs): set up noir contracts in getting-started #1770

feat(docs): set up noir contracts in getting-started #1770

Conversation

rahul-kothari commented Aug 23, 2023 • edited Loading

rahul-kothari commented Aug 23, 2023

iAmMichaelConnor commented Aug 23, 2023

rahul-kothari commented Aug 23, 2023

Maddiaa0 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

LHerskind left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

LHerskind left a comment

Choose a reason for hiding this comment

rahul-kothari commented Aug 23, 2023 •

edited

Loading