Skip to content

Commit

Permalink
Update info about sandboxes (#467)
Browse files Browse the repository at this point in the history
* Clarify

* Move Tezbox up because it's supported

* Rename testnet topic to not mention sandboxes

* Update for Paris
  • Loading branch information
timothymcmackin authored Nov 15, 2024
1 parent 467cada commit df8c9f3
Show file tree
Hide file tree
Showing 7 changed files with 33 additions and 33 deletions.
2 changes: 1 addition & 1 deletion docs/developing.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,6 @@ To test smart contracts and dApps, you can use these test environments:
- Sandbox environments like [Flextesa](https://tezos.gitlab.io/flextesa/) run Tezos nodes locally on your computer in a sandbox mode.
- You can also set up your own private test network.

For more information about test environments, see [Testing on sandboxes and testnets](/developing/testnets).
For more information about test environments, see [Testing on testnets](/developing/testnets) and [Using a local sandbox](/developing/sandbox).

LIGO and SmartPy also have built-in testing capabilities.
2 changes: 1 addition & 1 deletion docs/developing/octez-client/accounts.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ octez-client show address local_account

The account address (technically the hash of the public key) starts with `tz1`, `tz2`, or `tz3`.
You can use this address to send tez to this account, such as from a faucet if you are using a testnet.
See [Testing on sandboxes and testnets](/developing/testnets).
See [Testing on testnets](/developing/testnets).

<!-- TODO
## Importing pregenerated accounts
Expand Down
54 changes: 27 additions & 27 deletions docs/developing/sandbox.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Using a local sandbox
authors: 'Mathias Hiron, Nomadic Labs, Tim McMackin, TriliTech'
last_update:
date: 16 April 2024
date: 13 November 2024
---

Local sandboxes allow you to test your work without sending any transactions to Tezos Mainnet or testnets.
Expand All @@ -11,8 +11,8 @@ They run a simulated version of the Tezos protocol locally so you can test contr
Sandboxes can be convenient if you want to run all your tests locally but still need a realistic Tezos environment, such as if you need to interact with nodes and the consensus mechanism.
Testing locally can also keep your work confidential until you decide to put it into production.

However, sandboxes lack some features that [testnets](/developing/testnets) have, such as indexers.
If you want an indexer or your testnet, you must run it yourself.
However, sandboxes lack some features that [testnets](/developing/testnets) have, such as indexers and block explorers.
If you want an indexer or block explorer for your sandbox, you must run it yourself.

Here are some options for running local Tezos sandboxes:

Expand All @@ -23,6 +23,30 @@ The Octez client sandboxed and mockup modes run a local version of the Tezos net
- [Sandboxed mode](https://tezos.gitlab.io/user/sandbox.html) runs a local network with one or more nodes.
- [Mockup mode](https://tezos.gitlab.io/user/mockup.html) runs a light version of the network without nodes.

## Tezbox

[Tezbox](https://github.com/tez-capital/tezbox) is also a simulated Tezos environment that runs in a container.

Tezbox provides different images that mirror versions of the Octez suite.
For example, to run Tezbox with Octez version 19.1 and the Paris protocol, run this command:

```bash
docker run --rm -it --name tezbox -p 0.0.0.0:8732:8732 ghcr.io/tez-capital/tezbox:tezos-v20.3 parisbox
```

The container runs in the background and provides an RPC node at http://localhost:8732.

Then you can use the sandbox through that RPC node.
For example, you can configure the Octez client to use the sandbox by running this command:

```bash
octez-client -E http://localhost:8732 config update
```

Then you can use your local installation of the Octez client to interact with the sandbox, such as deploying contracts and sending transactions.

Tezbox provides sample accounts in the `/tezbox/context/accounts.json` file.

## Flextesa

The [Flextesa](https://tezos.gitlab.io/flextesa/) is a simulated Tezos environment that runs in a container.
Expand Down Expand Up @@ -57,27 +81,3 @@ Now you can use the Octez client to deploy contracts and send transactions to th
Flextesa allows you to control baking manually, so blocks are only backed when you trigger them.

For more information, see the [Flextesa documentation](https://tezos.gitlab.io/flextesa/).

## Tezbox

[Tezbox](https://github.com/tez-capital/tezbox) is also a simulated Tezos environment that runs in a container.

Tezbox provides different images that mirror versions of the Octez suite.
For example, to run Tezbox with Octez version 19.1 and the Oxford protocol, run this command:

```bash
docker run -d -p 0.0.0.0:8732:8732 --name oxfordbox ghcr.io/tez-capital/tezbox:tezos-v19.1
```

The container runs in the background and provides an RPC node at http://localhost:8732.

Then you can use the sandbox through that RPC node.
For example, you can configure the Octez client to use the sandbox by running this command:

```bash
octez-client -E http://localhost:8732 config update
```

Then you can use your local installation of the Octez client to interact with the sandbox, such as deploying contracts and sending transactions.

Tezbox provides sample accounts in the `/tezbox/context/accounts.json` file.
2 changes: 1 addition & 1 deletion docs/developing/testing.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,4 +109,4 @@ For more information about avoiding flaws in contracts, see [Avoiding flaws](htt
## Next steps
When you're done testing contracts locally, you can deploy them to a test network and test them there.
See [Testing on sandboxes and testnets](/developing/testnets).
See [Testing on testnets](/developing/testnets) and [Using a local sandbox](/developing/sandbox).
2 changes: 1 addition & 1 deletion docs/developing/testnets.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Testing on sandboxes and testnets
title: Testing on testnets
authors: 'Mathias Hiron, Nomadic Labs, Tim McMackin, TriliTech'
last_update:
date: 2 February 2024
Expand Down
2 changes: 1 addition & 1 deletion docs/tutorials/join-dal-baker.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ The delay on Ghostnet is about 3.5 days, so in this tutorial you do setup work,
If you don't want to wait that long, you can use Weeklynet, where the delay is about an hour.
However, to use Weeklynet, you must use a specific version of the Octez suite.
You must also be aware that the network completely resets and moves to a new version of the Octez suite every Wednesday.
For information about using Weeklynet, see [Testing on sandboxes and testnets](/developing/testnets).
For information about using Weeklynet, see [Testing on testnets](/developing/testnets).

:::

Expand Down
2 changes: 1 addition & 1 deletion docs/unity/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -344,7 +344,7 @@ private void OnPayloadSigned(SignResult obj)

As described in [The RPC interface](/architecture/nodes#the-rpc-interface), Tezos clients including the Unity SDK send transactions to RPC nodes.
By default, the SDK sends requests to a public RPC node that uses the Ghostnet test network, where you can test transactions without spending real tez.
For more information about test networks, see [Testing on sandboxes and testnets](/developing/testnets).
For more information about test networks, see [Testing on testnets](/developing/testnets).

If you need to change the RPC node that the SDK uses, such as if the default node is overloaded or if you are ready to send transactions to Mainnet, you can set the RPC node by creating an instance of the [TezosConfigSO scriptable object](/unity/reference/TezosConfigSO) and setting the node in the **Rpc Url Format** field, as in this picture:

Expand Down

0 comments on commit df8c9f3

Please sign in to comment.