Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Lasse Herskind <[email protected]>
  • Loading branch information
benesjan and LHerskind authored Oct 14, 2023
1 parent 8c92941 commit 48e7a27
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion docs/docs/dev_docs/cli/main.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ export ADDRESS2=<Account address printed by the above command>

## 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
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/dev_docs/contracts/compiling.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand Down Expand Up @@ -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 {
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/dev_docs/getting_started/sandbox.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down

0 comments on commit 48e7a27

Please sign in to comment.