Skip to content

Commit 2412602

Browse files
feat(docs): add NFT tutorial (#10161)
Adds an NFT tutorial to the docs. Removes the token contract tutorial. closes: #10113 --------- Co-authored-by: Rahul Kothari <[email protected]>
1 parent ab3f318 commit 2412602

File tree

14 files changed

+436
-17
lines changed

14 files changed

+436
-17
lines changed

docs/docs/aztec/smart_contracts/contract_structure.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,4 +37,4 @@ Here's a common layout for a basic Aztec.nr Contract project:
3737
```
3838

3939
- See the vanilla Noir docs for [more info on packages](https://noir-lang.org/docs/noir/modules_packages_crates/crates_and_packages).
40-
- You can review the structure of a complete contract in the token contract tutorial [here](../../tutorials/codealong/contract_tutorials/token_contract.md).
40+
- You can review the structure of a complete contract in the NFT contract tutorial [here](../../tutorials/codealong/contract_tutorials/nft_contract.md).

docs/docs/aztec/smart_contracts/functions/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ tags: [functions]
55

66
Functions serve as the building blocks of smart contracts. Functions can be either **public**, ie they are publicly available for anyone to see and can directly interact with public state, or **private**, meaning they are executed completely client-side in the [PXE](../../concepts/pxe/index.md). Read more about how private functions work [here](./attributes.md#private-functions).
77

8-
For a more practical guide of using multiple types of functions, follow the [token tutorial](../../../tutorials/codealong/contract_tutorials/token_contract.md).
8+
For a more practical guide of using multiple types of functions, follow the [NFT tutorial](../../../tutorials/codealong/contract_tutorials/nft_contract.md).
99

1010
Currently, any function is "mutable" in the sense that it might alter state. However, we also support static calls, similarly to EVM. A static call is essentially a call that does not alter state (it keeps state static).
1111

docs/docs/aztec/smart_contracts/functions/visibility.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@ tags: [functions]
66

77
In Aztec there are multiple different types of visibility that can be applied to functions. Namely we have `data visibility` and `function visibility`. This page explains these types of visibility.
88

9-
For a practical guide of using multiple types of data and function visibility, follow the [token tutorial](../../../tutorials/codealong/contract_tutorials/token_contract.md).
9+
For a practical guide of using multiple types of data and function visibility, follow the [NFT tutorial](../../../tutorials/codealong/contract_tutorials/nft_contract.md).
1010

1111
### Data Visibility
1212

13-
Data visibility is used to describe whether the data (or state) used in a function is generally accessible (public) or on a need to know basis (private).
13+
Data visibility is used to describe whether the data (or state) used in a function is generally accessible (public) or on a need to know basis (private).
1414

1515
### Function visibility
1616

docs/docs/guides/developer_guides/js_apps/deploy_contract.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ You can read about contract artifacts [here](../../../aztec/smart_contracts/cont
1515

1616
## Import the contract artifact
1717

18-
In this guide we are using a Token contract artifact. This comes from the [token contract tutorial](../../../tutorials/codealong/contract_tutorials/token_contract.md).
18+
In this guide we are using a Token contract artifact.
1919

2020
#include_code import_token_contract yarn-project/end-to-end/src/composed/docs_examples.test.ts typescript
2121

docs/docs/guides/developer_guides/smart_contracts/writing_contracts/common_patterns/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ In this situation, try to mark the public function as `internal`. This ensures y
7777

7878
### Moving public data into the private domain
7979

80-
See [partial notes](../../../../../aztec/concepts/storage/partial_notes.md). Partial notes are how public balances are transferred to private [in the token contract](../../../../../tutorials/codealong/contract_tutorials/token_contract.md).
80+
See [partial notes](../../../../../aztec/concepts/storage/partial_notes.md). Partial notes are how public balances are transferred to private [in the NFT contract](../../../../../tutorials/codealong/contract_tutorials/nft_contract.md).
8181

8282
### Discovering my notes
8383

docs/docs/guides/developer_guides/smart_contracts/writing_contracts/storage/notes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,7 @@ Notice how the `add` function shows the simplicity of appending a new note to al
150150

151151
### Apply
152152

153-
Try the [Token tutorial](../../../../../tutorials/codealong/contract_tutorials/token_contract.md) to see what notes can achieve. In this section you will also find other tutorials using notes in different ways.
153+
Try the [NFT tutorial](../../../../../tutorials/codealong/contract_tutorials/nft_contract.md) to see what notes can achieve. In this section you will also find other tutorials using notes in different ways.
154154

155155
### Further reading
156156

docs/docs/reference/developer_references/smart_contract_reference/dependencies.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,4 +52,4 @@ This library contains types that are used in the Aztec protocol. Find it on [Git
5252
value_note = { git="https://github.com/AztecProtocol/aztec-packages/", tag="#include_aztec_version", directory="noir-projects/aztec-nr/value-note" }
5353
```
5454

55-
This is a library for a note that stores one arbitrary value. You can see an example of how it might be used in the [token contract codealong tutorial](../../../tutorials/codealong/contract_tutorials/token_contract.md).
55+
This is a library for a note that stores one arbitrary value. You can see an example of how it might be used in the [crowdfunding contract codealong tutorial](../../../tutorials/codealong/contract_tutorials/crowdfunding_contract.md).

0 commit comments

Comments
 (0)