Skip to content

Commit ddca6dc

Browse files
author
AztecBot
committed
Merge branch 'next' into merge-train/barretenberg
2 parents 3627865 + dd54789 commit ddca6dc

File tree

44 files changed

+1098
-154
lines changed

Some content is hidden

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

44 files changed

+1098
-154
lines changed
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"label": "Getting Started",
3+
"link": { "type": "doc", "id": "getting_started/index" }
4+
}

docs/docs/developers/getting_started/getting_started.md

Lines changed: 474 additions & 0 deletions
Large diffs are not rendered by default.

docs/versioned_docs/version-v1.2.0/developers/getting_started.md renamed to docs/docs/developers/getting_started/getting_started_on_sandbox.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
---
2-
title: Getting Started
3-
description: Quick start guide for developers to set up their environment and begin building on Aztec.
2+
title: Getting Started on Sandbox
3+
description: Guide for developers to get started with the Aztec sandbox, including account creation and contract deployment.
44
sidebar_position: 0
5-
tags: [sandbox. testnet]
5+
tags: [sandbox, testnet]
66
---
77

88
import Tabs from '@theme/Tabs';
99
import TabItem from '@theme/TabItem';
1010

11-
Get started on your local environment using the sandbox. If you'd rather jump into testnet, read the [getting started on testnet guide](./guides/getting_started_on_testnet.md).
12-
11+
Get started on your local environment using the sandbox. If you'd rather jump into testnet, read the [getting started on testnet guide](../guides/getting_started_on_testnet.md).
12+
1313
The Sandbox is an local development Aztec network running fully on your machine, and interacting with a development Ethereum node. You can develop and deploy on it just like on a testnet or mainnet (when the time comes). The sandbox makes it faster and easier to develop and test your Aztec applications.
1414

1515
What's included in the sandbox:
@@ -50,6 +50,7 @@ This will install the following tools:
5050

5151
- **aztec** - launches various infrastructure subsystems (full sandbox, sequencer, prover, pxe, etc) and provides utility commands to interact with the network
5252
- **aztec-nargo** - aztec's build of nargo, the noir compiler toolchain.
53+
- **aztec-postprocess-contract** - postprocessing tool for Aztec contracts (transpilation and VK generation).
5354
- **aztec-up** - a tool to upgrade the aztec toolchain to the latest, or specific versions.
5455
- **aztec-wallet** - a tool for interacting with the aztec network
5556

@@ -253,4 +254,4 @@ Simulation result: 25n
253254
254255
## What's next?
255256
256-
Click the Next button below to continue on your journey and write your first Aztec smart contract.
257+
Click the Next button below to continue on your journey and write your first Aztec smart contract.

docs/docs/developers/guides/js_apps/connect_to_sandbox.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ This guide shows you how to connect your application to a running Aztec sandbox.
66

77
## Prerequisites
88

9-
- A running Aztec sandbox (see [Quickstart](../../getting_started.md)) on port 8080
9+
- A running Aztec sandbox (see [Quickstart](../../getting_started/getting_started_on_sandbox.md)) on port 8080
1010
- Node.js installed
1111
- TypeScript project set up
1212

docs/docs/developers/guides/js_apps/deploy_contract.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ You can deploy your contract using JS, which could come in handy (ex. if doing i
1010
## Prerequisites
1111

1212
- You should have your compiled contract ready (go to [How to Compile Contract](../smart_contracts/how_to_compile_contract.md) for instructions on how to compile contracts)
13-
- Aztec Sandbox running (go to [Getting Started](../../getting_started.md) for instructions on how to install and run the sandbox)
13+
- Aztec Sandbox running (go to [Getting Started](../../getting_started/getting_started_on_sandbox.md) for instructions on how to install and run the sandbox)
1414

1515
## Deploy
1616

docs/docs/developers/guides/js_apps/test.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ In this guide we will cover how to interact with your Aztec.nr smart contracts i
1010
## Prerequisites
1111

1212
- A compiled contract with TS interface (read [how to compile](../smart_contracts/how_to_compile_contract.md))
13-
- Your sandbox running (read [getting started](../../getting_started.md))
13+
- Your sandbox running (read [getting started](../../getting_started/getting_started_on_sandbox.md))
1414

1515
## Create TS file and install libraries
1616

docs/docs/developers/guides/local_env/sandbox.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -199,7 +199,7 @@ You can enable proving on a per-transaction basis using the `aztec-wallet` CLI b
199199
PXE_PROVER_ENABLED=1 aztec-wallet create-account -a test
200200
```
201201

202-
Check the [Quickstart](../../getting_started.md) for a refresher on how to send transactions using `aztec-wallet` or check the [reference here](../../reference/environment_reference/cli_wallet_reference.md)
202+
Check the [Quickstart](../../getting_started/getting_started_on_sandbox.md) for a refresher on how to send transactions using `aztec-wallet` or check the [reference here](../../reference/environment_reference/cli_wallet_reference.md)
203203

204204
Note that you do not need to restart the sandbox in order to start sending proven transactions. You can optionally set this for one-off transactions.
205205

docs/docs/developers/guides/smart_contracts/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ help you write Noir programs to deploy on the Aztec network.
1313

1414
### Prerequisites
1515

16-
- Install [Aztec Sandbox and tooling](../../getting_started.md)
16+
- Install [Aztec Sandbox and tooling](../../getting_started/getting_started_on_sandbox.md)
1717
- Install the [Noir LSP](../local_env/installing_noir_lsp.md) for your editor.
1818

1919
### Flow

docs/docs/developers/guides/smart_contracts/testing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ To summarize:
3232

3333
## Running Aztec Noir tests
3434

35-
If you have [the sandbox](../../getting_started.md) installed, you can run Noir tests using:
35+
If you have [the sandbox](../../getting_started/getting_started_on_sandbox.md) installed, you can run Noir tests using:
3636

3737
`aztec test`
3838

docs/docs/developers/reference/environment_reference/faceid_wallet.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Aztec is in active development and this has only been tested on MacOS. Please re
1515
:::
1616

1717
:::note
18-
This tutorial is for the sandbox and will need adjustments if you want to use it on testnet. Install the sandbox [here](../../getting_started.md).
18+
This tutorial is for the sandbox and will need adjustments if you want to use it on testnet. Install the sandbox [here](../../getting_started/getting_started_on_sandbox.md).
1919
:::
2020

2121
## Prerequisites

0 commit comments

Comments
 (0)