diff --git a/.github/workflows/checks.yml b/.github/workflows/checks.yml index 7fb5ff19..73c2c0b1 100644 --- a/.github/workflows/checks.yml +++ b/.github/workflows/checks.yml @@ -59,8 +59,9 @@ jobs: access_token: ${{ secrets.GITHUB_TOKEN }} - uses: actions/checkout@v3 - name: Link Checker - uses: lycheeverse/lychee-action@v1.5.4 + uses: lycheeverse/lychee-action@v1.9.0 with: + args: --verbose --no-progress './**/*.md' './**/*.html' './**/*.mdx' fail: true env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/.lycheeignore b/.lycheeignore new file mode 100644 index 00000000..a9a04527 --- /dev/null +++ b/.lycheeignore @@ -0,0 +1,2 @@ +http://localhost* +https://localhost* \ No newline at end of file diff --git a/components/NetworkConfig.tsx b/components/NetworkConfig.tsx index 5c022715..53ee057e 100644 --- a/components/NetworkConfig.tsx +++ b/components/NetworkConfig.tsx @@ -95,7 +95,7 @@ const NetworkInfo = () => { rpcUrl: "https://testnet-rpc.tangle.tools", wssUrl: "wss://testnet-rpc.tangle.tools", explorerUrls: [ - { name: "BlockScout", url: "https://explorer.tangle.tools" }, + { name: "BlockScout", url: "https://testnet-explorer.tangle.tools" }, { name: "PolkadotJS", url: "https://polkadot.js.org/apps/?rpc=wss://testnet-rpc.tangle.tools#/explorer", diff --git a/package.json b/package.json index 5c77e962..d8e8d4f1 100644 --- a/package.json +++ b/package.json @@ -8,7 +8,7 @@ "start": "next start", "build": "next build", "export": "next export", - "lint": "next lint", + "lint": "next lint && yarn format", "schema": "turbo-gen ./public/schema.json", "format": "prettier --write \"{components,pages}/**/*.{mdx,ts,js,jsx,tsx,json}\" ", "format:check": "prettier --check \"{components,pages}/**/*.{mdx,ts,js,jsx,tsx,json}\" " diff --git a/pages/docs/_meta.json b/pages/docs/_meta.json index 05fa9376..1a66a2c5 100644 --- a/pages/docs/_meta.json +++ b/pages/docs/_meta.json @@ -8,7 +8,7 @@ "node": "Node", "governance": "Govern", "community": "Community", - "faqs": "FAQs", + "faq": "FAQ", "glossary": "Glossary", "contribute": "Contribute or Submit a Bug", "webb_docs_link": { diff --git a/pages/docs/build/pallets/balances-and-accounts.mdx b/pages/docs/build/pallets/balances-and-accounts.mdx index ae3956a1..c7d044bd 100644 --- a/pages/docs/build/pallets/balances-and-accounts.mdx +++ b/pages/docs/build/pallets/balances-and-accounts.mdx @@ -37,4 +37,4 @@ The Balances pallet provides a versatile API that allows interaction from within - `unreserve`: Unreserve some funds, returning any amount that was unable to be unreserved. - `slash`: Deducts up to a value from the combined balance of `who`, preferring to deduct from the free balance. This function cannot fail. -Please refer to the [official API documentation](https://substrate.dev/rustdocs/latest/pallet_balances/index.html) to learn more about the API provided by the Balances +Please refer to the [official API documentation](https://paritytech.github.io/polkadot-sdk/master/pallet_balances/index.html) to learn more about the API provided by the Balances diff --git a/pages/docs/build/pallets/consensus-mechanism.mdx b/pages/docs/build/pallets/consensus-mechanism.mdx index 7b45948d..ec2295e9 100644 --- a/pages/docs/build/pallets/consensus-mechanism.mdx +++ b/pages/docs/build/pallets/consensus-mechanism.mdx @@ -38,4 +38,4 @@ Key functions of the Staking pallet include: - `nominate`: A bonded account can nominate one or more validators to be elected. - `payout_stakers`: Pay the last reward to the stakers of a validator. -Please refer to the [official API documentation](https://substrate.dev/rustdocs/latest/pallet_staking/index.html) to learn more about the API provided by the Staking pallet. +Please refer to the [official API documentation](https://crates.parity.io/pallet_staking/index.html) to learn more about the API provided by the Staking pallet. diff --git a/pages/docs/build/pallets/interoperability.mdx b/pages/docs/build/pallets/interoperability.mdx index 50e18dd2..b4bb03dd 100644 --- a/pages/docs/build/pallets/interoperability.mdx +++ b/pages/docs/build/pallets/interoperability.mdx @@ -1,4 +1,4 @@ # Interoperability Tangle Network is designed to connect to other blockchains through bridges, and is specially designed to govern and host connections to Webb's bespoke Hubble Bridge, a private and interoperable transfer bridge. -See Hubble at https://app.webb.tools or the [Docs for Hubble Bridge](/docs/projects/hubble-bridge/overview) +See Hubble at https://app.webb.tools or the [Docs for Hubble Bridge](https://docs.webb.tools/docs/projects/hubble-bridge/overview/) diff --git a/pages/docs/faqs.mdx b/pages/docs/faq.mdx similarity index 90% rename from pages/docs/faqs.mdx rename to pages/docs/faq.mdx index 1d3c90b7..282169f5 100644 --- a/pages/docs/faqs.mdx +++ b/pages/docs/faq.mdx @@ -19,7 +19,7 @@ The following specifications are the ideal or recommended, but nodes can be run | Memory | 32GB ECC | | Firewall | P2P port must be open to incoming traffic:
- Source: Any
- Destination: 30333, 30334 TCP | -See https://docs.webb.tools/docs/ecosystem-roles/validator/requirements/ for more information. +See [Hardware](https://docs.tangle.tools/docs/node/hardware/) and [Getting Started with Validating](https://docs.tangle.tools/docs/node/validator/requirements/) for more information. ## What about backup nodes? @@ -60,7 +60,7 @@ We're working on this, check back soon! ## What are the recommendations for monitoring my node? -Monitoring is critical for success as a node operator. See our full Monitoring guide at https://docs.webb.tools/docs/node/monitoring/quickstart// +Monitoring is critical for success as a node operator. See our full [Monitoring guide](https://docs.tangle.tools/docs/node/monitoring/quickstart/) ## What are the KPIs I should be monitoring? @@ -68,7 +68,7 @@ The main key performance indicator for a node operator is the number of blocks p ## How should I set up alerting? -Alerting is critical for your success as a node operator, see our full guide to using our recommended AlertManager at https://docs.webb.tools/docs/node/monitoring/alert-manager/ +Alerting is critical for your success as a node operator, see our full guide to using our recommended AlertManager (https://docs.tangle.tools/docs/node/monitoring/alert-manager/) ## What is the failover process if my primary node is down? @@ -76,7 +76,7 @@ When the primary server is down, the best way to perform a failover to the backu ## What should I look for in the logs? -For full support, see our guides on logging at https://docs.webb.tools/docs/node/monitoring/loki/. +For full support, see our guides on [Logging](https://docs.tangle.tools/docs/node/monitoring/loki/). ## How much stake do I need to become a validator in the active set? diff --git a/pages/docs/governance/democracy-voting.mdx b/pages/docs/governance/democracy-voting.mdx index a1602f0a..111f6d20 100644 --- a/pages/docs/governance/democracy-voting.mdx +++ b/pages/docs/governance/democracy-voting.mdx @@ -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/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.](./governance-parameters.mdx) diff --git a/pages/docs/governance/overview.mdx b/pages/docs/governance/overview.mdx index d16831e6..3f4918ae 100644 --- a/pages/docs/governance/overview.mdx +++ b/pages/docs/governance/overview.mdx @@ -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/governance/overview/). +Detailed information on the governance system can be found [here](https://marketplace.substrate.io/pallets/pallet-democracy/). ## Important Parameters for Democracy Module diff --git a/pages/docs/network-information-configuration.mdx b/pages/docs/network-information-configuration.mdx index d927bde9..598d7ce1 100644 --- a/pages/docs/network-information-configuration.mdx +++ b/pages/docs/network-information-configuration.mdx @@ -33,7 +33,7 @@ We will offer two types of block explorers to accommodate the Ethereum API and S | Block Explorer | Type | URL | | -------------- | --------- | ---------------------------------------------------------------------------------- | -| BlockScout | EVM | [link](https://https://explorer.tangle.tools/) | +| BlockScout | EVM | [link](https://testnet-explorer.tangle.tools/) | | PolkadotJS | Substrate | [link](https://polkadot.js.org/apps/?rpc=wss://testnet-rpc.tangle.tools#/explorer) | ## Funding Your Accounts @@ -54,7 +54,7 @@ As an Ethereum-compatible, Substrate-based chain, Tangle Network allows for the ## Participating in the Tangle Network -Joining the Tangle Network community is easy. You can run a node, develop a Dapp, or contribute to our open-source codebase. For more information, visit our [Node Operation Guide](/docs/node/quickstart/), and [Contribution Guide](/docs/contribute). +Joining the Tangle Network community is easy. You can run a node, develop a Dapp, or contribute to our open-source codebase. For more information, visit our [Node Operation Guide](./node/quickstart.mdx), and [Contribution Guide](./contribute.mdx). ## Looking Ahead: Mainnet Launches @@ -64,21 +64,21 @@ Our official Mainnet launch date is forthcoming, so stay tuned! Post-launch, we' Users can participate by engaging in the following activities, you can share your contributions to [our Discord](https://webb.tools/community) in the `#contributions` channel. -| Task | Instructions | -| ---------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -| Creative Contribution | - | -| Use Case Concepts | User Submission. Write an article discussing a use case for the technologies Tangle uses! | -| Publish a video or tutorial on Tangle/Webb | Publish a high-quality video discussing the network or its privacy technologies. | -| Author a Protocol Extension | Create and submit an extension to the protocols used in Tangle. See our GitHub | -| Tweet about Webb | Tag [@webbprotocol](https://twitter.com/webbprotocol) in a high quality tweet about the network. | -| Deposit → Transfer → Withdraw | Perform a transaction flow on the network or the Hubble Bridge. | -| Tweet a hash of your address + a secret number | Make sure to tag @Webbprotocol. | -| Vote in Governance | See the Polkadot Governance Docs for [how to participate in Substrate governance.](https://wiki.polkadot.network/docs/maintain-guides-democracy) | -| Propose and Pass in Governance | See the Polkadot Governance Docs for [how to participate in Substrate governance.](https://wiki.polkadot.network/docs/maintain-guides-democracy) | -| Tweet an ETH address or ENS domain | Tag [@webbprotocol](https://twitter.com/webbprotocol) in a high quality tweet about the network. | -| Bug Bounty with PR Fix Submission | See our Docs on Contributing a Bug Bounty, and provide a fix for the bug via Github. | -| Run a validator | See our Docs on running a Validator Node | -| Scripts to make Transactions | Engineer and publish transaction scripts for the network | -| Bug Report | See the @Bug Reporting Guidance | +| Task | Instructions | +| ---------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | +| Creative Contribution | - | +| Use Case Concepts | User Submission. Write an article discussing a use case for the technologies Tangle uses! | +| Publish a video or tutorial on Tangle/Webb | Publish a high-quality video discussing the network or its privacy technologies. | +| Author a Protocol Extension | Create and submit an extension to the protocols used in Tangle. See our GitHub | +| Tweet about Webb | Tag [@webbprotocol](https://twitter.com/webbprotocol) in a high quality tweet about the network. | +| Deposit → Transfer → Withdraw | Perform a transaction flow on the network or the Hubble Bridge. | +| Tweet a hash of your address + a secret number | Make sure to tag @Webbprotocol. | +| Vote in Governance | See the Polkadot Governance Docs for [how to participate in Substrate governance.](https://wiki.polkadot.network/docs/maintain-guides-democracy) | +| Propose and Pass in Governance | See the Polkadot Governance Docs for [how to participate in Substrate governance.](https://wiki.polkadot.network/docs/maintain-guides-democracy) | +| Tweet an ETH address or ENS domain | Tag [@webbprotocol](https://twitter.com/webbprotocol) in a high quality tweet about the network. | +| Bug Bounty with PR Fix Submission | See our Docs on Contributing a Bug Bounty, and provide a fix for the bug via Github. | +| Run a validator | See our Docs on running a Validator Node | +| Scripts to make Transactions | Engineer and publish transaction scripts for the network | +| Bug Report | See the @Bug Reporting Guidance | Stay updated by following our [Blog](https://blog.webb.tools /) and joining our [Community](https://webb.tools/community). diff --git a/pages/docs/node/docker-node.mdx b/pages/docs/node/docker-node.mdx index 3b074020..94521653 100644 --- a/pages/docs/node/docker-node.mdx +++ b/pages/docs/node/docker-node.mdx @@ -9,7 +9,7 @@ import { Tabs } from 'nextra/components'; # Deploying a Tangle Network Node with Docker A Tangle Network node can be spun up quickly using Docker. **This guide covers both Full Node and Validator Node deployment.** . For more information on installing Docker, -please visit the official Docker [docs](https://docs.docker.com/get-docker/). Make sure that your system meets the requirements which can read [here](docs/node/hardware/). +please visit the official Docker [docs](https://docs.docker.com/get-docker). Make sure that your system meets the requirements which can read [here](https://docs.tangle.tools/docs/node/hardware/). ## Setup the Docker Environment @@ -65,7 +65,7 @@ docker run --rm -it -v /var/lib/tangle/:/data ghcr.io/webb-tools/tangle/tangle:m ``` - For an overview of the above flags, please refer to the [CLI Usage](/docs/ecosystem-roles/validator/api-reference/cli/) page of our documentation. + For an overview of the above flags, please refer to the [Substrate node-template CLI Tool](https://docs.substrate.io/reference/command-line-tools/node-template). Once Docker pulls the necessary images, your Tangle node will start, displaying lots of information, @@ -80,7 +80,7 @@ relay chain, which might take a few days. ### Generate and store keys: -We need to generate the required keys for our node. For more information on these keys, please see the [Required Keys](/docs/ecosystem-roles/validator/required-keys) section. +We need to generate the required keys for our node. For more information on these keys, please see the [Required Keys](https://docs.tangle.tools/docs/node/validator/requirements/#2-generate-your-keys-and-import-them-to-the-keystore.mdx) section. The keys we need to generate include the following: - Role key (Ecdsa) @@ -176,7 +176,7 @@ ghcr.io/webb-tools/tangle/tangle:main \ ``` - For an overview of the above flags, please refer to the [CLI Usage](/docs/ecosystem-roles/validator/api-reference/cli/) page of our documentation. + For an overview of the above flags, please refer to the [Substrate node-template CLI Tool](https://docs.substrate.io/reference/command-line-tools/node-template). Once Docker pulls the necessary images, your Tangle node will start, displaying lots of information, @@ -246,7 +246,7 @@ The upgrade process is straightforward and is the same for a full node. sudo docker stop `CONTAINER_ID` ``` -2. Get the latest version of Tangle from the Tangle GitHub Release [page](https://github.com/webb-tools/tangle/pkgs/container/tangle%2Ftangle +2. Get the latest version of Tangle from the Tangle GitHub Release [page](https://github.com/webb-tools/tangle/pkgs/container/tangle%2Ftangle) 3. Pull the latest version of Tangle binary by doing `docker pull ghcr.io/webb-tools/tangle/tangle:{VERSION_CODE}`. Example, if the latest version of Tangle is v0.1.2, then the command would be `docker pull ghcr.io/webb-tools/tangle/tangle:v0.1.12` @@ -288,7 +288,7 @@ If you'd like to run the node with verbose logs, you may add the following argum ## Begin Validating -Now that your node is setup, [continue onto our Validator guides to understand token bonding and more.](./validator/requirements.mdx) +Now that your node is setup, [continue onto our Validator guides to understand token bonding and more.](https://docs.tangle.tools/docs/node/validator/requirements) ## Support and Questions diff --git a/pages/docs/node/monitoring/alert-manager.mdx b/pages/docs/node/monitoring/alert-manager.mdx index 26032b2f..f745486b 100644 --- a/pages/docs/node/monitoring/alert-manager.mdx +++ b/pages/docs/node/monitoring/alert-manager.mdx @@ -9,7 +9,7 @@ import Callout from "../../../../components/Callout"; # Alert Manager Setup The following is a guide outlining the steps to setup AlertManager to send alerts when a Tangle node or DKG is being disrupted. If you do not have Tangle node setup yet, please -review the **Tangle Node Quickstart** setup guide [here](/docs/node/quickstart/). +review the **Tangle Node Quickstart** setup guide [here](../quickstart.mdx). In this guide we will configure the following modules to send alerts from a running Tangle node. @@ -20,11 +20,11 @@ In this guide we will configure the following modules to send alerts from a runn The Alertmanager handles alerts sent by client applications such as the Prometheus server. It takes care of deduplicating, grouping, and routing them to the correct receiver integration such as email, PagerDuty, or OpsGenie. It also takes care of silencing and inhibition of alerts. To learn more about Alertmanager, please -visit the official docs site [here](https://prometheus.io/docs/alerting/latest/alertmanager/). +visit the official docs site [here](https://prometheus.io/docs/alerting/latest/alertmanager). ### Getting Started -Let's first start by downloading the latest releases of the above mentioned modules (Alertmanager). +Start by downloading the latest releases of the [AlertManager](https://prometheus.io/docs/alerting/latest/alertmanager). This guide assumes the user has root access to the machine running the Tangle node, and following the below steps inside that machine. As well as, @@ -57,7 +57,7 @@ Let's first start by downloading the latest releases of the above mentioned modu wget https://github.com/prometheus/alertmanager/releases/download/v0.24.0/alertmanager-0.24.0.linux-arm64.tar.gz && ``` - For other linux distrubutions please visit official release page [here](https://github.com/prometheus/prometheus/releases). + For other linux distrubutions visit the [Prometheus releases](https://github.com/prometheus/prometheus/releases). @@ -133,7 +133,7 @@ Great! You have now installed and setup your environment. The next series of ste ## Configuration -If you are interested to see how we configure the Tangle Network nodes for monitoring check out https://github.com/webb-tools/tangle/tree/main/monitoring. +For implementation examples, [refer to our GitHub.](https://github.com/webb-tools/tangle/tree/main/monitoring). ### Prometheus @@ -147,7 +147,7 @@ sudo nano /etc/prometheus/rules.yml ``` We are going to create 2 basic rules that will trigger an alert in case the instance is down or the CPU usage crosses 80%. -You can create all kinds of rules that can triggered, for an exhausted list of rules see our rules list [here](https://github.com/webb-tools/tangle/blob/main/monitoring/prometheus/rules.yml). +You can create all kinds of rules that can triggered, [refer to our full list.](https://github.com/webb-tools/tangle/blob/main/monitoring/prometheus/rules.yml). Add the following lines and save the file: @@ -192,8 +192,8 @@ promtool check config /etc/prometheus/prometheus.yml We can use a Gmail address to send the alert emails. For that, we will need to generate an app password from our Gmail account. -Note: we recommend you here to use a dedicated email address for your alerts. Review Google's own guide for -proper set up [here](https://support.google.com/mail/answer/185833?hl=en). +Note: we recommend you here to use a dedicated email address for your alerts. [Review Google's own guide for +proper set-up](https://support.google.com/mail/answer/185833?hl=en). ### Slack notifications diff --git a/pages/docs/node/monitoring/grafana.mdx b/pages/docs/node/monitoring/grafana.mdx index 11d9a187..3b9878f0 100644 --- a/pages/docs/node/monitoring/grafana.mdx +++ b/pages/docs/node/monitoring/grafana.mdx @@ -9,7 +9,7 @@ import Callout from "../../../../components/Callout"; # Grafana Setup The following is a guide outlining the steps to setup Grafana Dashboard to visualize metric data for a Tangle node. If you do not have Tangle node setup yet, please -review the **Tangle Node Quickstart** setup guide [here](/docs/node/quickstart/). +review the **Tangle Node Quickstart** setup guide [here](../quickstart.mdx). In this guide we will configure the following modules to visualize metric data from a running Tangle node. diff --git a/pages/docs/node/monitoring/loki.mdx b/pages/docs/node/monitoring/loki.mdx index 722660e8..4c3a8a53 100644 --- a/pages/docs/node/monitoring/loki.mdx +++ b/pages/docs/node/monitoring/loki.mdx @@ -9,12 +9,12 @@ import Callout from "../../../../components/Callout"; # Loki Log Management The following is a guide outlining the steps to setup Loki for log management of a Tangle node. If you do not have Tangle node setup yet, please -review the **Tangle Node Quickstart** setup guide [here](/docs/node/quickstart/). +review the **Tangle Node Quickstart** setup guide [here](https://docs.tangle.tools/docs/node/quickstart//). In this guide we will configure the following modules to scrape metrics from the running Tangle node. -- **Loki** provides log aggregation system and metrics. -- **Promtail** is the agent responsible for gathering logs, and sending them to Loki. +- **Loki** provides log aggregation system and metrics. [Download](https://grafana.com/docs/loki/latest/setup/install/) +- **Promtail** is the agent responsible for gathering logs, and sending them to Loki.[Download](https://grafana.com/docs/loki/latest/send-data/promtail/installation/) Let's first start by downloading the latest releases of the above mentioned modules (Loki, Promtail download pages). @@ -48,7 +48,7 @@ Let's first start by downloading the latest releases of the above mentioned modu curl -O -L "https://github.com/grafana/loki/releases/download/v2.7.0/loki-linux-arm64.zip" ``` - For other linux distrubutions please visit official release page [here](https://github.com/grafana/loki/releases). + For other linux distrubutions, [visit the official Loki release page](https://github.com/grafana/loki/releases). @@ -148,12 +148,12 @@ The next series of steps will be configuring each service. ## Configuration -If you are interested to see how we configure the Tangle Network nodes for monitoring check out https://github.com/webb-tools/tangle/tree/main/monitoring. +For configuration examples, see [Monitoring](https://github.com/webb-tools/tangle/tree/main/monitoring). ### Loki Loki's configuration details what ports to listen to, how to store the logs, and other configuration options. -There are many other config options for Loki, and you can read more about Loki configuration at: https://grafana.com/docs/loki/latest/configuration/ +There are many other config options for Loki, [read more.](https://grafana.com/docs/loki/latest/configuration/) Let’s create the file: @@ -216,7 +216,7 @@ table_manager: The Promtail configuration details what logs to send to Loki. In the below configuration we are indicating to send the logs to Loki from the `/var/log/dkg` directory. This directory can be changed based on what logs you -want to pick up. There are many other config options for Promtail, and you can read more about Promtail configuration at: https://grafana.com/docs/loki/latest/clients/promtail/configuration/ +want to pick up. There are many other config options for Promtail, refer to the [Promtail documentation](https://grafana.com/docs/loki/latest/clients/promtail/configuration/) Let’s create the file: diff --git a/pages/docs/node/monitoring/prometheus.mdx b/pages/docs/node/monitoring/prometheus.mdx index e2b5d652..15d5e58f 100644 --- a/pages/docs/node/monitoring/prometheus.mdx +++ b/pages/docs/node/monitoring/prometheus.mdx @@ -9,7 +9,7 @@ import Callout from "../../../../components/Callout"; # Prometheus Setup The following is a guide outlining the steps to setup Prometheus to monitor a Tangle node. If you do not have Tangle node setup yet, please -review the **Tangle Node Quickstart** setup guide [here](/docs/node/quickstart/). It is important to note that +review the **Tangle Node Quickstart** setup guide [here](https://docs.tangle.tools/docs/node/monitoring/quickstart/). It is important to note that this guide's purpose is to help you get started with monitoring your Tangle node, not to advise on how to setup a node securely. Please take additional security and privacy measures into consideration. diff --git a/pages/docs/node/monitoring/quickstart.mdx b/pages/docs/node/monitoring/quickstart.mdx index eed71663..92f94078 100644 --- a/pages/docs/node/monitoring/quickstart.mdx +++ b/pages/docs/node/monitoring/quickstart.mdx @@ -9,7 +9,7 @@ import Callout from "../../../../components/Callout"; # Monitoring Tangle Node The following is a guide outlining the steps to setup monitoring for an Tangle node. If you do not have Tangle node setup yet, please -review the **How to run an Tangle node** setup guide [here](https://docs.webb.tools/v1/node-operators/run-tangle-node). It is important to note that +review the **How to run an Tangle node** setup guide [here](https://docs.tangle.tools/docs/node/quickstart/). It is important to note that this guide's purpose is to help you get started with monitoring your Tangle node, not to advise on how to setup a node securely. Please take additional security and privacy measures into consideration. @@ -33,7 +33,7 @@ Here is how our final configuration will look like at the end of this guide. The quickest way to setup monitoring for your node is to use our provided `docker-compose` file. The docker image starts all the above monitoring tools with the exception of `Node exporter`. `node-exporter` is ommitted since some metrics are not available when running inside a docker container. -Follow the instructions [here](/prometheus) to start the prometheus node exporter. +Follow the instructions [here](https://docs.tangle.tools/docs/node/monitoring/prometheus/) to start the prometheus node exporter. ### Prerequisites diff --git a/pages/docs/node/quicknode.mdx b/pages/docs/node/quicknode.mdx index 352a75fc..73454b5b 100644 --- a/pages/docs/node/quicknode.mdx +++ b/pages/docs/node/quicknode.mdx @@ -10,7 +10,7 @@ config, this guide uses automated keys and it is not recommended to run a valida for a more secure long term setup. Before following this guide you should have already set up your machines environment, installed the dependencies, and -compiled the Tangle binary. If you have not done so, please refer to the [Requirements](/docs/node/hardware/) page. +compiled the Tangle binary. If you have not done so, please refer to the [Requirements](https://docs.tangle.tools/docs/node/hardware/) page. ## Standalone Testnet @@ -85,6 +85,7 @@ If the node is running correctly, you should see an output similar to below: make sure to note down and keep this safely, in case you need to migrate or restart your node, these keys are essential. Congratulations! You have officially setup an Tangle Network node. The quickstart is only meant as a quickstart for anyone looking to run a tangle node with minimal -config, this guide uses automated keys and it is not recommended to run a validator using this setup long term, refer to [advanced](/docs/node/systemd/) guide -for a more secure long term setup.. If you are interested -in learning how to setup monitoring for your node, please refer to the [monitoring](../monitoring/quickstart.mdx) page. +config, this guide uses automated keys and it is not recommended to run a validator using this setup long term, refer to [Deploy with Systemd](https://docs.tangle.tools/docs/node/systemd/) guide +for a more secure long term setup. + +To setup monitoring for your node, please refer to the [monitoring](https://docs.tangle.tools/docs/node/monitoring/quickstart/) page. diff --git a/pages/docs/node/quickstart.mdx b/pages/docs/node/quickstart.mdx index 9e439431..a9df762b 100644 --- a/pages/docs/node/quickstart.mdx +++ b/pages/docs/node/quickstart.mdx @@ -14,7 +14,7 @@ is a collection of quick links for quick setups! ## Validators -Please see our new **[Start Validating guide.](/docs/node/validator/requirements)** +Please see our new **[Start Validating guide.](https://docs.tangle.tools/docs/node/validator/requirements/)** ## Advanced Setup diff --git a/pages/docs/node/systemd.mdx b/pages/docs/node/systemd.mdx index 692ce613..4203cd7b 100644 --- a/pages/docs/node/systemd.mdx +++ b/pages/docs/node/systemd.mdx @@ -9,7 +9,7 @@ import { Tabs } from 'nextra/components' You can run your **full** or **validator** node as a systemd process so that it will automatically restart on server reboots or crashes, helping to avoid getting slashed. This guide now includes additional steps for setting up dependencies and Rust configuration, ensuring a smoother setup process. -Before following this guide, ensure that your machine's environment is set up and the Tangle binary is compiled. If you haven't done so, please refer to the [Requirements](docs/node/hardware/) page. +Before following this guide, ensure that your machine's environment is set up and the Tangle binary is compiled. If you haven't done so, please refer to the [Requirements](https://docs.tangle.tools/docs/node/hardware/) page. ## Setup @@ -325,12 +325,12 @@ 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/node/validator/requirements) to start validating. + at [Start Validating](https://docs.tangle.tools/docs/node/validator/requirements/) to start validating. The following is the service configuration file, use this while completing the Full Node guide. - **Note:** To run with evm trace, you should use a binary built with `txpool` flag, refer [requirements](/docs/node/hardware/) page for more details. + **Note:** To run with evm trace, you should use a binary built with `txpool` flag, refer to [Binaries](https://docs.tangle.tools/docs/node/node-software/#binaries) page for more details. ```sh filename="full.service" copy sudo tee /etc/systemd/system/full.service > /dev/null << EOF @@ -364,11 +364,11 @@ Congratulations! You have officially setup a Tangle Network node using Systemd. ## Monitoring -To setup monitoring for your node, please refer to the [monitoring](./monitoring/quickstart.mdx) page. +To setup monitoring for your node, please refer to the [monitoring](https://docs.tangle.tools/docs/node/monitoring/quickstart/) page. ## Begin Validating -Now that your node is setup, [continue onto our Validator guides to understand token bonding and more.](./validator/requirements.mdx) +Now that your node is setup, [continue onto our Validator guides to understand token bonding and more.](https://docs.tangle.tools/docs/node/validator/requirements/) ## Support and Questions diff --git a/pages/docs/node/validator/requirements.mdx b/pages/docs/node/validator/requirements.mdx index 1edbf283..1b6418b6 100644 --- a/pages/docs/node/validator/requirements.mdx +++ b/pages/docs/node/validator/requirements.mdx @@ -55,10 +55,10 @@ Controller accounts are deprecated in Substrate. For more information, [see this It is now time to set up our validator. We will do the following: 1. Bond the TNT of the Stash account on the Tangle Network. These TNT will be put at stake for the security of the network and can be slashed. -2. Select the [staking proxy account](./proxyaccount) account. This is the account that will decide when to start or stop validating. +2. Select the [staking proxy account](./proxyaccount.mdx) account. This is the account that will decide when to start or stop validating. -See how to setup a [proxy account](./proxyaccount) +See how to setup a [proxy account](./proxyaccount.mdx) First, go to the Staking section. Click on "Account Actions", and then the "+ Stash" button. @@ -69,11 +69,11 @@ Make sure not to bond all your TNT balance since you will be unable to pay trans **Stash account** - Select your Stash account. In this example, we will bond 1 DOT, where the minimum bonding amount is 1. Make sure that your Stash account contains at least this much. You can, of course, stake more than this. -**Staking proxy account** - Select the staking [proxy account](./proxyaccount) created earlier. This account will also need a small amount of DOT in order to start and stop validating. +**Staking proxy account** - Select the staking [proxy account](./proxyaccount.mdx) created earlier. This account will also need a small amount of DOT in order to start and stop validating. **Value bonded** - How much DOT from the Stash account you want to bond/stake. Note that you do not need to bond all of the DOT in that account. Also note that you can always bond more DOT later. However, withdrawing any bonded amount requires the duration of the unbonding period. On Kusama, the unbonding period is 7 days. On Polkadot, the planned unbonding period is 28 days. -**Payment destination** - The account where the rewards from validating are sent. More info here. Payouts can go to any custom address. If you'd like to redirect payments to an account that is neither the staking [proxy account](./proxyaccount) nor the stash account, set one up. Note that it is extremely unsafe to set an exchange address as the recipient of the staking rewards. +**Payment destination** - The account where the rewards from validating are sent. More info here. Payouts can go to any custom address. If you'd like to redirect payments to an account that is neither the staking [proxy account](./proxyaccount.mdx) nor the stash account, set one up. Note that it is extremely unsafe to set an exchange address as the recipient of the staking rewards. Once everything is filled in properly, click `Bond` and sign the transaction with your Stash account. @@ -91,7 +91,7 @@ In order to participate in the tangle protocol, block production, and block fina - Grandpa key (Ed25519) - ImOnline key (Sr25519) -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. +See the guides for [launching Tangle Network with Docker](../docker-node.mdx) and [Launching with Systemd](../systemd.mdx) for exact guides on this step. Once your node and keys are setup and your node is synced, proceed to the following: diff --git a/pages/docs/node/validator/validator-rewards.mdx b/pages/docs/node/validator/validator-rewards.mdx index e022cc74..3b3e4cb2 100644 --- a/pages/docs/node/validator/validator-rewards.mdx +++ b/pages/docs/node/validator/validator-rewards.mdx @@ -5,7 +5,7 @@ description: A brief overview of Tangle Network rewards and their payout scheme. # Validator Rewards -Running a [validator](validation.mdx) node on the Tangle Network allows you to connect to the network, sync with a bootnode, obtain local access to RPC endpoints, and also author blocks. The network rewards successful validators (users running validator nodes and actively producing blocks) by paying a set amount of network tokens as rewards. +Running a [validator](requirements.mdx) node on the Tangle Network allows you to connect to the network, sync with a bootnode, obtain local access to RPC endpoints, and also author blocks. The network rewards successful validators (users running validator nodes and actively producing blocks) by paying a set amount of network tokens as rewards. ## How Rewards are Calculated