Skip to content

Commit 15b075e

Browse files
committed
chore(docs): re-structuring smart contracts how-to-guides
1 parent 1a0dcd5 commit 15b075e

Some content is hidden

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

53 files changed

+2612
-2328
lines changed

docs/docs/aztec/concepts/accounts/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ A request for executing an action requires:
7373
- The initial function to call (usually `entrypoint`).
7474
- The arguments (which encode the private and public calls to run as well as any signatures).
7575

76-
Read more about how to write an account contract [here](../../../developers/tutorials/contract_tutorials/write_accounts_contract.md).
76+
Read more about how to write an account contract in the [account development guide](../../../developers/guides/js_apps/create_account.md).
7777

7878
### Non-standard entrypoints
7979

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/concepts/wallets/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ description: Overview of wallet responsibilities in Aztec including account mana
77

88
On this page we will cover the main responsibilities of a wallet in the Aztec network.
99

10-
Refer to [writing an account contract](../../../developers/tutorials/contract_tutorials/write_accounts_contract.md) for a tutorial on how to write a contract to back a user's account.
10+
Refer to [creating accounts](../../../developers/guides/js_apps/create_account.md) for guidance on account creation and management.
1111

1212
Go to [wallet architecture](./architecture.md) for an overview of its architecture and a reference on the interface a wallet must implement.
1313

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
@@ -24,7 +24,7 @@ There are also special oracle functions, which can get data from outside of the
2424
## Learn more about functions
2525

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

0 commit comments

Comments
 (0)