From 48e7a27d04f013ea9d872aa680b5f3e9c3144bc5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jan=20Bene=C5=A1?= Date: Sat, 14 Oct 2023 14:10:50 +0200 Subject: [PATCH] Apply suggestions from code review Co-authored-by: Lasse Herskind <16536249+LHerskind@users.noreply.github.com> --- docs/docs/dev_docs/cli/main.md | 2 +- docs/docs/dev_docs/contracts/compiling.md | 4 ++-- docs/docs/dev_docs/getting_started/sandbox.md | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/docs/dev_docs/cli/main.md b/docs/docs/dev_docs/cli/main.md index 092321e0c8ab..57228a12c620 100644 --- a/docs/docs/dev_docs/cli/main.md +++ b/docs/docs/dev_docs/cli/main.md @@ -87,7 +87,7 @@ export ADDRESS2= ## Deploying a Token Contract -We will now deploy a token contract using the `deploy` command, and set and an address of admin via a constructor argument. +We will now deploy a token contract using the `deploy` command, and set an address of the admin via a constructor argument. Make sure to replace this address with one of the two you created earlier. #include_code deploy yarn-project/end-to-end/src/cli_docs_sandbox.test.ts bash diff --git a/docs/docs/dev_docs/contracts/compiling.md b/docs/docs/dev_docs/contracts/compiling.md index 6a6c70151f1e..78a871a76c1a 100644 --- a/docs/docs/dev_docs/contracts/compiling.md +++ b/docs/docs/dev_docs/contracts/compiling.md @@ -46,7 +46,7 @@ You can also generate these interfaces from prebuilt artifacts using the `genera aztec-cli generate-typescript ./path/to/my_aztec_contract_project ``` -Bellow is a piece of code generated from the [Token](https://github.com/AztecProtocol/aztec-packages/blob/master/yarn-project/noir-contracts/src/contracts/token_contract/src/main.nr) contract: +Below is typescript code generated from the [Token](https://github.com/AztecProtocol/aztec-packages/blob/master/yarn-project/noir-contracts/src/contracts/token_contract/src/main.nr) contract: ```ts showLineNumbers export class TokenContract extends ContractBase { @@ -149,7 +149,7 @@ You can also generate these interfaces from prebuilt artifacts using the `genera aztec-cli generate-noir-interface ./path/to/my_aztec_contract_project ``` -Example code snippet generated from the [Token](https://github.com/AztecProtocol/aztec-packages/blob/master/yarn-project/noir-contracts/src/contracts/token_contract/src/main.nr) contract: +Below is an example interface, also generated from the [Token](https://github.com/AztecProtocol/aztec-packages/blob/master/yarn-project/noir-contracts/src/contracts/token_contract/src/main.nr) contract: ```rust impl TokenPrivateContextInterface { diff --git a/docs/docs/dev_docs/getting_started/sandbox.md b/docs/docs/dev_docs/getting_started/sandbox.md index 48027ba6d06d..da6d0fb723fa 100644 --- a/docs/docs/dev_docs/getting_started/sandbox.md +++ b/docs/docs/dev_docs/getting_started/sandbox.md @@ -262,7 +262,7 @@ Running now should yield output: token Bob's balance 0 +33ms ``` -In this section, we created a second instance of the `TokenContract` contract abstraction pertaining to Bob. This contract abstraction offers a Typescript interface reflecting the abi of the contract. We then call `getBalance()` as a `view` method. View methods can be thought as read-only. No transaction is submitted as a result but a user's state can be queried. +In this section, we created a second instance of the `TokenContract` contract abstraction pertaining to Bob. This contract abstraction offers a Typescript interface reflecting the abi of the contract. We then call `balance_of_private()` as a `view` method. View methods can be thought as read-only. No transaction is submitted as a result but a user's state can be queried. We can see that each account has the expected balance of tokens.