Skip to content
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: update typos and naming #17

Merged
merged 2 commits into from
Jan 22, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion pages/docs/faq.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ For full support, see our guides on [Logging](https://docs.tangle.tools/docs/nod

## How much stake do I need to become a validator in the active set?

Per era, the NPoS system selects a certain number of nodes with the most TNT to validate. Therefore, the minimum amount required to become an active nominator and earn rewards may change from era to era. You can check the active validator set's stake at https://polkadot.js.org/apps/?rpc=wss%3A%2F%2Ftangle-standalone-archive.webb.tools#/staking
Per era, the NPoS system selects a certain number of nodes with the most TNT to validate. Therefore, the minimum amount required to become an active nominator and earn rewards may change from era to era. You can check the active validator set's stake at https://polkadot.js.org/apps/?rpc=wss%3A%2F%2Ftestnet-rpc.webb.tools#/staking

## How do I set an identity on my account?

Expand Down
2 changes: 1 addition & 1 deletion pages/docs/governance/democracy-voting.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Substrate-based blockchains often have built-in on-chain governance mechanisms,
Note: This guide assumes you have already set up a Substrate-based wallet and have some tokens in your account.

1. **Access the Polkadot/Substrate User Interface (UI):**
Visit the [Substrate UI](https://polkadot.js.org/apps/). This web interface is used to interact with the Tangle network and other Substrate chains, during our testnet phase you can use [Webb's alpha interface](https://polkadot.js.org/apps/?rpc=wss%3A%2F%2Ftangle-standalone-archive.webb.tools#/accounts)
Visit the [Substrate UI](https://polkadot.js.org/apps/). This web interface is used to interact with the Tangle network and other Substrate chains, during our testnet phase you can use [Webb's alpha interface](https://polkadot.js.org/apps/?rpc=wss%3A%2F%2Ftestnet-rpc.tangle.tools#/accounts)

2. **Connect to the correct network:**
Ensure you're connected to the Tangle Network, if not, at the top-left of the page, you will see a drop-down menu. Here you can select the Tangle network.
Expand Down
2 changes: 1 addition & 1 deletion pages/docs/governance/governance-interfaces.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@

At this time, two interfaces are planned that you can utilize to vote, discuss, propose and run for office:

1. Polkadot JS ('Apps') (See Testnet Apps at https://polkadot.js.org/apps/?rpc=wss%3A%2F%2Ftangle-standalone-archive.webb.tools#/)
1. Polkadot JS ('Apps') (See Testnet Apps at https://polkadot.js.org/apps/?rpc=wss%3A%2F%2Ftestnet-rpc.tangle.tools#/)
2. [Commonwealth](https://commonwealth.im/webb)
38 changes: 13 additions & 25 deletions pages/docs/node/docker-node.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -32,19 +32,7 @@ Let us create a directory where we will store all the data for our node. This in
mkdir /var/lib/tangle/
```

### 3. Fetch applicable chainspec(s):

To join the Tangle Test network, we need to fetch the appropriate chainspec for the Tangle network.
Download the latest chainspec for standalone testnet:

```sh filename="get chainspec" copy
# Fetches chainspec for Tangle network
wget https://raw.githubusercontent.com/webb-tools/tangle/main/chainspecs/testnet/tangle-standalone.json
```

Please make a reference where you have stored this `json` file as we will need it in the next steps.

### 4. Select and Start your Node Type
### 3. Select and Start your Node Type

<Tabs items={['Full Node', 'Validator Node']}>
<Tabs.Tab>
Expand All @@ -61,7 +49,7 @@ docker run --rm -it -v /var/lib/tangle/:/data ghcr.io/webb-tools/tangle/tangle:m
--base-path /data \
--rpc-cors all \
--port 9946 \
--telemetry-url "wss://telemetry.polkadot.io/submit/ 0" --name <NODE_NAME>
--telemetry-url "wss://telemetry.polkadot.io/submit/ 0"
```

<Callout type="info">
Expand Down Expand Up @@ -99,7 +87,7 @@ should paste your SURI when the command asks for it.
docker run --rm -it --platform linux/amd64 --network="host" -v "/var/lib/data" \
ghcr.io/webb-tools/tangle/tangle:main \
key insert --base-path /var/lib/tangle/ \
--chain /data/chainspecs/tangle-standalone.json \
--chain tangle-testnet \
--scheme Sr25519 \
--key-type acco
```
Expand All @@ -110,7 +98,7 @@ ghcr.io/webb-tools/tangle/tangle:main \
docker run --rm -it --platform linux/amd64 --network="host" -v "/var/lib/data" \
ghcr.io/webb-tools/tangle/tangle:main \
key insert --base-path /var/lib/tangle/ \
--chain /data/chainspecs/tangle-standalone.json \
--chain tangle-testnet \
--scheme Sr25519 \
--key-type babe
```
Expand All @@ -121,7 +109,7 @@ ghcr.io/webb-tools/tangle/tangle:main \
docker run --rm -it --platform linux/amd64 --network="host" -v "/var/lib/data" \
ghcr.io/webb-tools/tangle/tangle:main \
key insert --base-path /var/lib/tangle/ \
--chain /data/chainspecs/tangle-standalone.json \
--chain tangle-testnet \
--scheme Sr25519 \
--key-type imon
```
Expand All @@ -131,8 +119,8 @@ ghcr.io/webb-tools/tangle/tangle:main \
```sh filename="Role" copy
docker run --rm -it --platform linux/amd64 --network="host" -v "/var/lib/data" \
ghcr.io/webb-tools/tangle/tangle:main \
tangle-standalone key insert --base-path /data \
--chain /data/chainspecs/tangle-standalone.json \
tangle key insert --base-path /data \
--chain tangle-testnet \
--scheme Ecdsa \
--key-type role
```
Expand All @@ -142,8 +130,8 @@ ghcr.io/webb-tools/tangle/tangle:main \
```sh filename="Grandpa" copy
docker run --rm -it --platform linux/amd64 --network="host" -v "/var/lib/data" \
ghcr.io/webb-tools/tangle/tangle:main \
tangle-standalone key insert --base-path /data \
--chain /data/chainspecs/tangle-standalone.json \
tangle key insert --base-path /data \
--chain tangle-testnet \
--scheme Ed25519 \
--key-type gran
```
Expand All @@ -163,7 +151,7 @@ if you want the node to auto generate the keys, add the `--auto-insert-keys` fla
To start the node run the following command:

```sh filename="docker run" copy
docker run --platform linux/amd64 --network="host" -v "/var/lib/data" --entrypoint ./tangle-standalone \
docker run --platform linux/amd64 --network="host" -v "/var/lib/data" --entrypoint ./tangle \
ghcr.io/webb-tools/tangle/tangle:main \
--base-path=/data \
--chain tangle-testnet \
Expand All @@ -172,7 +160,7 @@ ghcr.io/webb-tools/tangle/tangle:main \
--wasm-execution compiled \
--trie-cache-size 0 \
--validator \
--telemetry-url "wss://telemetry.polkadot.io/submit/ 0" --name <NODE_NAME>
--telemetry-url "wss://telemetry.polkadot.io/submit/ 0"
```

<Callout type="info">
Expand All @@ -192,8 +180,8 @@ blocks being produced on the Tangle network!
2023-03-22 14:55:51 📋 Chain specification: Tangle Testnet
2023-03-22 14:55:51 🏷 Node name: cooing-morning-2891
2023-03-22 14:55:51 👤 Role: FULL
2023-03-22 14:55:51 💾 Database: RocksDb at /Users/local/Library/Application Support/tangle-standalone/chains/local_testnet/db/full
2023-03-22 14:55:51 ⛓ Native runtime: tangle-standalone-115 (tangle-standalone-1.tx1.au1)
2023-03-22 14:55:51 💾 Database: RocksDb at /Users/local/Library/Application Support/tangle/chains/local_testnet/db/full
2023-03-22 14:55:51 ⛓ Native runtime: tangle-115 (tangle-1.tx1.au1)
2023-03-22 14:55:51 Bn254 x5 w3 params
2023-03-22 14:55:51 [0] 💸 generated 5 npos voters, 5 from validators and 0 nominators
2023-03-22 14:55:51 [0] 💸 generated 5 npos targets
Expand Down
6 changes: 2 additions & 4 deletions pages/docs/node/flags.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ ghcr.io/webb-tools/tangle/tangle:main --help

If you used the binary directly:

`./tangle-standalone-YOUR-VERSION-HERE> --help`
`./tangle-YOUR-VERSION-HERE> --help`

If you compiled the binary:

Expand All @@ -93,8 +93,6 @@ If you compiled the binary:
<Callout>
Currently, your release may be one the following.
Refer to [the Releases page on our Github for more information](https://github.com/webb-tools/tangle/releases):
- tangle-standalone-light-client-linux-amd64
- tangle-testnet-linux-amd64
- tangle-standalone-relayer-linux-amd64
- tangle-standalone-txpool-linux-amd64
- tangle-txpool-linux-amd64
</Callout>
18 changes: 3 additions & 15 deletions pages/docs/node/node-software.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,27 +24,15 @@ wget https://github.com/webb-tools/tangle/releases/download/<LATEST_RELEASE>/tan
**Get tangle binary with txpool feature**

```sh filename="Get binary txpool" copy
wget https://github.com/webb-tools/tangle/releases/download/<LATEST_RELEASE>/tangle-standalone-txpool-linux-amd64
```

**Get tangle binary with relayer feature**

```sh filename="Get binary relayer" copy
wget https://github.com/webb-tools/tangle/releases/download/<LATEST_RELEASE>/tangle-standalone-relayer-linux-amd64
```

**Get tangle binary with light-client feature**

```sh filename="Get binary light" copy
wget https://github.com/webb-tools/tangle/releases/download/<LATEST_RELEASE>/tangle-standalone-light-client-linux-amd64
wget https://github.com/webb-tools/tangle/releases/download/<LATEST_RELEASE>/tangle-txpool-linux-amd64
```

### Synchronize Chain Data

Once installed, you can begin syncing your node by running the following command. **Your path may vary depend on whether you used the binary, or built from source**:

```sh filename="Syncing node" copy
./tangle-standalone
./tangle
```

Once your node has fully syncronized with Tangle Network you may proceed to setup the
Expand Down Expand Up @@ -141,7 +129,7 @@ cargo build --release
> NOTE: You _must_ use the release builds! The optimizations here are required
> as in debug mode, it is expected that nodes are not able to run fast enough to produce blocks.

You will now have the `tangle-standalone` binary built in `target/release/` dir
You will now have the `tangle` binary built in `target/release/` dir

### Synchronize Chain Data

Expand Down
8 changes: 4 additions & 4 deletions pages/docs/node/quicknode.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ wget https://github.com/webb-tools/tangle/releases/download/v0.6.1/tangle-testne

### 2. Start the node binary

To start the binary you can run the following command (ensure you are in the same folder where tangle-standalone is downloaded)
To start the binary you can run the following command (ensure you are in the same folder where tangle is downloaded)

Make sure to change the following params before executing the command

Expand All @@ -45,7 +45,7 @@ Make sure to change the following params before executing the command
--port 9944 \
--validator \
--auto-insert-keys \
--telemetry-url "wss://telemetry.polkadot.io/submit/ 0" --name <NODE_NAME>
--telemetry-url "wss://telemetry.polkadot.io/submit/ 0"
```

If the node is running correctly, you should see an output similar to below:
Expand All @@ -57,8 +57,8 @@ If the node is running correctly, you should see an output similar to below:
2023-03-22 14:55:51 📋 Chain specification: Tangle Testnet
2023-03-22 14:55:51 🏷 Node name: cooing-morning-2891
2023-03-22 14:55:51 👤 Role: FULL
2023-03-22 14:55:51 💾 Database: RocksDb at /Users/local/Library/Application Support/tangle-standalone/chains/local_testnet/db/full
2023-03-22 14:55:51 ⛓ Native runtime: tangle-standalone-115 (tangle-standalone-1.tx1.au1)
2023-03-22 14:55:51 💾 Database: RocksDb at /Users/local/Library/Application Support/tangle/chains/local_testnet/db/full
2023-03-22 14:55:51 ⛓ Native runtime: tangle-115 (tangle-1.tx1.au1)
2023-03-22 14:55:51 Bn254 x5 w3 params
2023-03-22 14:55:51 [0] 💸 generated 5 npos voters, 5 from validators and 0 nominators
2023-03-22 14:55:51 [0] 💸 generated 5 npos targets
Expand Down
42 changes: 21 additions & 21 deletions pages/docs/node/systemd.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ rustup target add wasm32-unknown-unknown --toolchain nightly
Run the following commands to create the service configuration file:

```sh filename="mv" copy
# Move the tangle-standalone binary to the bin directory (assumes you are in repo root directory)
# Move the tangle binary to the bin directory (assumes you are in repo root directory)
sudo mv ./target/release/tangle /usr/bin/
```

Expand All @@ -79,15 +79,15 @@ rustup target add wasm32-unknown-unknown --toolchain nightly
User=<USERNAME>
Restart=always
RestartSec=3
ExecStart=/usr/bin/tangle-standalone \
--base-path /data/full-node \
ExecStart=/usr/bin/tangle \
--base-path <BASE_PATH> \
--name <NODE-NAME> \
--chain tangle-testnet \
--node-key-file "/home/<USERNAME>/node-key" \
--rpc-cors all \
--port 9946 \
--no-mdns \
--telemetry-url "wss://telemetry.polkadot.io/submit/ 0" --name <NODE_NAME>
--telemetry-url "wss://telemetry.polkadot.io/submit/ 0"

[Install]
WantedBy=multi-user.target
Expand Down Expand Up @@ -149,8 +149,8 @@ rustup target add wasm32-unknown-unknown --toolchain nightly

```sh filename="Acco" copy
# it will ask for your suri, enter it.
./target/release/tangle key insert --base-path /data/validator/<USERNAME> \
--chain ./chainspecs/tangle-standalone.json \
./target/release/tangle key insert --base-path <BASE_PATH> \
--chain tangle-testnet \
--scheme Sr25519 \
--suri <"12-MNEMONIC-PHARSE"> \
--key-type acco
Expand All @@ -160,8 +160,8 @@ rustup target add wasm32-unknown-unknown --toolchain nightly

```sh filename="Babe" copy
# it will ask for your suri, enter it.
./target/release/tangle key insert --base-path /data/validator/<USERNAME> \
--chain ./chainspecs/tangle-standalone.json \
./target/release/tangle key insert --base-path <BASE_PATH> \
--chain tangle-testnet \
--scheme Sr25519 \
--suri <"12-MNEMONIC-PHARSE"> \
--key-type babe
Expand All @@ -171,8 +171,8 @@ rustup target add wasm32-unknown-unknown --toolchain nightly

```sh filename="Imonline" copy
# it will ask for your suri, enter it.
./target/release/tangle key insert --base-path /data/validator/<USERNAME> \
--chain ./chainspecs/tangle-standalone.json \
./target/release/tangle key insert --base-path <BASE_PATH> \
--chain tangle-testnet \
--scheme Sr25519 \
--suri <"12-MNEMONIC-PHARSE"> \
--key-type imon
Expand All @@ -182,8 +182,8 @@ rustup target add wasm32-unknown-unknown --toolchain nightly

```sh filename="Role" copy
# it will ask for your suri, enter it.
./target/release/tangle key insert --base-path /data/validator/<USERNAME> \
--chain ./chainspecs/tangle-standalone.json \
./target/release/tangle key insert --base-path <BASE_PATH> \
--chain tangle-testnet \
--scheme Ecdsa \
--suri <"12-MNEMONIC-PHARSE"> \
--key-type role
Expand All @@ -194,7 +194,7 @@ rustup target add wasm32-unknown-unknown --toolchain nightly
```sh filename="Grandpa" copy
# it will ask for your suri, enter it.
./target/release/tangle key insert --base-path /data/validator/<USERNAME> \
--chain ./chainspecs/tangle-standalone.json \
--chain tangle-testnet \
--scheme Ed25519 \
--suri <"12-MNEMONIC-PHARSE"> \
--key-type gran
Expand All @@ -212,7 +212,7 @@ rustup target add wasm32-unknown-unknown --toolchain nightly
Run the following commands to create the service configuration file:

```sh filename="mv" copy
# Move the tangle-standalone binary to the bin directory (assumes you are in repo root directory)
# Move the tangle binary to the bin directory (assumes you are in repo root directory)
sudo mv ./target/release/tangle /usr/bin/
```

Expand All @@ -236,15 +236,15 @@ rustup target add wasm32-unknown-unknown --toolchain nightly
User=<USERNAME>
Restart=always
RestartSec=3
ExecStart=/usr/bin/tangle-standalone \
--base-path /data/validator/<USERNAME> \
ExecStart=/usr/bin/tangle \
--base-path <BASE_PATH> \
--name <NODE-NAME> \
--chain tangle-testnet \
--node-key-file "/home/<USERNAME>/node-key" \
--port 30333 \
--validator \
--no-mdns \
--telemetry-url "wss://telemetry.polkadot.io/submit/ 0" --name <NODE_NAME>
--telemetry-url "wss://telemetry.polkadot.io/submit/ 0"

[Install]
WantedBy=multi-user.target
Expand Down Expand Up @@ -283,8 +283,8 @@ rustup target add wasm32-unknown-unknown --toolchain nightly
2023-03-22 14:55:51 📋 Chain specification: Tangle Testnet
2023-03-22 14:55:51 🏷 Node name: cooing-morning-2891
2023-03-22 14:55:51 👤 Role: FULL
2023-03-22 14:55:51 💾 Database: RocksDb at /Users/local/Library/Application Support/tangle-standalone/chains/local_testnet/db/full
2023-03-22 14:55:51 ⛓ Native runtime: tangle-standalone-115 (tangle-standalone-1.tx1.au1)
2023-03-22 14:55:51 💾 Database: RocksDb at /Users/local/Library/Application Support/tangle/chains/local_testnet/db/full
2023-03-22 14:55:51 ⛓ Native runtime: tangle-115 (tangle-1.tx1.au1)
2023-03-22 14:55:51 Bn254 x5 w3 params
2023-03-22 14:55:51 [0] 💸 generated 5 npos voters, 5 from validators and 0 nominators
2023-03-22 14:55:51 [0] 💸 generated 5 npos targets
Expand Down Expand Up @@ -343,8 +343,8 @@ rustup target add wasm32-unknown-unknown --toolchain nightly
User=<USERNAME>
Restart=always
RestartSec=3
ExecStart=/usr/bin/tangle-standalone \
--base-path /data/full-node \
ExecStart=/usr/bin/tangle \
--base-path <BASE_PATH> \
--name <NODE-NAME> \
--chain tangle-testnet \
--node-key-file "/home/<USERNAME>/node-key" \
Expand Down
2 changes: 1 addition & 1 deletion pages/docs/node/validator/requirements.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ Session keys are a critical aspect of the Tangle Network's consensus mechanism,
After your node is fully synchronized with the network, stop the process using Ctrl-C. You'll now start your node by designating itself as a validator:

```
tangle-standalone --validator --name "YourNodeNameOnTelemetry"
tangle --validator --name "YourNodeNameOnTelemetry"
```

The output will be similar to:
Expand Down