diff --git a/docs/build/iota-sandbox/docs/getting-started.md b/docs/build/iota-sandbox/docs/getting-started.md new file mode 100644 index 00000000000..e69de29bb2d 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. diff --git a/docs/build/iota-sandbox/docs/references/endpoints.md b/docs/build/iota-sandbox/docs/references/endpoints.md new file mode 100644 index 00000000000..c96496d68d5 --- /dev/null +++ b/docs/build/iota-sandbox/docs/references/endpoints.md @@ -0,0 +1,18 @@ +# Endpoints + +## Hornet + +Dashboard: `http://localhost/` +API: `http://localhost/` + +## Faucet + +Frontend: `http://localhost/faucet/` +API: `http://localhost/faucet/` + +## Wasp + +Dashboard: `http://localhost/wasp/` +API: `http://localhost/wasp/api/` + +## TODO: Add missing endpoints \ No newline at end of file diff --git a/docs/build/iota-sandbox/docs/references/keys.md b/docs/build/iota-sandbox/docs/references/keys.md new file mode 100644 index 00000000000..693a71c3aa3 --- /dev/null +++ b/docs/build/iota-sandbox/docs/references/keys.md @@ -0,0 +1,36 @@ +# Keys and Passwords for the IOTA Sandbox + +## Wallet + +| Name | Value | +|-------------------------------------|--------------------------------------| +| Token mnemonic | giant dynamic museum toddler six deny defense ostrich bomb access mercy blood explain muscle shoot shallow glad autumn author calm heavy hawk abuse rally | +| Token ed25519 private key | 52d23081a626b1eca34b63f1eaeeafcbd66bf545635befc12cd0f19926efefb031f176dadf38cdec0eadd1d571394be78f0bbee3ed594316678dffc162a095cb | +| Token bech32 address with `snd` HRP | snd1qpszqzadsym6wpppd6z037dvlejmjuke7s24hm95s9fg9vpua7vluuwu49a | + + +## Faucet + +| Name | Value | +|-------------------------------------|--------------------------------------| +| Token mnemonic | average day true meadow dawn pistol near vicious have ordinary sting fetch mobile month ladder explain tornado curious energy orange belt glue surge urban | +| Token ed25519 private key | 887844b1e6bf9ca9e0b57584656add4370dbb49a8cb79e2e3032229f30fd80359e3df559ad0de8e5fa019b9ea46d1ee40879f3f3f74594a3306de9dfd43dcd25 | +| Token bech32 address with `snd` HRP | snd1qq2kvnu9pqzptkggrpqrvltvagccsh6aj2fkdhla7p3lrsy9dwhdzpu0epw | + +## INX-Spammer + +| Name | Value | +|-------------------------------------|--------------------------------------| +| Token mnemonic | reward addict anger tongue denial supply cattle lawn foot climb ask friend base spring ensure spike alien equal burst bitter crowd august ignore animal | +| Token ed25519 private key | d50e772a711c3bf71ae676a8dc6a9726346c200d676a8fa7a6e254f341233115e073300fae90b10163e4b2b70c3fa8a93360992ed1a4cc2f6b386b5121c540a4 | +| Token bech32 address with `snd` HRP | snd1qqweu75ldpyann5jsthqsa6m0thx4tmqxncj6uqxf5q974pmqx30yfng7ya | + +## Hornet Dashboard + +Username: `admin` +Password: `admin` + +## Wasp Dashboard + +Username: `wasp` +Password: `wasp` \ No newline at end of file diff --git a/docs/build/iota-sandbox/docs/welcome.md b/docs/build/iota-sandbox/docs/welcome.md new file mode 100644 index 00000000000..d28e68133b1 --- /dev/null +++ b/docs/build/iota-sandbox/docs/welcome.md @@ -0,0 +1,19 @@ +--- +description: test +keywords: + - sandbox + - TOC + - overview + - reference +--- +# IOTA Sandbox + +![IOTA Sandbox](/img/banner/banner_iota_sandbox.svg) + +The IOTA Sandbox is a dedicated local network for developers to prototype and test smart contracts, INX plugins, and L1 applications within the IOTA ecosystem. It provides a safe, isolated environment for development and experimentation, crucial for ensuring functionality before deployment in production scenarios. + +:::note + +The IOTA Sandbox is not intended for creating production-ready networks, but rather for research and development purposes only. Also always consider using the [public testnet](https://wiki.iota.org/build/networks-endpoints/#public-testnet) first. Join us in pioneering the next wave of IOTA innovations, where you can experiment with confidence and community support. + +::: diff --git a/docs/build/iota-sandbox/sidebars.js b/docs/build/iota-sandbox/sidebars.js new file mode 100644 index 00000000000..540679283d5 --- /dev/null +++ b/docs/build/iota-sandbox/sidebars.js @@ -0,0 +1,34 @@ +module.exports = { + docs: [ + { + type: 'doc', + id: 'welcome', + label: 'Welcome', + }, + { + type: 'category', + label: 'How to', + items: [ + { + type: 'doc', + id: 'how-tos/install', + } + ] + }, + { + type: 'category', + label: 'References', + items: [ + { + type: 'doc', + id: 'references/endpoints', + }, + { + type: 'doc', + id: 'references/keys', + } + ] + }, + ], +}; + \ No newline at end of file diff --git a/static/img/banner/banner_iota_sandbox.svg b/static/img/banner/banner_iota_sandbox.svg new file mode 100644 index 00000000000..75ad6c30dba --- /dev/null +++ b/static/img/banner/banner_iota_sandbox.svg @@ -0,0 +1,143 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/switcherConfig.js b/switcherConfig.js index d95111f9ae0..1cb8de7006d 100644 --- a/switcherConfig.js +++ b/switcherConfig.js @@ -30,6 +30,11 @@ const config = { description: 'Build dApps with ISC, our L2 smart contracts platform.', id: 'build-layer-2', }, + { + label: 'Tools', + description: 'Tools to develop your dApps.', + id: 'build-tools', + }, ], }, { diff --git a/versionedConfig.js b/versionedConfig.js index 68374706541..6596a3e044f 100644 --- a/versionedConfig.js +++ b/versionedConfig.js @@ -203,6 +203,19 @@ exports.buildPluginsConfig = [ }, ], }, + { + id: 'iota-sandbox', + label: 'IOTA Sandbox', + description: 'Your tool for local development.', + icon: 'Tools', + subsection: 'build-tools', + versions: [ + { + label: '', + badges: ['IOTA', 'Shimmer'], + }, + ], + }, ]; exports.maintainPluginsConfig = [