Skip to content

Commit

Permalink
Testnet docs updated (#1569)
Browse files Browse the repository at this point in the history
[Issue Document v0 TestNet #1563](#1563) done

Co-authored-by: Daniel Olshansky <olshansky.daniel@gmail.com>
  • Loading branch information
StevenMartinez94 and Olshansk authored Jul 6, 2023
1 parent 6ea15d7 commit 92529d7
Show file tree
Hide file tree
Showing 2 changed files with 92 additions and 2 deletions.
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
# Pocket Core

Official golang implementation of the Pocket Network Protocol.

<div>
<a href="https://godoc.org/github.com/pokt-network/pocket-core"><img src="https://img.shields.io/badge/godoc-reference-blue.svg"/></a>
<a href="https://goreportcard.com/report/github.com/pokt-network/pocket-core"><img src="https://goreportcard.com/badge/github.com/pokt-network/pocket-core"/></a>
Expand Down Expand Up @@ -37,7 +38,7 @@ Clone the repository, `cd` into it and run `go build app/cmd/pocket_core/main.go

To run the Pocket Core binary you can use the following flags alongside the `main` executable:

````
```
Usage:
pocket [command]
Expand All @@ -64,7 +65,7 @@ Flags:
--seeds string a comma separated list of PeerURLs: '<ID>@<IP>:<PORT>,<ID2>@<IP2>:<PORT>...<IDn>@<IPn>:<PORT>'
Use "pocket [command] --help" for more information about a command.
````
```

For more detailed command information, see the [usage section](doc/specs/cli/).

Expand All @@ -76,6 +77,10 @@ For more detailed command information, see the [usage section](doc/specs/cli/).

Snapshots are provided by [Liquify LTD](https://www.liquify.io/) details on how to access the snapshots can be found in [snapshot.md](doc/guides/snapshot.md)

## Accessing TestNet

TestNet information can be found at [testnet.md](doc/guide/testnet.md)

## Running the tests

To run the Pocket Core unit tests, `go test -short -v -p 1 ./...`
Expand Down
85 changes: 85 additions & 0 deletions doc/guides/testnet.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
# Pocket TestNet information overview

## Pocket Testnet validators list with pocket RPC

```
https://node1.testnet.pokt.network/
https://node2.testnet.pokt.network/
https://node3.testnet.pokt.network/
https://node4.testnet.pokt.network/
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:

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

Or checking version of the pocket binary on the testnet validators

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

## Pocket Testnet validators list with Tendermint RPC

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

```
https://node1.tendermint.testnet.pokt.network/
https://node2.tendermint.testnet.pokt.network/
https://node3.tendermint.testnet.pokt.network/
https://node4.tendermint.testnet.pokt.network/
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)

For example, accessing tendermint's endpoints for network information:

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

Verifying status of testnet node1 via tendermint:

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

## Pocket 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`

```
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 Loadbalancer metrics (Network traffic dashboard)**

> 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
**Tendermint metrics (Consensus, Blocks, Transactions dashboard information and so on)**

> https://monitoring.nodefleet.net/d/UJyurCTWz/testnet-validators-tendermint-metrics
**Node exporter metrics (Instance metrics)**

> https://monitoring.nodefleet.net/d/Gm5yJc94z/testnet-validators-telegraf-metrics
**Loki dashboard (Testnet Logs and explorer search)**

> https://monitoring.nodefleet.net/d/_j0yAcrVz/testnet-validators-loki
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)

### Who's supporting Pocket's TestNet infrastructure?

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**

0 comments on commit 92529d7

Please sign in to comment.