-
Notifications
You must be signed in to change notification settings - Fork 184
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
fix(docs): Update sandbox reference #6094
Changes from 5 commits
9ca2f3a
6bc2862
bd91e82
9fb1f52
eaf045f
8cf4ec3
7771991
3f2f498
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -61,35 +61,25 @@ If you wish to run components of the Aztec network stack separately, you can use | |
aztec start --node [nodeOptions] --pxe [pxeOptions] --archiver [archiverOptions] --sequencer [sequencerOptions] --prover [proverOptions] ----p2p-bootstrap [p2pOptions] | ||
``` | ||
|
||
Starting the aztec node alongside a PXE, sequencer or archiver, will attach the components to the node. If you want to e.g. run a PXE separately to a node, you can: | ||
Start a node: | ||
|
||
```bash | ||
aztec start --node [node] --archiver [archiverOptions] | ||
``` | ||
|
||
Then start a PXE on a separate terminal that connects to that node: | ||
|
||
```bash | ||
aztec start --pxe nodeUrl=http://localhost:8080 | ||
``` | ||
Starting the aztec node alongside a PXE, sequencer or archiver, will attach the components to the node.Eg if you want to run a PXE separately to a node, you can [read this guide](../guides/run_more_than_one_pxe_sandbox.md)/ | ||
|
||
## Environment Variables | ||
|
||
There are various environment variables you can use when running the whole sandbox or when running on of the available modes. | ||
|
||
To change them, you can open `~/.aztec/docker-compose.yml` and edit them directly. | ||
|
||
**Sandbox** | ||
|
||
```sh | ||
DEBUG=aztec:* # The level of debugging logs to be displayed. using "aztec:*" will log everything. | ||
ETHEREUM_HOST=http://ethereum:8545 # The Ethereum JSON RPC URL. We use an anvil instance that runs in parallel to the sandbox on docker by default. | ||
HOST_WORKDIR='${PWD}' # The location to store log outpus. Will use ~/.aztec where the docker-compose.yml file is stored by default. | ||
ETHEREUM_HOST=http://ethereum:8545 # The Ethereum JSON RPC URL. We use an anvil instance that runs in parallel to the sandbox on docker by default. | ||
CHAIN_ID=31337 # The Chain ID that the Ethereum host is using. | ||
TEST_ACCOUNTS='true' # Option to deploy 3 test account when sandbox starts. (default: true) | ||
DEPLOY_AZTEC_CONTRACTS='true' # Option to deploy the Aztec contracts when sandbox starts. (default: true) | ||
MODE='sandbox' # Option to start the sandbox or a standalone part of the system. (default: sandbox) | ||
AZTEC_NODE_PORT=8079 # The port that the Aztec node wil be listening to (default: 8079) | ||
PXE_PORT=8080 # The port that the PXE will be listening to (default: 8080) | ||
SANDBOX_PORT=8080 # The port that Aztec Sandbox wil be listening to (default: 8080) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Are There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
|
||
|
||
# Ethereum Forking (Optional: not enabled by default) # | ||
FORK_BLOCK_NUMBER=0 # The block number to fork from | ||
|
@@ -142,7 +132,6 @@ SEQ_MIN_TX_PER_BLOCK=1 # Minimum txs to go on a block. (default: 1) | |
**PXE** | ||
|
||
Variables like `TEST_ACCOUNTS` & `PXE_PORT` are valid here as described above. | ||
`DEPLOY_AZTEC_CONTRACTS` cannot be used here as the PXE does not control an Ethereum account. | ||
|
||
```sh | ||
AZTEC_NODE_URL='http://localhost:8079' # The address of an Aztec Node URL that the PXE will connect to (default: http://localhost:8079) | ||
|
@@ -177,24 +166,37 @@ You can find the cheat code reference [here](../../sandbox/references/cheat_code | |
We have shipped a number of example contracts in the `@aztec/noir-contracts.js` [npm package](https://www.npmjs.com/package/@aztec/noir-contracts.js). This is included with the sandbox by default so you are able to use these contracts to test with. | ||
|
||
```bash | ||
AppSubscriptionContractArtifact | ||
AuthContractArtifact | ||
BenchmarkingContractArtifact | ||
CardGameContractArtifact | ||
ChildContractArtifact | ||
ClaimContractArtifact | ||
ContractClassRegistererContractArtifact | ||
ContractInstanceDeployerContractArtifact | ||
CounterContractArtifact | ||
CrowdfundingContractArtifact | ||
DelegatedOnContractArtifact | ||
DelegatorContractArtifact | ||
DocsExampleContractArtifact | ||
EasyPrivateTokenContractArtifact | ||
EasyPrivateVotingContractArtifact | ||
EcdsaAccountContractArtifact | ||
EscrowContractArtifact | ||
FPCContractArtifact | ||
GasTokenContractArtifact | ||
ImportTestContractArtifact | ||
InclusionProofsContractArtifact | ||
LendingContractArtifact | ||
MultiCallEntrypointContractArtifact | ||
ParentContractArtifact | ||
PendingNoteHashesContractArtifact | ||
PriceFeedContractArtifact | ||
ReaderContractArtifact | ||
SchnorrAccountContractArtifact | ||
SchnorrHardcodedAccountContractArtifact | ||
SchnorrSingleKeyAccountContractArtifact | ||
SlowTreeContractArtifact | ||
StatefulTestContractArtifact | ||
TestContractArtifact | ||
TokenBlacklistContractArtifact | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should
PXE_PORT
andPORT
default to the same thing?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
they do currently so yes