Skip to content

Commit 375482f

Browse files
authored
docs: re-arrange references section (#10070)
1 parent 4129e27 commit 375482f

File tree

9 files changed

+21
-17
lines changed

9 files changed

+21
-17
lines changed

docs/docs/reference/developer_references/sandbox_reference/cli_reference.md docs/docs/reference/developer_references/cli_reference.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
title: CLI Reference
33
tags: [sandbox]
4+
sidebar_position: 1
45
---
56

67
:::warning

docs/docs/reference/developer_references/sandbox_reference/cli_wallet_reference.md docs/docs/reference/developer_references/cli_wallet_reference.md

+9-8
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,16 @@
22
title: CLI Wallet
33
tags: [sandbox, wallet, cli]
44
keywords: [wallet, cli wallet]
5+
sidebar_position: 2
56
---
67

78
For development, it may be useful to deploy, transact, or create notes in a non-programmatic way. You can use Aztec's CLI Wallet for thing such as:
89

910
- Deploying contracts
1011
- Sending transactions
11-
- Bridging L1 [Fee Juice](../../../protocol-specs/gas-and-fees/fee-juice.md) into Aztec
12-
- Pushing arbitrary [notes](../../../guides/developer_guides/smart_contracts/writing_contracts/notes/index.md) to your PXE
13-
- Creating [authwits](../../../guides/developer_guides/smart_contracts/writing_contracts/authwit.md)
12+
- Bridging L1 [Fee Juice](../../protocol-specs/gas-and-fees/fee-juice.md) into Aztec
13+
- Pushing arbitrary [notes](../../guides/developer_guides/smart_contracts/writing_contracts/notes/index.md) to your PXE
14+
- Creating [authwits](../../guides/developer_guides/smart_contracts/writing_contracts/authwit.md)
1415
- Aliasing info and secrets for further usage
1516

1617
:::info
@@ -67,9 +68,9 @@ $ aztec-wallet deploy-account -f master_yoda
6768

6869
### Deploy
6970

70-
You can deploy a [compiled contract](../../../guides/developer_guides/smart_contracts/how_to_compile_contract.md) to the network.
71+
You can deploy a [compiled contract](../../guides/developer_guides/smart_contracts/how_to_compile_contract.md) to the network.
7172

72-
You probably want to look at flags such as `--init` which allows you to specify the [initializer function](../../../guides/developer_guides/smart_contracts/writing_contracts/initializers.md) to call, or `-k` for the [encryption public key](../../../aztec/concepts/accounts/keys.md#incoming-viewing-keys) if the contract is expected to have notes being encrypted to it.
73+
You probably want to look at flags such as `--init` which allows you to specify the [initializer function](../../guides/developer_guides/smart_contracts/writing_contracts/initializers.md) to call, or `-k` for the [encryption public key](../../aztec/concepts/accounts/keys.md#incoming-viewing-keys) if the contract is expected to have notes being encrypted to it.
7374

7475
You can pass arguments with the `--arg` flag.
7576

@@ -96,7 +97,7 @@ Again, notice how it's not necessary to pass `contracts:jedi_order` as the walle
9697

9798
### Manage authwits
9899

99-
You can use the CLI wallet to quickly generate [Authentication Witnesses](../../../guides/developer_guides/smart_contracts/writing_contracts/authwit.md). These allow you to authorize the caller to execute an action on behalf of an account. They get aliased into the `authwits` type.
100+
You can use the CLI wallet to quickly generate [Authentication Witnesses](../../guides/developer_guides/smart_contracts/writing_contracts/authwit.md). These allow you to authorize the caller to execute an action on behalf of an account. They get aliased into the `authwits` type.
100101

101102
### In private
102103

@@ -132,7 +133,7 @@ aztec-wallet simulate --from master_yoda --contract-address jedi_order --args "l
132133

133134
### Profile
134135

135-
Simulates a transaction with profiling enabled. This allows you to get the gate count of each private function in the transaction. Read more about profiling [here](../../../guides/developer_guides/smart_contracts/profiling_transactions.md).
136+
Simulates a transaction with profiling enabled. This allows you to get the gate count of each private function in the transaction. Read more about profiling [here](../../guides/developer_guides/smart_contracts/profiling_transactions.md).
136137

137138
#### Example
138139

@@ -142,7 +143,7 @@ aztec-wallet simulate --profile --from master_yoda --contract-address jedi_order
142143

143144
### Bridge Fee Juice
144145

145-
The wallet provides an easy way to mint the fee-paying asset on L1 and bridging it to L2. We call it Fee Juice and you can read more about it in the [protocol specs](../../../protocol-specs/gas-and-fees/fee-juice.md).
146+
The wallet provides an easy way to mint the fee-paying asset on L1 and bridging it to L2. We call it Fee Juice and you can read more about it in the [protocol specs](../../protocol-specs/gas-and-fees/fee-juice.md).
146147

147148
Using the sandbox, there's already a Fee Juice contract that manages this enshrined asset. You can optionally mint more Juice before bridging it.
148149

docs/docs/reference/developer_references/debugging.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Debugging
3-
sidebar_position: 2
3+
sidebar_position: 4
44
---
55

66
## Logging in Aztec.nr

docs/docs/reference/developer_references/sandbox_reference/cheat_codes.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
title: Cheat Codes
33
tags: [sandbox]
4+
sidebar_position: 1
45
---
56

67
import Disclaimer from "@site/src/components/Disclaimers/\_wip_disclaimer.mdx";

docs/docs/reference/developer_references/sandbox_reference/sandbox-reference.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
title: Sandbox Reference
33
tags: [sandbox]
4+
sidebar_position: 0
45
---
56

67
:::tip
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"label": "Smart Contract Reference",
3-
"position": 1,
3+
"position": 3,
44
"collapsible": true,
55
"collapsed": true
66
}

docs/docs/reference/index.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Welcome to the References section! In this section you will find reference mater
1010
This page lists popular references. Please see the sidebar for them all.
1111

1212

13-
## Popular
13+
## Popular
1414

1515
### Smart contracts
1616

@@ -49,7 +49,7 @@ This page lists popular references. Please see the sidebar for them all.
4949
</CardBody>
5050
</Card>
5151

52-
<Card shadow='tl' link='/reference/developer_references/sandbox_reference/cli_reference'>
52+
<Card shadow='tl' link='/reference/developer_references/cli_reference'>
5353
<CardHeader>
5454
<h3>CLI reference</h3>
5555
</CardHeader>

docs/docs/tutorials/codealong/cli_wallet/faceid_wallet.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ keywords: [wallet, cli wallet, faceid]
55
importance: 3
66
---
77

8-
In this tutorial, we will use Apple Mac's Secure Enclave to store the private key, and use it in Aztec's [CLI Wallet](../../../reference/developer_references/sandbox_reference/cli_wallet_reference.md). This enables fully private, native, and seedless account abstraction!
8+
In this tutorial, we will use Apple Mac's Secure Enclave to store the private key, and use it in Aztec's [CLI Wallet](../../../reference/developer_references/cli_wallet_reference.md). This enables fully private, native, and seedless account abstraction!
99

1010
:::warning
1111

@@ -92,7 +92,7 @@ aztec-wallet deploy --from accounts:my-wallet token_contract@Token --args accoun
9292
You should get prompted to sign with TouchID or password. Once authorized, you should see `Contract stored in database with aliases last & devtoken`
9393
```
9494

95-
Check [the reference](../../../reference/developer_references/sandbox_reference/cli_wallet_reference.md) for the whole set of commands, but these mean:
95+
Check [the reference](../../../reference/developer_references/cli_wallet_reference.md) for the whole set of commands, but these mean:
9696

9797
- --from is the sender: our account `my-wallet`. We use the alias because it's easier than writing the key stored in our Secure Enclave. The wallet resolves the alias and knows where to grab it.
9898
- token_contract@Token is a shorthand to look in the `target` folder for our contract `token_contract-Token`
@@ -111,7 +111,7 @@ aztec-wallet simulate balance_of_public -ca contracts:devtoken --args accounts:n
111111

112112
### What next
113113

114-
In this tutorial, we created an account with the Aztec's [CLI Wallet](../../../reference/developer_references/sandbox_reference/cli_wallet_reference.md), using the Apple Mac's Secure Enclave to store the private key.
114+
In this tutorial, we created an account with the Aztec's [CLI Wallet](../../../reference/developer_references/cli_wallet_reference.md), using the Apple Mac's Secure Enclave to store the private key.
115115

116116
You can use a multitude of authentication methods, for example with RSA you could use a passport as a recovery, or even as a signer in a multisig. All of this is based on the account contract.
117117

docs/docs/tutorials/codealong/contract_tutorials/token_contract.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -79,8 +79,8 @@ These are functions that have private logic and will be executed on user devices
7979

8080
- [`transfer`](#transfer) enables an account to send tokens from their private balance to another account's private balance
8181
- [`transfer_in_private`](#transfer_in_private) enables an account to send tokens from another account's private balance to another account's private balance
82-
- [`transfer_to_private`](#transfer_to_private) transfers a specified `amount` from an accounts public balance to a designated recipient. This flow starts in private, but will be completed in public.
83-
- [`transfer_to_public`](#transfer_to_public) transfers tokens from a private balance, to a (potentially different account's) public balance
82+
- [`transfer_to_private`](#transfer_to_private) transfers a specified `amount` from an accounts public balance to a designated recipient's private balance. This flow starts in private, but will be completed in public.
83+
- [`transfer_to_public`](#transfer_to_public) transfers tokens from the private balance of another account, to a (potentially different account's) public balance
8484
- [`mint_to_private`](#mint_to_private) enables an authorized minter to mint tokens to a specified address
8585
- [`cancel_authwit`](#cancel_authwit) enables an account to cancel an authorization to spend tokens
8686
- [`burn_private`](#burn_private) enables tokens to be burned privately

0 commit comments

Comments
 (0)