Skip to content

Commit

Permalink
Merge pull request #9 from webb-tools/update-validator-docs
Browse files Browse the repository at this point in the history
update docs for testnet
  • Loading branch information
drewstone authored Jan 9, 2024
2 parents 637e73a + fb26a43 commit d02ef5c
Show file tree
Hide file tree
Showing 15 changed files with 39 additions and 39 deletions.
10 changes: 5 additions & 5 deletions components/CommonActions.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,14 @@ const features = [
Icon: ServerIcon,
title: "Node Deployment",
description: `Want to spin up a full node on the Tangle Network? We've made it easier than ever!`,
href: "/docs/tangle-network/node/docker-node",
href: "/docs/node/docker-node",
action: "Deploy a Docker Node",
},
{
Icon: ServerIcon,
title: "Validators",
description: `Start your journey on Tangle Network. This guide will walk you through the steps to become a validator, ensuring network security and integrity.`,
href: "/docs/tangle-network/node/quickstart/",
href: "/docs/node/quickstart/",
action: "Launch a Quick Validator Node",
},
{
Expand All @@ -35,21 +35,21 @@ const features = [
Icon: ServerIcon,
title: "Accounts",
description: `Tangle uses Polkadot Apps to manage Accounts.`,
href: "https://polkadot.js.org/apps/?rpc=wss://rpc.tangle.tools#/explorer",
href: "https://polkadot.js.org/apps/?rpc=wss://testnet-rpc.tangle.tools#/explorer",
action: "Go to Polkadot Apps",
},
{
Icon: BookOpenIcon,
title: "Staking",
description: `Through Polkadot Apps you can create `,
href: "https://polkadot.js.org/apps/?rpc=wss://rpc.tangle.tools#/democracy",
href: "https://polkadot.js.org/apps/?rpc=wss://testnet-rpc.tangle.tools#/democracy",
action: "Manage Staking",
},
{
Icon: BookOpenIcon,
title: "Governance",
description: `Through governance, you can create proposals for updating cross-chain applications.`,
href: "https://polkadot.js.org/apps/?rpc=wss://rpc.tangle.tools#/democracy",
href: "https://polkadot.js.org/apps/?rpc=wss://testnet-rpc.tangle.tools#/democracy",
action: "Interact with Governance",
},
{
Expand Down
8 changes: 4 additions & 4 deletions components/NetworkConfig.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -98,14 +98,14 @@ const NetworkInfo = () => {
type: "Testnet",
symbol: "tTNT",
decimals: 18,
chainId: "4006",
rpcUrl: "https://rpc.tangle.tools",
wssUrl: "wss://rpc.tangle.tools",
chainId: "3799",
rpcUrl: "https://testnet-rpc.tangle.tools",
wssUrl: "wss://testnet-rpc.tangle.tools",
explorerUrls: [
{ name: "BlockScout", url: "https://explorer.tangle.tools" },
{
name: "PolkadotJS",
url: "https://polkadot.js.org/apps/?rpc=wss%3A%2F%2Frpc.tangle.tools#/explorer",
url: "https://polkadot.js.org/apps/?rpc=wss%3A%2F%2Ftestnet-rpc.tangle.tools#/explorer",
},
],
fundingInfo: {
Expand Down
4 changes: 2 additions & 2 deletions components/QuickStart.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ export const QuickStartArea = () => {
description: `Start your journey on Tangle Network. This guide will walk you through the steps to become a validator, ensuring network security and integrity.`,
name: "Validate on Tangle Network",
}}
href="/docs/tangle-network/node/quickstart/"
href="/docs/node/quickstart/"
></DetailedFeatureLink>
</div>
);
Expand Down Expand Up @@ -49,7 +49,7 @@ export const DeployArea = () => {
description: `Want to spin up a full node on the Tangle Network? We've made it easier than ever!`,
name: "Deploy a Tangle Node!",
}}
href="/docs/tangle-network/node/docker-node"
href="/docs/node/docker-node"
></DetailedFeatureLink>
</div>
);
Expand Down
6 changes: 3 additions & 3 deletions components/TangleQuickstart.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ export const QuickDeployArea = () => {
description: `Deploy a Tangle node in two steps`,
name: "Quick Deployment",
}}
href="/docs/ecosystem-roles/validator/systemd/quick-node/"
href="/docs/node/quickstart"
></DetailedFeatureLink>
</div>
);
Expand All @@ -32,15 +32,15 @@ export const DeployArea = () => {
description: `Deploy a Tangle node in minutes using Docker.`,
name: "Deploy with Docker",
}}
href="/docs/ecosystem-roles/validator/deploy-with-docker/full-node/"
href="/docs/node/docker-node"
></DetailedFeatureLink>
<DetailedFeatureLink
feature={{
Icon: ServerIcon,
description: `Run a Tangle node using Systemd.`,
name: "Run with Systemd",
}}
href="/docs/ecosystem-roles/validator/systemd/full-node/"
href="/docs/node/systemd"
/>
</div>
);
Expand Down
6 changes: 3 additions & 3 deletions components/UseCasesTangle.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -56,15 +56,15 @@ export const ParticipateArea = () => {
description: `Tangle Network on Polkadot Apps`,
name: "Interact with Tangle using Polkadot Apps",
}}
href="https://polkadot.js.org/apps/?rpc=wss://rpc.tangle.tools#/explorer"
href="https://polkadot.js.org/apps/?rpc=wss://testnet-rpc.tangle.tools#/explorer"
></DetailedFeatureLink>
<DetailedFeatureLink
feature={{
Icon: BookOpenIcon,
description: `Through governance, you can create proposals for updating cross-chain applications.`,
name: "Participate in Testnet Governance ",
}}
href="https://polkadot.js.org/apps/?rpc=wss://rpc.tangle.tools#/democracy"
href="https://polkadot.js.org/apps/?rpc=wss://testnet-rpc.tangle.tools#/democracy"
></DetailedFeatureLink>
</div>
);
Expand All @@ -79,7 +79,7 @@ export const TestNetworkArea = () => {
description: `Tangle Network runs independently without a relay chain.`,
name: "Tangle Network (Testnet)",
}}
href="https://polkadot.js.org/apps/?rpc=wss://rpc.tangle.tools#/explorer"
href="https://polkadot.js.org/apps/?rpc=wss://testnet-rpc.tangle.tools#/explorer"
></DetailedFeatureLink>
</div>
);
Expand Down
2 changes: 1 addition & 1 deletion pages/docs/build/deploy-using-hardhat.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ module.exports = {

<details>
<summary>Tangle Chain Information</summary>
You can view the latest details on networks, chainIDs, RPC URLs on the [Network Information and Configurations](/docs/tangle-network/getting-started/network-information-configuration/) page.
You can view the latest details on networks, chainIDs, RPC URLs on the [Network Information and Configurations](/docs/getting-started/network-information-configuration/) page.
</details>

Replace `<Tangle RPC URL>` with the RPC URL of the Tangle Network. Replace `<PRIVATE_KEY>` with the private key of the account that will be used to deploy the contracts. `<Tangle ChainId>` should be replaced with the ChainId of the Tangle Network.
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 @@ -28,4 +28,4 @@ Note: This guide assumes you have already set up a Substrate-based wallet and ha
8. **Wait for the Voting Period to End:**
Each referendum has a voting period. When this period ends, votes are tallied, and the decision is enacted based on the majority vote.

Remember that **voting in a referendum will lock your tokens until the end of the enactment period (if the proposal passes) or until the end of the voting period (if the proposal does not pass).** The length of these periods can vary, refer to [our parameters.](/docs/tangle-network/governance/governance-parameters/)
Remember that **voting in a referendum will lock your tokens until the end of the enactment period (if the proposal passes) or until the end of the voting period (if the proposal does not pass).** The length of these periods can vary, refer to [our parameters.](/docs/governance/governance-parameters/)
2 changes: 1 addition & 1 deletion pages/docs/governance/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ The governance system of Tangle Network is divided into two parts, the public re

Proposals can be made by any token holder. Others can agree with the proposal by seconding it and providing tokens equivalent to the original bond. The most seconded proposal during every launch period is moved to the public referenda table for active voting. Voters can lock their tokens for a longer duration to amplify their vote.

Detailed information on the governance system can be found [here](/docs/tangle-network/governance/overview/).
Detailed information on the governance system can be found [here](/docs/governance/overview/).

## Important Parameters for Democracy Module

Expand Down
18 changes: 9 additions & 9 deletions pages/docs/network-information-configuration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,11 @@ Before you dive into development, it's crucial to familiarize yourself with the

Developer tools may require specific configurations for the Tangle Network. Use the following details:

| Variable | Value |
| --------------- | -------------------------- |
| Chain ID | 4006 |
| Public RPC URLs | `https://rpc.tangle.tools` |
| Public WSS URLs | `wss://rpc.tangle.tools` |
| Variable | Value |
| --------------- | ---------------------------------- |
| Chain ID | 3799 |
| Public RPC URLs | `https://testnet-rpc.tangle.tools` |
| Public WSS URLs | `wss://testnet-rpc.tangle.tools` |

## Types for Chain Integration

Expand All @@ -31,10 +31,10 @@ To find the latest types for Tangle Network, [visit the lookup.tsx file in our G

We will offer two types of block explorers to accommodate the Ethereum API and Substrate API. Transactions based on the Ethereum Virtual Machine (EVM) can be accessed through the Ethereum API. Conversely, the Substrate API is your go-to for native Substrate operations such as governance and staking. While the Substrate API does provide some details about EVM-based transactions, the information it presents is somewhat limited.

| Block Explorer | Type | URL |
| -------------- | --------- | -------------------------------------------------------------------------------- |
| BlockScout | EVM | [link](https://https://explorer.tangle.tools/) |
| PolkadotJS | Substrate | [link](https://polkadot.js.org/apps/?rpc=wss%3A%2F%2Frpc.tangle.tools#/explorer) |
| Block Explorer | Type | URL |
| -------------- | --------- | ---------------------------------------------------------------------------------------- |
| BlockScout | EVM | [link](https://https://explorer.tangle.tools/) |
| PolkadotJS | Substrate | [link](https://polkadot.js.org/apps/?rpc=wss%3A%2F%2Ftestnet-rpc.tangle.tools#/explorer) |

## Funding Your Accounts

Expand Down
2 changes: 1 addition & 1 deletion pages/docs/node/flags.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ If you compiled the binary:
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-standalone-linux-amd64
- tangle-testnet-linux-amd64
- tangle-standalone-relayer-linux-amd64
- tangle-standalone-txpool-linux-amd64
</Callout>
2 changes: 1 addition & 1 deletion pages/docs/node/node-software.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ In the below commands, substitute `LATEST_RELEASE` with the version you want to
**Get tangle binary**

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

**Get tangle binary with txpool feature**
Expand Down
6 changes: 3 additions & 3 deletions pages/docs/node/quicknode.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,13 +19,13 @@ compiled the Tangle binary. If you have not done so, please refer to the [Requir
Use the latest release version in the url in place of `<VERSION>`, you can visit [releases](https://github.com/webb-tools/tangle/releases) page to view the latest info

```
wget https://github.com/webb-tools/tangle/releases/download/<VERSION>/tangle-standalone-linux-amd64
wget https://github.com/webb-tools/tangle/releases/download/<VERSION>/tangle-testnet-linux-amd64
```

For example, at the time of writing this document, the latest release is v0.4.7 and the link would be as follows

```
wget https://github.com/webb-tools/tangle/releases/download/v0.4.7/tangle-standalone-linux-amd64
wget https://github.com/webb-tools/tangle/releases/download/v0.4.7/tangle-testnet-linux-amd64
```

### 2. Start the node binary
Expand All @@ -38,7 +38,7 @@ Make sure to change the following params before executing the command
2. `<NODE_NAME>` : This is a unique node name for your node, use a unique name here to help identity your node to other validators and telemetry data

```
./tangle-standalone-linux-amd64 \
./tangle-testnet-linux-amd64 \
--base-path <BASE_PATH> \
--name <NODE_NAME> \
--chain tangle-testnet \
Expand Down
2 changes: 1 addition & 1 deletion pages/docs/node/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ is a collection of quick links for quick setups!

## Validators

Please see our new **[Start Validating guide.](/docs/tangle-network/node/validator/requirements)**
Please see our new **[Start Validating guide.](/docs/node/validator/requirements)**

## Quick Setup for Node Operators

Expand Down
6 changes: 3 additions & 3 deletions pages/docs/node/systemd.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,13 @@ Before following this guide, ensure that your machine's environment is set up an
Use the latest release version in the url in place of `<VERSION>`, you can visit [releases](https://github.com/webb-tools/tangle/releases) page to view the latest info

```
wget https://github.com/webb-tools/tangle/releases/download/<VERSION>/tangle-standalone-linux-amd64
wget https://github.com/webb-tools/tangle/releases/download/<VERSION>/tangle-testnet-linux-amd64
```

For example, at the time of writing this document, the latest release is v0.4.7 and the link would be as follows

```
wget https://github.com/webb-tools/tangle/releases/download/v0.4.7/tangle-standalone-linux-amd64
wget https://github.com/webb-tools/tangle/releases/download/v0.4.7/tangle-testnet-linux-amd64
```

### 2. Install Dependencies
Expand Down Expand Up @@ -325,7 +325,7 @@ rustup target add wasm32-unknown-unknown --toolchain nightly
#### Bond TNT and setup validator Account
After your node is synced, you are ready to setup keys and onboard as a validator, make sure to complete the steps
at [Start Validating](/docs/tangle-network/node/validator/requirements) to start validating.
at [Start Validating](/docs/node/validator/requirements) to start validating.
</Tabs.Tab>
<Tabs.Tab>
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 @@ -91,7 +91,7 @@ In order to participate in the distributed key generation (DKG) protocol, block
- Grandpa key (Ed25519)
- ImOnline key (Sr25519)

See the guides for [launching Tangle Network with Docker](/docs/tangle-network/validator/deploy-with-docker/validator-node/) and [Launching with Systemd](/docs/tangle-network/validator/systemd/validator-node/) for exact guides on this step.
See the guides for [launching Tangle Network with Docker](/docs/validator/deploy-with-docker/validator-node/) and [Launching with Systemd](/docs/validator/systemd/validator-node/) for exact guides on this step.

Once your node and keys are setup and your node is synced, proceed to the following:

Expand Down

0 comments on commit d02ef5c

Please sign in to comment.