From 4d22346c93e64a6b28225395f9c82116dd9b0269 Mon Sep 17 00:00:00 2001 From: Dr-Electron Date: Mon, 20 Nov 2023 22:22:47 +0100 Subject: [PATCH 1/7] Add first draft of IOTA Sandbox docs --- .../iota-sandbox/docs/how-tos/install.md | 71 +++++++++++++++++++ 1 file changed, 71 insertions(+) create mode 100644 docs/build/iota-sandbox/docs/how-tos/install.md diff --git a/docs/build/iota-sandbox/docs/how-tos/install.md b/docs/build/iota-sandbox/docs/how-tos/install.md new file mode 100644 index 00000000000..2970a2187b5 --- /dev/null +++ b/docs/build/iota-sandbox/docs/how-tos/install.md @@ -0,0 +1,71 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +# Install Sandbox using Docker + +This guide represents the setup to run the IOTA Sandbox. It includes everything required to develop your own IOTA dApps, plugins and more. + +## Requirements + +1. A recent release of Docker enterprise or community edition. Avoid using the Docker version shipped with your OS since these are mostly out of date. You can find installation instructions in the official Docker documentation. + +2. Git + +# Clone the repo + +:::note + +The commands assume you are using Linux. + +::: + +Once you have completed all the installation requirements, you can clone the repo and navigate to the `sandbox` folder by running the following command: + +```sh +git clone https://github.com/iotaledger/iota-sandbox && cd iota-sandbox/sandbox +``` + +## Prepare + +:::note + +The commands assume you are using Linux. + +::: + +### 1. Setup your Environment + +TODO + +### 2. Bootstrap + +If you didn't run the IOTA Sandbox before, you need to bootstrap it. To do that, just run the following command: + +```sh + ./bootstrap.sh +``` + +## Run + +### Starting the IOTA Sandbox + +You can start the IOTA Sandbox by running: + + + + +```sh +docker compose up -d +``` + + + + +```sh +docker compose --profile=wasp up -d +``` + + + + +- `-d` Instructs Docker to start the containers in the background. From 7baa50711423d1882955323c5f30057402cc30c8 Mon Sep 17 00:00:00 2001 From: Lucas Tortora <85233773+lucas-tortora@users.noreply.github.com> Date: Mon, 27 Nov 2023 05:02:19 -0300 Subject: [PATCH 2/7] Edit - Sandbox docs (#1352) --- .../iota-sandbox/docs/how-tos/install.md | 71 ------------------- 1 file changed, 71 deletions(-) delete mode 100644 docs/build/iota-sandbox/docs/how-tos/install.md diff --git a/docs/build/iota-sandbox/docs/how-tos/install.md b/docs/build/iota-sandbox/docs/how-tos/install.md deleted file mode 100644 index 2970a2187b5..00000000000 --- a/docs/build/iota-sandbox/docs/how-tos/install.md +++ /dev/null @@ -1,71 +0,0 @@ -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -# Install Sandbox using Docker - -This guide represents the setup to run the IOTA Sandbox. It includes everything required to develop your own IOTA dApps, plugins and more. - -## Requirements - -1. A recent release of Docker enterprise or community edition. Avoid using the Docker version shipped with your OS since these are mostly out of date. You can find installation instructions in the official Docker documentation. - -2. Git - -# Clone the repo - -:::note - -The commands assume you are using Linux. - -::: - -Once you have completed all the installation requirements, you can clone the repo and navigate to the `sandbox` folder by running the following command: - -```sh -git clone https://github.com/iotaledger/iota-sandbox && cd iota-sandbox/sandbox -``` - -## Prepare - -:::note - -The commands assume you are using Linux. - -::: - -### 1. Setup your Environment - -TODO - -### 2. Bootstrap - -If you didn't run the IOTA Sandbox before, you need to bootstrap it. To do that, just run the following command: - -```sh - ./bootstrap.sh -``` - -## Run - -### Starting the IOTA Sandbox - -You can start the IOTA Sandbox by running: - - - - -```sh -docker compose up -d -``` - - - - -```sh -docker compose --profile=wasp up -d -``` - - - - -- `-d` Instructs Docker to start the containers in the background. From 15055b0c78d91e8b09b5ad0c5080c4451b1d9a5b Mon Sep 17 00:00:00 2001 From: Dr-Electron Date: Mon, 22 Jan 2024 21:26:53 +0100 Subject: [PATCH 3/7] Add setup chain how to --- .../iota-sandbox/docs/how-tos/setup-chain.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 docs/build/iota-sandbox/docs/how-tos/setup-chain.md diff --git a/docs/build/iota-sandbox/docs/how-tos/setup-chain.md b/docs/build/iota-sandbox/docs/how-tos/setup-chain.md new file mode 100644 index 00000000000..ef8fa576a12 --- /dev/null +++ b/docs/build/iota-sandbox/docs/how-tos/setup-chain.md @@ -0,0 +1,18 @@ +--- +title: Setup a Chain +description: Setup a wasp chain in the IOTA Sandbox +keywords: + - how to + - setup + - chain +--- + +To setup a chain you should have the wasp profile enabled. You can do this by uncommenting the `wasps` line in the `.env` file. + +Afterwards you can just follow the how-tos for [configuring wasp-cli](/wasp-cli/how-tos/wasp-cli/) and [setting up a chain](/wasp-cli/how-tos/setting-up-a-chain#start-the-chain). +You can find the endpoints needed in the [endpoints section](./../references/endpoints.md). + +## Optional: Enable and configure EVM toolkit + +Enable the EVM toolkit by uncommenting the `evm-toolkit` line in the `.env` file. +After that add change the `text` and `chainAddress` to your needs in the `assets/evm-toolkit/networks.json` file. From 7aa7f8d0b92140f371a2de4fbb44b95a6d928a67 Mon Sep 17 00:00:00 2001 From: Dr-Electron Date: Tue, 23 Jan 2024 21:53:33 +0100 Subject: [PATCH 4/7] Apply suggestions from code review Co-authored-by: Lucas Tortora <85233773+lucas-tortora@users.noreply.github.com> --- .../iota-sandbox/docs/how-tos/setup-chain.md | 21 ++++++++++++------- 1 file changed, 13 insertions(+), 8 deletions(-) diff --git a/docs/build/iota-sandbox/docs/how-tos/setup-chain.md b/docs/build/iota-sandbox/docs/how-tos/setup-chain.md index ef8fa576a12..dc05bc78444 100644 --- a/docs/build/iota-sandbox/docs/how-tos/setup-chain.md +++ b/docs/build/iota-sandbox/docs/how-tos/setup-chain.md @@ -1,18 +1,23 @@ --- -title: Setup a Chain -description: Setup a wasp chain in the IOTA Sandbox +title: Set Up a Chain +description: Set up a wasp chain in the IOTA Sandbox keywords: - how to - setup - chain --- -To setup a chain you should have the wasp profile enabled. You can do this by uncommenting the `wasps` line in the `.env` file. +To set up a chain, you should enable the wasp profile. You can do this by uncommenting the `wasps` line in the `.env` file. -Afterwards you can just follow the how-tos for [configuring wasp-cli](/wasp-cli/how-tos/wasp-cli/) and [setting up a chain](/wasp-cli/how-tos/setting-up-a-chain#start-the-chain). -You can find the endpoints needed in the [endpoints section](./../references/endpoints.md). +Afterward, you can just follow the how-tos for [configuring wasp-cli](/wasp-cli/how-tos/wasp-cli/) and [setting up a chain](/wasp-cli/how-tos/setting-up-a-chain#start-the-chain). +:::tip Available Endpoints -## Optional: Enable and configure EVM toolkit +You can find the available endpoints in the [endpoints reference](./../references/endpoints.md). -Enable the EVM toolkit by uncommenting the `evm-toolkit` line in the `.env` file. -After that add change the `text` and `chainAddress` to your needs in the `assets/evm-toolkit/networks.json` file. +::: + + +## (Optional) Enable and Configure EVM Toolkit + +Enable the [EVM toolkit](https://evm-toolkit.evm.shimmer.network/) by uncommenting the `evm-toolkit` line in the `.env` file. +After that, change the `text` and `chainAddress` to your needs in the `assets/evm-toolkit/networks.json` file. From bfd6db3d01b6896880660353f7151c8cded88546 Mon Sep 17 00:00:00 2001 From: Dr-Electron Date: Fri, 26 Jan 2024 11:59:48 +0100 Subject: [PATCH 5/7] Switch to default chain --- .../iota-sandbox/docs/how-tos/setup-chain.md | 23 ------------------- 1 file changed, 23 deletions(-) delete mode 100644 docs/build/iota-sandbox/docs/how-tos/setup-chain.md diff --git a/docs/build/iota-sandbox/docs/how-tos/setup-chain.md b/docs/build/iota-sandbox/docs/how-tos/setup-chain.md deleted file mode 100644 index dc05bc78444..00000000000 --- a/docs/build/iota-sandbox/docs/how-tos/setup-chain.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: Set Up a Chain -description: Set up a wasp chain in the IOTA Sandbox -keywords: - - how to - - setup - - chain ---- - -To set up a chain, you should enable the wasp profile. You can do this by uncommenting the `wasps` line in the `.env` file. - -Afterward, you can just follow the how-tos for [configuring wasp-cli](/wasp-cli/how-tos/wasp-cli/) and [setting up a chain](/wasp-cli/how-tos/setting-up-a-chain#start-the-chain). -:::tip Available Endpoints - -You can find the available endpoints in the [endpoints reference](./../references/endpoints.md). - -::: - - -## (Optional) Enable and Configure EVM Toolkit - -Enable the [EVM toolkit](https://evm-toolkit.evm.shimmer.network/) by uncommenting the `evm-toolkit` line in the `.env` file. -After that, change the `text` and `chainAddress` to your needs in the `assets/evm-toolkit/networks.json` file. From a31d609e22965ff086522ac2c0a183d873a8e7a4 Mon Sep 17 00:00:00 2001 From: Lucas Tortora Date: Thu, 1 Feb 2024 10:35:32 -0300 Subject: [PATCH 6/7] replace private tangle with Sandbox --- docs/build/identity.rs/1.0/docs/getting-started/wasm.mdx | 5 +++-- .../docs/how-tos/decentralized-identifiers/create.mdx | 9 ++++----- tutorials/pages/proof-inclusion-of-a-block.md | 2 +- 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/build/identity.rs/1.0/docs/getting-started/wasm.mdx b/docs/build/identity.rs/1.0/docs/getting-started/wasm.mdx index 69c4927da67..c5655e74f29 100644 --- a/docs/build/identity.rs/1.0/docs/getting-started/wasm.mdx +++ b/docs/build/identity.rs/1.0/docs/getting-started/wasm.mdx @@ -87,8 +87,9 @@ npm run build:web ## NodeJS Usage -The following code creates a new IOTA DID Document suitable for publishing to a locally running private network. -See the [instructions](https://github.com/iotaledger/hornet/tree/develop/private_tangle) on running your own private network. +The following code creates a new IOTA DID Document suitable for publishing to a local test network, like the +[IOTA Sandbox](/iota-sandbox/welcome/). +