diff --git a/docs/docs/reference/developer_references/sandbox_reference/cli_reference.md b/docs/docs/reference/developer_references/cli_reference.md similarity index 99% rename from docs/docs/reference/developer_references/sandbox_reference/cli_reference.md rename to docs/docs/reference/developer_references/cli_reference.md index dd5200742bc1..1bb2392d3b7e 100644 --- a/docs/docs/reference/developer_references/sandbox_reference/cli_reference.md +++ b/docs/docs/reference/developer_references/cli_reference.md @@ -1,6 +1,7 @@ --- title: CLI Reference tags: [sandbox] +sidebar_position: 1 --- :::warning diff --git a/docs/docs/reference/developer_references/sandbox_reference/cli_wallet_reference.md b/docs/docs/reference/developer_references/cli_wallet_reference.md similarity index 83% rename from docs/docs/reference/developer_references/sandbox_reference/cli_wallet_reference.md rename to docs/docs/reference/developer_references/cli_wallet_reference.md index 76e094fb0b33..22c1e67e8921 100644 --- a/docs/docs/reference/developer_references/sandbox_reference/cli_wallet_reference.md +++ b/docs/docs/reference/developer_references/cli_wallet_reference.md @@ -2,15 +2,16 @@ title: CLI Wallet tags: [sandbox, wallet, cli] keywords: [wallet, cli wallet] +sidebar_position: 2 --- 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: - Deploying contracts - Sending transactions -- Bridging L1 [Fee Juice](../../../protocol-specs/gas-and-fees/fee-juice.md) into Aztec -- Pushing arbitrary [notes](../../../guides/developer_guides/smart_contracts/writing_contracts/notes/index.md) to your PXE -- Creating [authwits](../../../guides/developer_guides/smart_contracts/writing_contracts/authwit.md) +- Bridging L1 [Fee Juice](../../protocol-specs/gas-and-fees/fee-juice.md) into Aztec +- Pushing arbitrary [notes](../../guides/developer_guides/smart_contracts/writing_contracts/notes/index.md) to your PXE +- Creating [authwits](../../guides/developer_guides/smart_contracts/writing_contracts/authwit.md) - Aliasing info and secrets for further usage :::info @@ -67,9 +68,9 @@ $ aztec-wallet deploy-account -f master_yoda ### Deploy -You can deploy a [compiled contract](../../../guides/developer_guides/smart_contracts/how_to_compile_contract.md) to the network. +You can deploy a [compiled contract](../../guides/developer_guides/smart_contracts/how_to_compile_contract.md) to the network. -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. +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. You can pass arguments with the `--arg` flag. @@ -96,7 +97,7 @@ Again, notice how it's not necessary to pass `contracts:jedi_order` as the walle ### Manage authwits -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. +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. ### In private @@ -132,7 +133,7 @@ aztec-wallet simulate --from master_yoda --contract-address jedi_order --args "l ### Profile -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). +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). #### Example @@ -142,7 +143,7 @@ aztec-wallet simulate --profile --from master_yoda --contract-address jedi_order ### Bridge Fee Juice -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). +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). Using the sandbox, there's already a Fee Juice contract that manages this enshrined asset. You can optionally mint more Juice before bridging it. diff --git a/docs/docs/reference/developer_references/debugging.md b/docs/docs/reference/developer_references/debugging.md index 59bd3436f6a1..01b8d6d06aaa 100644 --- a/docs/docs/reference/developer_references/debugging.md +++ b/docs/docs/reference/developer_references/debugging.md @@ -1,6 +1,6 @@ --- title: Debugging -sidebar_position: 2 +sidebar_position: 4 --- ## Logging in Aztec.nr diff --git a/docs/docs/reference/developer_references/sandbox_reference/cheat_codes.md b/docs/docs/reference/developer_references/sandbox_reference/cheat_codes.md index 72095bf8c318..2f96ebf6165a 100644 --- a/docs/docs/reference/developer_references/sandbox_reference/cheat_codes.md +++ b/docs/docs/reference/developer_references/sandbox_reference/cheat_codes.md @@ -1,6 +1,7 @@ --- title: Cheat Codes tags: [sandbox] +sidebar_position: 1 --- import Disclaimer from "@site/src/components/Disclaimers/\_wip_disclaimer.mdx"; diff --git a/docs/docs/reference/developer_references/sandbox_reference/sandbox-reference.md b/docs/docs/reference/developer_references/sandbox_reference/sandbox-reference.md index fedfb1c41b5d..82435874756f 100644 --- a/docs/docs/reference/developer_references/sandbox_reference/sandbox-reference.md +++ b/docs/docs/reference/developer_references/sandbox_reference/sandbox-reference.md @@ -1,6 +1,7 @@ --- title: Sandbox Reference tags: [sandbox] +sidebar_position: 0 --- :::tip diff --git a/docs/docs/reference/developer_references/smart_contract_reference/_category_.json b/docs/docs/reference/developer_references/smart_contract_reference/_category_.json index 968f9bcf0a6b..13f5f1ecc0ad 100644 --- a/docs/docs/reference/developer_references/smart_contract_reference/_category_.json +++ b/docs/docs/reference/developer_references/smart_contract_reference/_category_.json @@ -1,6 +1,6 @@ { "label": "Smart Contract Reference", - "position": 1, + "position": 3, "collapsible": true, "collapsed": true } diff --git a/docs/docs/reference/index.md b/docs/docs/reference/index.md index 714e945f3b9e..2b725e63ad98 100644 --- a/docs/docs/reference/index.md +++ b/docs/docs/reference/index.md @@ -10,7 +10,7 @@ Welcome to the References section! In this section you will find reference mater This page lists popular references. Please see the sidebar for them all. -## Popular +## Popular ### Smart contracts @@ -49,7 +49,7 @@ This page lists popular references. Please see the sidebar for them all. - +

