Skip to content

Commit

Permalink
Duplicate validator folder out of roles and into Tangle Network (#150)
Browse files Browse the repository at this point in the history
  • Loading branch information
thomivy authored Oct 6, 2023
1 parent 50fb58c commit 3a32414
Show file tree
Hide file tree
Showing 30 changed files with 3,482 additions and 10 deletions.
2 changes: 1 addition & 1 deletion 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/ecosystem-roles/validator/quickstart/"
href="/docs/tangle-network/validator/quickstart/"
></DetailedFeatureLink>
<DetailedFeatureLink
feature={{
Expand Down
Binary file added images/reward_curve_chart
Binary file not shown.
2 changes: 1 addition & 1 deletion pages/docs/_meta.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
"index": {
"title": "Quickstart"
},
"tangle-network": "Tangle Network",
"overview": "About Webb",
"concepts": "Concepts",
"tangle-network": "Tangle Network",
"projects": "Projects",
"protocols": "Protocols",
"ecosystem-roles": "Ecosystem Roles",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ The relayer has 3 endpoints available to query from. They are outlined below for

**Expected Response:**

```json filename="respose"
```json filename="respose"
{
"ip": "127.0.0.1"
}
Expand All @@ -29,7 +29,7 @@ The relayer has 3 endpoints available to query from. They are outlined below for

**Expected Response:**

```json filename="respose"
```json filename="respose"
{
"evm": {
"rinkeby": {
Expand Down Expand Up @@ -82,7 +82,7 @@ The relayer has 3 endpoints available to query from. They are outlined below for

**Expected Response:**

```json filename="respose"
```json filename="respose"
{
"leaves": ["0x2e5c62af48845c095bfa9b90b8ec9f6b7bd98fb3ac2dd3039050a64b919951dd", "0x0f89f0ef52120b8db99f5bdbbdd4019b5ea4bcfef14b0c19d261268da8afdc24", "0x3007c62f678a503e568534487bc5b0bc651f37bbe1f34668b4c8a360f15ba3c3"],
"lastQueriedBlock": "0x9f30a8"
Expand All @@ -97,7 +97,7 @@ The relayer has 3 endpoints available to query from. They are outlined below for

**Expected Response:**

```json filename="respose"
```json filename="respose"
{
"metrics": "# HELP bridge_watcher_back_off_metric specifies how many times the bridge watcher backed off\n# TYPE bridge_watcher_back_off_metric counter\nbridge_watcher_back_off_metric 0\n# HELP gas_spent_metric The total number of gas spent\n# TYPE gas_spent_metric counter\ngas_spent_metric 0\n# HELP handle_proposal_execution_metric How many times did the function handle_proposal get executed\n# TYPE handle_proposal_execution_metric counter\nhandle_proposal_execution_metric 0\n# HELP proposal_queue_attempt_metric How many times a proposal is attempted to be queued\n# TYPE proposal_queue_attempt_metric counter\nproposal_queue_attempt_metric 0\n# HELP total_active_relayer_metric The total number of active relayers\n# TYPE total_active_relayer_metric counter\ntotal_active_relayer_metric 0\n# HELP total_fee_earned_metric The total number of fees earned\n# TYPE total_fee_earned_metric counter\ntotal_fee_earned_metric 0\n# HELP total_number_of_data_stored_metric The Total number of data stored\n# TYPE total_number_of_data_stored_metric counter\ntotal_number_of_data_stored_metric 1572864\n# HELP total_number_of_proposals_metric The total number of proposals proposed\n# TYPE total_number_of_proposals_metric counter\ntotal_number_of_proposals_metric 0\n# HELP total_transaction_made_metric The total number of transaction made\n# TYPE total_transaction_made_metric counter\ntotal_transaction_made_metric 0\n# HELP transaction_queue_back_off_metric How many times the transaction queue backed off\n# TYPE transaction_queue_back_off_metric counter\ntransaction_queue_back_off_metric 0\n"
}
Expand Down
5 changes: 2 additions & 3 deletions pages/docs/ecosystem-roles/validator/systemd/quick-node.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@ for a more secure long term setup.</mark>
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/ecosystem-roles/validator/requirements/) page.


## Standalone Testnet

### 1. Fetch the tangle binary
Expand Down Expand Up @@ -82,10 +81,10 @@ If the node is running correctly, you should see an output similar to below:
2023-03-22 14:55:53 discovered: 12D3KooWNHhcCUsZTdTkADmDJbSK9YjbtscHHA8R4jvrbGwjPVez /ip4/192.168.88.12/tcp/30305
```

**Note** : Since the `--auto-insert-keys` flag was used the logs will print out the keys automatically generated for you,
**Note** : Since the `--auto-insert-keys` flag was used the logs will print out the keys automatically generated for you,
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/ecosystem-roles/validator/systemd/validator-node/) guide
config, this guide uses automated keys and it is not recommended to run a validator using this setup long term, refer to [advanced](/docs/ecosystem-roles/validator/systemd/validator-node/) 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.
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ or crashes (and helps to avoid getting slashed!).
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/ecosystem-roles/validator/requirements/) page.

## Standalone Testnet
## Standalone Testnet

### Generate and store keys

Expand Down
1 change: 1 addition & 0 deletions pages/docs/tangle-network/_meta.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
"json-rpc-endpoints": "JSON-RPC Endpoints",
"understanding-dkg-tangle": "Distributed Key Generation",
"governance": "Onchain Governance",
"validator": "Validate",
"incentives": "Incentives",
"community": "Team and Community"
}
12 changes: 12 additions & 0 deletions pages/docs/tangle-network/validator/_meta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
{
"quickstart": "Quickstart",
"validation": "Validator Overview",
"validator-rewards": "Validator Rewards",
"required-keys": "Required Keys",
"requirements": "Hardware Requirements",
"deploy-with-docker": "Deploying with Docker",
"systemd": "Running with Systemd",
"monitoring": "Node Monitoring",
"api-reference": "API Reference",
"troubleshooting": "Troubleshooting"
}
3 changes: 3 additions & 0 deletions pages/docs/tangle-network/validator/api-reference/_meta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"cli": "CLI Options"
}
Loading

0 comments on commit 3a32414

Please sign in to comment.