From 31727d4f349a153e35f6040604e1ee55b572cf3d Mon Sep 17 00:00:00 2001 From: Josh Crites Date: Tue, 26 Sep 2023 09:25:21 -0400 Subject: [PATCH 1/2] remove "standard" --- docs/docs/dev_docs/contracts/main.md | 5 +++-- docs/docs/dev_docs/tutorials/writing_token_contract.md | 6 +++--- 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/docs/docs/dev_docs/contracts/main.md b/docs/docs/dev_docs/contracts/main.md index 24eb96e379c..f7fcacf8208 100644 --- a/docs/docs/dev_docs/contracts/main.md +++ b/docs/docs/dev_docs/contracts/main.md @@ -25,15 +25,16 @@ To write an Aztec.nr contract, you need to write Noir, which requires a build to :::info -For those coming from vanilla Noir, the nargo version used for aztec.nr is tracked seaprately to nargo for vanilla noir, so be sure to use the nargo version shown above +For those coming from vanilla Noir, the nargo version used for aztec.nr is tracked seaprately to nargo for vanilla noir, so be sure to use the nargo version shown above ::: + ## Install Noir tooling 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). ## Tutorials -See the [Standard Token Contract tutorial](../tutorials/writing_token_contract.md) for more info on getting set up to write contracts. +See the [Token Contract tutorial](../tutorials/writing_token_contract.md) for more info on getting set up to write contracts. ## Learn more diff --git a/docs/docs/dev_docs/tutorials/writing_token_contract.md b/docs/docs/dev_docs/tutorials/writing_token_contract.md index c92a3b1ae44..758677a92ab 100644 --- a/docs/docs/dev_docs/tutorials/writing_token_contract.md +++ b/docs/docs/dev_docs/tutorials/writing_token_contract.md @@ -1,6 +1,6 @@ -# Writing a Standard token contract in Aztec.nr +# Writing a token contract in Aztec.nr -In this tutorial we will go through writing a standard L2 native token contract +In this tutorial we will go through writing an L2 native token contract for the Aztec Network, using the Aztec.nr contract libraries. It is recommended that you go through the [the introduction to contracts](../contracts/main.md) and [setup instructions](../contracts/setup.md) section before this tutorial to gain some familiarity with writing Aztec smart contracts. This tutorial is intended to help you get familiar with the Aztec.nr library, Aztec contract syntax and some of the underlying structure of the Aztec network. @@ -502,6 +502,6 @@ https://github.com/AztecProtocol/aztec-packages/blob/master/yarn-project/end-to- ### Token Bridge Contract -The [token bridge tutorial](https://github.com/AztecProtocol/dev-rel/tree/main/tutorials/token-bridge-standard) is a great follow up to this one. +The [token bridge tutorial](https://github.com/AztecProtocol/dev-rel/tree/main/tutorials/token-bridge) is a great follow up to this one. It builds on the Token contract described here and goes into more detail about Aztec contract composability and Ethereum (L1) and Aztec (L2) cross-chain messaging. From ce527bf460a22b229ce7cb665c26d7e3323d1d94 Mon Sep 17 00:00:00 2001 From: Josh Crites Date: Tue, 26 Sep 2023 10:05:52 -0400 Subject: [PATCH 2/2] missed 2 --- docs/docs/dev_docs/contracts/portals/main.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/docs/dev_docs/contracts/portals/main.md b/docs/docs/dev_docs/contracts/portals/main.md index 559219d8027..0ff0bc24d40 100644 --- a/docs/docs/dev_docs/contracts/portals/main.md +++ b/docs/docs/dev_docs/contracts/portals/main.md @@ -95,7 +95,7 @@ As noted earlier, the portal contract should check that the sender is as expecte - Initialize l1 with l2 address for access control. -## Standards +## Considerations ### Structure of messages The application developer should consider creating messages that follow a function call structure e.g., using a function signature and arguments. This will make it easier to prevent producing messages that could be misinterpreted by the recipient. @@ -177,7 +177,7 @@ The order of execution can be constrained in the contract. Since all of the mess Note, that crossing the L1/L2 chasm is asynchronous, so there could be a situation where the user has burned their assets on L2 but the swap fails on L1! This could be due to major price movements or the like. In such a case, the user could be stuck with funds on L1 that they cannot get back to L2 unless the portal contract implements a way to properly handle such errors. :::caution -Designated callers are enforced at the contract level for contracts that are not the rollup itself, and should not be trusted to implement the standard correctly. The user should always be aware that it is possible for the developer to implement something that looks like designated caller without providing the abilities to the user. +Designated callers are enforced at the contract level for contracts that are not the rollup itself, and should not be trusted to implement the contract correctly. The user should always be aware that it is possible for the developer to implement something that looks like designated caller without providing the abilities to the user. ::: ## Examples of portals