Skip to content

Commit

Permalink
Update TestNet documentation (pokt-network#1570)
Browse files Browse the repository at this point in the history 
## Description

<!-- reviewpad:summarize:start -->
### Summary generated by Reviewpad on 06 Jul 23 22:00 UTC
This pull request updates the "testnet.md" file in the "doc/guides" directory. The diff includes changes to the table of contents, validator lists, example queries, credentials, querying net info and status, testnet seeds, Pocket TestNet metrics dashboard, and helper examples. The diff also updates the information about who is supporting Pocket's TestNet infrastructure.
<!-- reviewpad:summarize:end -->
  • Loading branch information
@Olshansk
Olshansk authored Jul 6, 2023
1 parent 92529d7 commit 0263af8
Showing 1 changed file with 120 additions and 28 deletions.
148 changes: 120 additions & 28 deletions doc/guides/testnet.md
View file
Original file line number Diff line number Diff line change
@@ -1,8 +1,26 @@
# Pocket TestNet information overview
# Pocket TestNet <!-- omit in toc -->

## Table of Contents <!-- omit in toc -->

- [Validator List w/ Pocket RPC](#validator-list-w-pocket-rpc)
- [Example Queries](#example-queries)
- [Querying State](#querying-state)
- [Querying Binary Version](#querying-binary-version)
- [Validators w/ Tendermint RPC](#validators-w-tendermint-rpc)
- [Credentials](#credentials)
- [Querying Net Info](#querying-net-info)
- [Querying Status](#querying-status)
- [TestNet Seeds](#testnet-seeds)
- [Pocket TestNet metrics dashboard](#pocket-testnet-metrics-dashboard)
- [Brought to you by NodeFleet](#brought-to-you-by-nodefleet)
- [Helper Examples](#helper-examples)
- [View All Validator Tendermint Versions](#view-all-validator-tendermint-versions)
- [View all Validator Binary Versions](#view-all-validator-binary-versions)
- [View All Validator Heights](#view-all-validator-heights)

## Validator List w/ Pocket RPC

## Pocket Testnet validators list with pocket RPC

```
```bash
https://node1.testnet.pokt.network/
https://node2.testnet.pokt.network/
https://node3.testnet.pokt.network/
Expand All @@ -11,23 +29,45 @@ https://node5.testnet.pokt.network/
https://node6.testnet.pokt.network/
```

Also, other queries can be done querying RPC nodes. Here an example for downloading TestNet's state backup as a local file through terminal:
### Example Queries

#### Querying State

```bash
curl -X POST https://node1.testnet.pokt.network/v1/query/state > query_state.json
curl -X POST https://node1.testnet.pokt.network/v1/query/state | tee query_state.json | jq
```

Or checking version of the pocket binary on the testnet validators
Output:

```bash
curl https://node1.testnet.pokt.network/v1
# {
# "app_hash": "",
# "app_state": {
# "application": {
# "applications": [
# {
# "address": "065013157ffb401642d0418b408474b361ee0836",
# "chains": [
# "004A",
# "004B",
# ...
```

## Pocket Testnet validators list with Tendermint RPC
#### Querying Binary Version

```bash
curl https://node1.testnet.pokt.network/v1
```

This info can be checked querying these links (Note that corresponding credentials are needed to accessing this info):
Output:

```bash
#"BETA-0.10.2"%
```

## Validators w/ Tendermint RPC

```bash
https://node1.tendermint.testnet.pokt.network/
https://node2.tendermint.testnet.pokt.network/
https://node3.tendermint.testnet.pokt.network/
Expand All @@ -36,50 +76,102 @@ https://node5.tendermint.testnet.pokt.network/
https://node6.tendermint.testnet.pokt.network/
```

Ask for the TestNet credentials in Pocket's Node-Chat Discord channel [here](https://discord.com/channels/553741558869131266/564836328202567725)
### Credentials

These endpoints require authentication and can be accessed at `https://testnet:${NODE_FLEET_PASSWORD}@$node`

You can request TestNet credentials in the [Pocket Node-Chat Discord channel](https://discord.com/channels/553741558869131266/564836328202567725).

For example, accessing tendermint's endpoints for network information:
### Querying Net Info

```bash
curl https://node1.tendermint.testnet.pokt.network/net_info
```

Verifying status of testnet node1 via tendermint:
### Querying Status

```bash
curl https://node1.tendermint.testnet.pokt.network/status
```

## Pocket TestNet Seeds
## TestNet Seeds

If you want to sync with testnet, you only need to copy/paste the list of nodes below on the `config.json` file on the variable `Seeds`
The following seeds can be used to sync with TestNet. Copy-paste the following list of seeds into the `config.json` file on the `seeds` variable:

```
```bash
d90094952a3a67a99243cca645cdd5bd55fe8d27@seed1.testnet.pokt.network:26668, 2a5258dcdbaa5ca6fd882451f5a725587427a793@seed2.testnet.pokt.network:26669, a37baa84a53f2aab1243986c1cd4eff1591e50d0@seed3.testnet.pokt.network:26668, fb18401cf435bd24a2e8bf75ea7041afcf122acf@seed4.testnet.pokt.network:26669
```

## Pocket TestNet metrics dashboard

TestNet metrics can be check following these links:
TestNet metrics can be viewed at the following links:

- [Loadbalancer metrics](https://monitoring.nodefleet.net/d/O23g2BeWk/testnet-loadbalancer-metrics?orgId=4&var-service=testnet1@file&var-entrypoint=All&from=now-3h&to=now&refresh=5m): Network traffic dashboard
- [Tendermint metrics](https://monitoring.nodefleet.net/d/UJyurCTWz/testnet-validators-tendermint-metrics): Consensus, Blocks, Transactions dashboard information and so on
- [Node exporter metrics](https://monitoring.nodefleet.net/d/Gm5yJc94z/testnet-validators-telegraf-metrics): Instance metrics
- [Loki dashboard](https://monitoring.nodefleet.net/d/_j0yAcrVz/testnet-validators-loki): Testnet Logs and explorer search

**Testnet Loadbalancer metrics (Network traffic dashboard)**
You can request TestNet credentials in the [Pocket Node-Chat Discord channel](https://discord.com/channels/553741558869131266/564836328202567725).

> https://monitoring.nodefleet.net/d/O23g2BeWk/testnet-loadbalancer-metrics?orgId=4&var-service=testnet1@file&var-entrypoint=All&from=now-3h&to=now&refresh=5m
### Brought to you by NodeFleet

**Tendermint metrics (Consensus, Blocks, Transactions dashboard information and so on)**
The support for Testnet infrastructure is given by[nodefleet.org](https://nodefleet.org/), a Web3 blockchain and node running company focused on delivering value for investors &builders on multi-chain ecosystem. Nodefleet provides top quality engineering and quality infrastructure around all of its products.

> https://monitoring.nodefleet.net/d/UJyurCTWz/testnet-validators-tendermint-metrics
Reach out to the team about TestNet directly on [Discord](https://discord.com/channels/553741558869131266/564836328202567725) tagging **Lowell | nodefleet.org#7301** (148983981134577665) and **Steven94 | nodefleet.org** (357688204566069248).

**Node exporter metrics (Instance metrics)**
## Helper Examples

> https://monitoring.nodefleet.net/d/Gm5yJc94z/testnet-validators-telegraf-metrics
### View All Validator Tendermint Versions

**Loki dashboard (Testnet Logs and explorer search)**
```bash
#!/bin/bash
declare -a nodes=("node1.tendermint.testnet.pokt.network/status"
"node2.tendermint.testnet.pokt.network/status"
"node3.tendermint.testnet.pokt.network/status"
"node4.tendermint.testnet.pokt.network/status"
"node5.tendermint.testnet.pokt.network/status"
"node6.tendermint.testnet.pokt.network/status")

for node in "${nodes[@]}"
do
url="https://testnet:${NODE_FLEET_PASSWORD}@$node"
curl -s $url | jq '.result.node_info.version'
done
```

> https://monitoring.nodefleet.net/d/_j0yAcrVz/testnet-validators-loki
### View all Validator Binary Versions

Note corresponding credentials will be needed to accessing this info. Ask for credentials in Pocket's Node-Chat Discord channel [here](https://discord.com/channels/553741558869131266/564836328202567725)
```bash
#!/bin/bash
declare -a nodes=("node1.testnet.pokt.network/v1"
"node2.testnet.pokt.network/v1"
"node3.testnet.pokt.network/v1"
"node4.testnet.pokt.network/v1"
"node5.testnet.pokt.network/v1"
"node6.testnet.pokt.network/v1")

for node in "${nodes[@]}"
do
url="https://$node"
curl -X GET $url
echo ""
done
```

### Who's supporting Pocket's TestNet infrastructure?
### View All Validator Heights

The support for Testnet infrastructure is given by Nodefleet.org, which is a Web3 blockchain and node running company focused on delivering value for investors/builders on multi-chain ecosystems providing top quality engineering and quality infrastructure around all of its products. Feel free and ask anything about TestNet [here](https://discord.com/channels/553741558869131266/564836328202567725) tagging **Lowell | nodefleet.org** and **Steven94 | nodefleet.org**
```bash
#!/bin/bash
declare -a nodes=("node1.testnet.pokt.network/v1/query/height"
"node2.testnet.pokt.network/v1/query/height"
"node3.testnet.pokt.network/v1/query/height"
"node4.testnet.pokt.network/v1/query/height"
"node5.testnet.pokt.network/v1/query/height"
"node6.testnet.pokt.network/v1/query/height")

for node in "${nodes[@]}"
do
url="https://$node"
curl -X POST $url
done
```

0 comments on commit 0263af8

Please sign in to comment.