Skip to content

Commit 56837ad

Browse files
chore(docs): re-structuring how-to-guides
- Moving the token contract tutorial to its place (removing the old one which was already a draft) and renaming the file correctly - Making all the how-to-guides generic. Snippets are not using #include_code anymore but are generic, i.e. use another_contract::another_function to explain how to call another function from another contract. This helps the distinction between how-tos and tutorials, plus makes them more maintainable assuming no big changes to the syntax. - Adding some structure to the how to guides so it's easier to just add new ones :) - Fixing broken links - Making the guides work with the new Wallet interface Co-authored-by: Josh Crites <[email protected]> Co-authored-by: José Pedro Sousa <[email protected]> Co-authored-by: José Pedro Sousa <[email protected]>
1 parent 88d0f47 commit 56837ad

File tree

66 files changed

+4205
-3041
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

66 files changed

+4205
-3041
lines changed

cspell.json

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -253,6 +253,7 @@
253253
"prestat",
254254
"prevrandao",
255255
"println",
256+
"privateland",
256257
"productionify",
257258
"protobuf",
258259
"protogalaxy",
@@ -263,6 +264,7 @@
263264
"proxify",
264265
"pseudocode",
265266
"pubkey",
267+
"publicland",
266268
"pxes",
267269
"quickstart",
268270
"Quickstarts",

docs/docs-words.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -349,3 +349,5 @@ Zcash
349349
Zybil
350350
nothin
351351
whoooaa
352+
flamegraphs
353+
mycontract

docs/docs/aztec/concepts/accounts/keys.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ When it comes to storing the signing key in a private note, there are several de
106106

107107
#### Using Delayed Public Mutable state
108108

109-
By [Delayed Public Mutable](../../../developers/guides/smart_contracts/storage_types.md#delayed-public-mutable) we mean privately readable publicly mutable state.
109+
By [Delayed Public Mutable](../../../developers/guides/smart_contracts/how_to_define_storage.md#delayed-public-mutable) we mean privately readable publicly mutable state.
110110

111111
To make public state accessible privately, there is a delay window in public state updates. One needs this window to be able to generate proofs client-side. This approach would not generate additional nullifiers and commitments for each transaction while allowing the user to rotate their key. However, this causes every transaction to now have a time-to-live determined by the frequency of the delayed mutable state, as well as imposing restrictions on how fast keys can be rotated due to minimum delays.
112112

docs/docs/aztec/concepts/advanced/authwit.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -141,4 +141,4 @@ We don't need to limit ourselves to the `transfer` function, we can use the same
141141

142142
### Next Steps
143143

144-
Check out the [developer documentation](../../../developers/guides/smart_contracts/authwit.md) to see how to implement this in your own contracts.
144+
Check out the [developer documentation](../../../developers/guides/smart_contracts/how_to_use_authwit.md) to see how to implement this in your own contracts.

docs/docs/aztec/concepts/call_types.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,7 @@ aztec = { git = "https://github.com/AztecProtocol/aztec-packages/", tag = "#incl
149149

150150
Even with the router contract achieving good privacy is hard.
151151
For example, if the value being checked against is unique and stored in the contract's public storage, it's then simple to find private transactions that are using that value in the enqueued public reads, and therefore link them to this contract.
152-
For this reason it is encouraged to try to avoid public function calls and instead privately read [Shared State](../../developers/guides/smart_contracts/storage_types.md#delayed-public-mutable) when possible.
152+
For this reason it is encouraged to try to avoid public function calls and instead privately read [Shared State](../../developers/guides/smart_contracts/how_to_define_storage.md#delayed-public-mutable) when possible.
153153

154154
### Public Execution
155155

docs/docs/aztec/smart_contracts/contract_creation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ Aztec makes an important distinction between initialization and public deploymen
6161

6262
### Initialization
6363

64-
Contract constructors are not enshrined in the protocol, but handled at the application circuit level. Constructors are methods used for initializing a contract, either private or public, and contract classes may declare more than a single constructor. They can be declared by the `#[initializer]` macro. You can read more about how to use them on the [Defining Initializer Functions](../../developers/guides/smart_contracts/define_functions.md#initializer-functions) page.
64+
Contract constructors are not enshrined in the protocol, but handled at the application circuit level. Constructors are methods used for initializing a contract, either private or public, and contract classes may declare more than a single constructor. They can be declared by the `#[initializer]` macro. You can read more about how to use them on the [Defining Initializer Functions](../../developers/guides/smart_contracts/how_to_define_functions.md#initializer-functions) page.
6565

6666
A contract must ensure:
6767

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ There are also special oracle functions, which can get data from outside of the
2222
## Learn more about functions
2323

2424
- [How function visibility works in Aztec](./visibility.md)
25-
- How to write an [initializer function](../../../developers/guides/smart_contracts/define_functions.md#initializer-functions)
25+
- How to write an [initializer function](../../../developers/guides/smart_contracts/how_to_define_functions.md#initializer-functions)
2626
- [Oracles](../oracles/index.md) and how Aztec smart contracts might use them
2727
- [How functions work under the hood](./attributes.md)
2828

docs/docs/aztec/writing_efficient_contracts.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ When private functions are called, the overhead of a "kernel circuit" is added e
5151

5252
#### Profiling using FlameGraph
5353

54-
Measuring the gate count across a private function can be seen at the end of the counter tutorial [here](../developers/tutorials/contract_tutorials/counter_contract#investigate-the-increment-function). Full profiling and flamegraph commands explained [here](../developers/guides/smart_contracts/advanced/profiling_transactions).
54+
Measuring the gate count across a private function can be seen at the end of the counter tutorial [here](../developers/tutorials/contract_tutorials/counter_contract#investigate-the-increment-function). Full profiling and flamegraph commands explained [here](../developers/guides/smart_contracts/advanced/how_to_profile_transactions).
5555

5656
### L2 Data costs
5757

0 commit comments

Comments
 (0)