Skip to content

Commit

Permalink
update: add api provider disclaimer.
Browse files Browse the repository at this point in the history
  • Loading branch information
christopherbrumm committed Sep 4, 2023
1 parent 97a7498 commit ffe90ba
Show file tree
Hide file tree
Showing 4 changed files with 24 additions and 8 deletions.
6 changes: 3 additions & 3 deletions docs/protocol_devs/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,15 +30,15 @@ running on the chain level. The native currency of the KYVE chain is $KYVE. It s
Because the KYVE blockchain is a Cosmos app chain the custom KYVE logic needed for data validation and archival is directly implemented into the blockchain itself.

:::info
**NOTE**: The source code can be found here: [https://github.com/KYVENetwork/chain](https://github.com/KYVENetwork/chain)
The source code can be found here: [https://github.com/KYVENetwork/chain](https://github.com/KYVENetwork/chain)
:::

#### Chain Nodes

Since KYVE's blockchain is based on Tendermint it relies on a set of validators that are responsible for committing new blocks in the blockchain. These validators participate in the consensus protocol by broadcasting votes which contain cryptographic signatures signed by each validator's private key.

:::info
**NOTE**: You can find more information about consensus validators [here](/validators/chain_nodes/overview.md)
You can find more information about consensus validators [here](/validators/chain_nodes/overview.md)
:::

### Protocol Layer
Expand All @@ -51,5 +51,5 @@ logic which makes KYVE unique is implemented directly into the consensus validat
Protocol validators are the backbone of a KYVE data pool. A protocol validator always runs in a specific data pool which validates a specific source of data. They are responsible for collecting data from a data source, bundling and uploading them to a Web3 storage provider like Arweave and verifying it.

:::info
**NOTE**: You can find more information on protocol validators [here](/validators/protocol_nodes/overview.md)
You can find more information on protocol validators [here](/validators/protocol_nodes/overview.md)
:::
18 changes: 13 additions & 5 deletions docs/validators/protocol_nodes/pools/archway/run_archway_node.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ sidebar_position: 3

The Archway Full Node will act as the source for the KYVE protocol validator and is **required**. You can either run the Archway node on the same machine with the KYVE protocol together (recommended) or on a seperate machine.

Check failure on line 7 in docs/validators/protocol_nodes/pools/archway/run_archway_node.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/validators/protocol_nodes/pools/archway/run_archway_node.md#L7

[Vale.Spelling] Did you really mean 'seperate'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'seperate'?", "location": {"path": "docs/validators/protocol_nodes/pools/archway/run_archway_node.md", "range": {"start": {"line": 7, "column": 209}}}, "severity": "ERROR"}

:::danger
Due to very specific requirements, an additional validation layer, accessibility as well as to prevent slashes, it is strongly recommended to run an independent data source node. API providers should be avoided and have already led to critical problems in the past.
:::

## Install Archway full node

The Archway binary with the version `v1.0.0` has to be installed. There are two ways to install and run the binary:
Expand Down Expand Up @@ -40,7 +44,9 @@ To enable the start of the syncing process, a seed node needs to be added into
seeds = "[email protected]:26656"
```

**TIP**: You can also add persistent_peers from Polkachu to ensure that you will actually find peers where you can sync with the network: https://polkachu.com/live_peers/archway
:::info
You can also add persistent_peers from Polkachu to ensure that you will actually find peers where you can sync with the network: https://polkachu.com/live_peers/archway

Check failure on line 48 in docs/validators/protocol_nodes/pools/archway/run_archway_node.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/validators/protocol_nodes/pools/archway/run_archway_node.md#L48

[Vale.Spelling] Did you really mean 'persistent_peers'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'persistent_peers'?", "location": {"path": "docs/validators/protocol_nodes/pools/archway/run_archway_node.md", "range": {"start": {"line": 48, "column": 18}}}, "severity": "ERROR"}

Check failure on line 48 in docs/validators/protocol_nodes/pools/archway/run_archway_node.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/validators/protocol_nodes/pools/archway/run_archway_node.md#L48

[Vale.Spelling] Did you really mean 'Polkachu'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'Polkachu'?", "location": {"path": "docs/validators/protocol_nodes/pools/archway/run_archway_node.md", "range": {"start": {"line": 48, "column": 40}}}, "severity": "ERROR"}
:::

### Configuration
Due to the size of the `block_results` response, it is __required__ to set the following in your `~/.archway/config/config.toml`:
Expand Down Expand Up @@ -98,7 +104,7 @@ docker run --restart unless-stopped -p 0.0.0.0:26657:26657 kyve/archway --x-cris
```

:::info
**INFO**: To prevent data loss, it is recommended to use a Docker volume in the running container.
To prevent data loss, it is recommended to use a Docker volume in the running container.
:::

Example:
Expand All @@ -118,7 +124,7 @@ docker run -d --restart unless-stopped \
```

:::info
**INFO**: When creating the volume, you must ensure that the <path_to_empty_directory> folder is empty and writable by your docker service.
When creating the volume, you must ensure that the <path_to_empty_directory> folder is empty and writable by your docker service.
:::

## Verifying the completed node setup
Expand All @@ -134,5 +140,7 @@ curl http://localhost:26657/block?height=1000000
If it returns a valid block response you can continue with starting the actual KYVE protocol validator
and start participating in the validation and archival process.

**TIP**: to save storage space you can start pruning blocks manually after they have been archived
by the pool since after that they are not needed anymore.
:::info
To save storage space you can start pruning blocks manually after they have been archived
by the pool since after that they are not needed anymore.
:::
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@ This section will deal with the installation for the Gaia Full Node and the KYVE
Node will act as the source for the KYVE protocol validator and is **required**. You can either run the Gaia node on
a seperate machine or run it on the same machine with the KYVE protocol together.

Check failure on line 9 in docs/validators/protocol_nodes/pools/cosmos_hub/installation.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/validators/protocol_nodes/pools/cosmos_hub/installation.md#L9

[Vale.Spelling] Did you really mean 'seperate'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'seperate'?", "location": {"path": "docs/validators/protocol_nodes/pools/cosmos_hub/installation.md", "range": {"start": {"line": 9, "column": 3}}}, "severity": "ERROR"}

:::danger
Due to very specific requirements, an additional validation layer, accessibility as well as to prevent slashes, it is strongly recommended to run an independent data source node. API providers should be avoided and have already led to critical problems in the past.
:::

## Install Gaia full node

The gaia binary with the version `v4.2.1` has to be installed. You can follow the official installation instructions [here](https://hub.cosmos.network/main/getting-started/installation.html) or download the binary directly from [here](https://github.com/cosmos/gaia/releases/tag/v4.2.1).

Check failure on line 17 in docs/validators/protocol_nodes/pools/cosmos_hub/installation.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/validators/protocol_nodes/pools/cosmos_hub/installation.md#L17

[Vale.Spelling] Did you really mean 'gaia'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'gaia'?", "location": {"path": "docs/validators/protocol_nodes/pools/cosmos_hub/installation.md", "range": {"start": {"line": 17, "column": 5}}}, "severity": "ERROR"}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ sidebar_position: 3

The Osmosis Full Node will act as the source for the KYVE protocol validator and is **required**. You can either run the Osmosis node on the same machine with the KYVE protocol together (recommended) or on a seperate machine.

Check failure on line 7 in docs/validators/protocol_nodes/pools/osmosis/run_osmosis_node.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/validators/protocol_nodes/pools/osmosis/run_osmosis_node.md#L7

[Vale.Spelling] Did you really mean 'seperate'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'seperate'?", "location": {"path": "docs/validators/protocol_nodes/pools/osmosis/run_osmosis_node.md", "range": {"start": {"line": 7, "column": 209}}}, "severity": "ERROR"}

:::danger
Due to very specific requirements, an additional validation layer, accessibility as well as to prevent slashes, it is strongly recommended to run an independent data source node. API providers should be avoided and have already led to critical problems in the past.
:::

## Install Osmosis full node

The Osmosis binary with the version `v3.1.0` has to be installed. There are two ways to install and run the binary:
Expand Down

0 comments on commit ffe90ba

Please sign in to comment.