CLI reference

 diff --git a/docs/docs/tutorials/codealong/cli_wallet/faceid_wallet.md b/docs/docs/tutorials/codealong/cli_wallet/faceid_wallet.md index fc9b89d6b24b..cf2cd0bcde09 100644 --- a/docs/docs/tutorials/codealong/cli_wallet/faceid_wallet.md +++ b/docs/docs/tutorials/codealong/cli_wallet/faceid_wallet.md @@ -5,7 +5,7 @@ keywords: [wallet, cli wallet, faceid] importance: 3 --- -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! +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! :::warning @@ -92,7 +92,7 @@ aztec-wallet deploy --from accounts:my-wallet token_contract@Token --args accoun You should get prompted to sign with TouchID or password. Once authorized, you should see `Contract stored in database with aliases last & devtoken` ``` -Check [the reference](../../../reference/developer_references/sandbox_reference/cli_wallet_reference.md) for the whole set of commands, but these mean: +Check [the reference](../../../reference/developer_references/cli_wallet_reference.md) for the whole set of commands, but these mean: - --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. - 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 ### What next -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. +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. 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. diff --git a/docs/docs/tutorials/codealong/contract_tutorials/token_contract.md b/docs/docs/tutorials/codealong/contract_tutorials/token_contract.md index e272dbe58501..e650379aee45 100644 --- a/docs/docs/tutorials/codealong/contract_tutorials/token_contract.md +++ b/docs/docs/tutorials/codealong/contract_tutorials/token_contract.md @@ -79,8 +79,8 @@ These are functions that have private logic and will be executed on user devices - [`transfer`](#transfer) enables an account to send tokens from their private balance to another account's private balance - [`transfer_in_private`](#transfer_in_private) enables an account to send tokens from another account's private balance to another account's private balance -- [`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. -- [`transfer_to_public`](#transfer_to_public) transfers tokens from a private balance, to a (potentially different account's) public balance +- [`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. +- [`transfer_to_public`](#transfer_to_public) transfers tokens from the private balance of another account, to a (potentially different account's) public balance - [`mint_to_private`](#mint_to_private) enables an authorized minter to mint tokens to a specified address - [`cancel_authwit`](#cancel_authwit) enables an account to cancel an authorization to spend tokens - [`burn_private`](#burn_private) enables tokens to be burned privately