Skip to content

Commit

Permalink
Merge branch 'main' into update-identity-wiki
Browse files Browse the repository at this point in the history
  • Loading branch information
eike-hass committed Feb 6, 2024
2 parents 7306bce + 44ba50d commit 99c2731
Show file tree
Hide file tree
Showing 209 changed files with 818 additions and 518 deletions.
4 changes: 0 additions & 4 deletions articleRedirects.js
Original file line number Diff line number Diff line change
Expand Up @@ -41,10 +41,6 @@ const ApiCore = [

exports.articleRedirects = [
...(directoryExists('./docs/build/apis/docs/core') ? ApiCore : []),
{
from: '/develop/endpoints/devnet',
to: '/build/networks-endpoints',
},
{
from: '/develop/endpoints/mainnet',
to: '/build/networks-endpoints',
Expand Down
4 changes: 2 additions & 2 deletions cli/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
},
"dependencies": {
"@babel/generator": "^7.21.5",
"@babel/parser": "^7.23.0",
"@babel/parser": "^7.23.9",
"@babel/types": "^7.23.6",
"@iota-wiki/core": "workspace:^",
"@yarnpkg/shell": "^3.3.0",
Expand All @@ -33,7 +33,7 @@
"ink-select-input": "^4.2.2",
"ink-spinner": "^4.0.3",
"ink-text-input": "^4.0.3",
"isomorphic-git": "^1.25.2",
"isomorphic-git": "^1.25.3",
"link-check": "^5.2.0",
"markdownlint-cli2": "^0.8.1",
"node-html-parser": "^6.1.10",
Expand Down
2 changes: 0 additions & 2 deletions common/jargon.js
Original file line number Diff line number Diff line change
Expand Up @@ -124,8 +124,6 @@ module.exports = {
'The process of token holders entrusting their delegated stake to a validator to act on their behalf and get rewarded with Mana.',
'deterministic Finality':
'Also known as “provable” or “absolute”, finality. An absolute level of certainty that once a transaction is added to the ledger, it cannot be changed or reverted. Deterministic Finality can be faster than other types of finality but halts when there is a network split or the activity of the network is low. ',
devnet:
'DevNet, or developer network, is a dedicated test network to experiment with and test a Tangle that operates without a Coordinator.',
'digital assets':
'Digital possessions or resources, such as cryptocurrencies or tokens.',
'digital Autonomy':
Expand Down
9 changes: 0 additions & 9 deletions contentPlugins.js
Original file line number Diff line number Diff line change
Expand Up @@ -40,15 +40,6 @@ module.exports = async () => {
},
},
},
{
id: 'iota-zebra-tutorials',
path: path.resolve(__dirname, 'docs/build/zebra-iota-edge-sdk/tutorials'),
routeBasePath: 'zebra-tutorials',
sidebarPath: path.resolve(
__dirname,
'docs/build/zebra-iota-edge-sdk/sidebars.js',
),
},
];

const maintainPlugins = [
Expand Down
5 changes: 5 additions & 0 deletions docs/_admonitions/_linux-commands.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
:::note Linux Commands

The commands assume you are using Linux.

:::
File renamed without changes.
5 changes: 5 additions & 0 deletions docs/build/getting-started/sidebars.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,11 @@ module.exports = {
slug: '/tools',
},
items: [
{
type: 'link',
label: 'IOTA Sandbox',
href: '/iota-sandbox/welcome',
},
{
type: 'link',
label: 'CLI Wallet',
Expand Down
3 changes: 3 additions & 0 deletions docs/build/identity.rs/1.0/docs/getting-started/wasm.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@ keywords:
- nodejs
- webpack
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

# Getting Started with WASM

## Minimum Requirements
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
description: The IOTA foundation provides load-balanced public Shimmer Beta endpoints, where MQTT and the HTTP REST API are enabled.
image: /img/logo/preview.png
keywords:
- devnet
- load-balanced
- HTTP REST API
- MQTT
Expand Down
2 changes: 1 addition & 1 deletion docs/build/introduction-docs/stardust/docs/resources.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: Official and Community resources to help you develop and troubleshoot your application.
image: /img/logo/preview.png
keywords:
tags:
- tangle explorer
- discord
- stackExchange
Expand Down
88 changes: 88 additions & 0 deletions docs/build/iota-sandbox/docs/getting-started.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
---
description: Set up and get started with the IOTA Sandbox
keywords:
- how to
- setup
- sandbox
---

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import LinuxCommands from '@site/docs/_admonitions/_linux-commands.md';

# Getting Started With the IOTA Sandbox

You can use this guide to [install](#install-the-iota-sandbox-using-docker)
and [run](#run) the [IOTA Sandbox](welcome.md).
It includes everything you need to develop your own IOTA dApps, plugins, and more.

## Install the IOTA Sandbox Using Docker

### Requirements

1. A recent release of [Docker](https://www.docker.com/). 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](https://docs.docker.com/).
2. [Docker Compose CLI plugin](https://docs.docker.com/compose/install/linux/).
3. sed
4. jq
5. Make sure ports 80 and 8082 are not in use by other applications. If they are change them in the `.env` file. Optional: If you enabled the explorer profile by default it will use port 8081

### Download the Latest Release

:::note

The commands assume you are using Linux.

:::

Once you have completed all the installation [requirements](#requirements), you can download the sandbox. The following command will download the latest version.

```sh
mkdir iota-sandbox && cd iota-sandbox && curl -L https://github.com/iotaledger/iota-sandbox/releases/latest/download/iota_sandbox.tar.gz | tar -zx
```

### Prepare

<LinuxCommands/>

#### Set Up Your Environment

In most cases the default setup should be enough. But you can edit the `.env` file to configure some optional settings:

```sh reference
https://github.com/iotaledger/iota-sandbox/blob/main/sandbox/.env
```

#### Bootstrap

If you haven't run the IOTA Sandbox before, you need to bootstrap it. To do that, just run the following command:

```sh
sudo ./bootstrap.sh
```

## Run

### Start the IOTA Sandbox

You can start the IOTA Sandbox by running:

```sh
docker compose up -d
```

- `-d` Instructs Docker to start the containers in the background.

:::tip Available endpoints

Once the container is up and running, you can access the node using the
available [endpoints](references/endpoints.md).

:::

### Stop the IOTA Sandbox

You can stop the IOTA Sandbox by running the following commands:

```sh
docker compose down
```
10 changes: 10 additions & 0 deletions docs/build/iota-sandbox/docs/how-tos/interact-wasp.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: Interact with Wasp
description: Interact with a wasp chain and configure the needed tools.
keywords:
- how to
- setup
- chain
---

The sandbox comes with a bootstrapped wasp chain and the [EVM Toolkit](https://github.com/iotaledger/evm-toolkit) preconfigured. You can find its ID and RPC url in the [Wasp Dashboard](../references/endpoints.md#dashboard-1). Together with the prefunded [L2 account](../references/keys.md#l2-account) you can use it together with tools like hardhat or ethers.js.
111 changes: 111 additions & 0 deletions docs/build/iota-sandbox/docs/references/endpoints.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,111 @@
---
title: Endpoints
description: Endpoints and credentials of the IOTA Sandbox
keywords:
- api
- passwords
- users
- credentials
- endpoints
- reference
---

# Endpoints

Once you have [installed](../getting-started.md#install-the-iota-sandbox-using-docker),
[bootstrapped](../getting-started.md#bootstrap),
and [started](../getting-started.md#start-the-iota-sandbox) the IOTA Sandbox,
you can access the following endpoints:

## Hornet

### Dashboard

```plaintext
http://localhost/
```

#### Default Credentials

**Username**: `admin`
**Password**: `admin`

### API

```plaintext
http://localhost/
```

### INX

```plaintext
http://localhost:9029/
```

## Faucet

### Frontend

```plaintext
http://localhost/faucet/
```

### API

```plaintext
http://localhost/faucet/
```

## Wasp

### Dashboard

```plaintext
http://localhost/wasp/dashboard/
```

#### Default Credentials

**Username**: `wasp`
**Password**: `wasp`

### API

```plaintext
http://localhost/wasp/api/
```

## Chronicle

### API

```plaintext
http://localhost/chronicle/
```

## EVM Toolkit

:::info Port

The EVM Toolkit is available on port `8082` by default. You can change it in the `.env` file.

:::

### Frontend

```plaintext
http://localhost:8082/
```

## Grafana

### Frontend

```plaintext
http://localhost/grafana/
```

#### Default Credentials

**Username**: `admin`
**Password**: `admin`
45 changes: 45 additions & 0 deletions docs/build/iota-sandbox/docs/references/keys.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
---
title: Keys for the IOTA Sandbox
description: Keys for the IOTA Sandbox
keywords:
- keys
- reference
---
## Keys

You can use the following pre-funded mnemonics and addresses while working with 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 bech32 address with `snd` HRP | snd1qqx6kw52j70ed3mr5pukt048kya86vnxp33d3czvhpp9r6rvljg922ksxeq |

### 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 bech32 address with `snd` HRP | snd1qzu4rgaqaymc7udxfm23urh98xr2yy4cezlmpsc7808v0skahdvax882xtm |

### 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 bech32 address with `snd` HRP | snd1qre96hg2vhuzr7apqxeqtp8cs66ndfcjx0sdhpgr6xlhfeh0a2hzj2zmcll |

### Wasp Default Chain

| Name | Value |
|-------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------|
| Token mnemonic | income seed actor ankle gesture sock twenty satoshi bonus sister use afraid phrase muffin purse alpha year volcano name recall slim stick sister eagle |
| Token bech32 address with `snd` HRP | snd1qqrku7yz0wd87v20qxnd7hyzunjpt36jckk5t227k93e5rhzhtqlxwk4qsu |

### L2 Account

| Name | Value |
|-------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Token mnemonic | echo mass dentist hood neutral claw fragile scare magnet float citizen pink order hundred village edge quality excuse donor spawn heart happy extend resist |
| EVM Address | 0xb62ea087c36eBd77Fb58174Ae162395722dE9Cb0 |
30 changes: 30 additions & 0 deletions docs/build/iota-sandbox/docs/welcome.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
description: The IOTA Sandbox serves as a local network designed specifically for developers.
keywords:
- sandbox
- TOC
- overview
- reference
---
# IOTA Sandbox

![IOTA Sandbox](/img/banner/banner_iota_sandbox.svg)

The IOTA Sandbox serves as a local network designed specifically for developers.
It enables prototyping and testing of smart contracts, INX plugins, and Layer 1 applications within the IOTA ecosystem.
This Sandbox offers a secure and isolated environment for developers to experiment and verify functionality prior to deploying in production settings.

:::warning For research & development only

The IOTA Sandbox is intended for research and development purposes only.
It is not for creating production-ready networks.

:::

:::tip Public Testnet

If possible,
you should use the [public testnet](https://wiki.iota.org/build/networks-endpoints/#public-testnet)
where you can experiment with confidence and community support.

:::
Loading

0 comments on commit 99c2731

Please sign in to comment.