Skip to content

Latest commit

 

History

History
201 lines (143 loc) · 7.26 KB

README.md

File metadata and controls

201 lines (143 loc) · 7.26 KB
Raw

@kyvejs/tendermint

Content

Introduction

This runtime validates and archives blocks from any tendermint based blockchain application. It only stores blocks from and to a given height and makes them available to directly download them from the storage provider, or directly sync them into the blockchain nodes itself, therefore enabling block sync via validated KYVE blocks.

Use cases

Since storage pools which use this runtime archive validated and historical blocks blockchain nodes can use those archived blocks to bootstrap themselves and sync to the current network height. This may make expensive archival nodes obsolete since those blocks are already permanently and immutably archived. Additionally, block data can be retrieved over an ELT pipeline, further analyzing and using it for different applications like block explorers.

Required Setup

This runtime requires the node operator to run a tendermint node which is used as the source and the KYVE protocol node. Depending on which tendermint chain gets archived the minimum hardware requirements are at least the min requirements of that tendermint node.

Integrations currently live

The following integrations are running on this runtime and are currently live.

Mainnet

(planned - currently in test)

Testnet

(planned - currently in test)

Devnet

  • Osmosis

    • Pool ID: 30
    • Chain ID: osmosis-1
    • Base Height: 1

  • Archway

    • Pool ID: 31
    • Chain ID: archway-1
    • Base Height: 1

Binary Installation

This section explains how to install a protocol node with this runtime. This is only relevant for protocol node operators who want to run a node in a pool which has this runtime.

Build from source

The first option to install the binary is to build it from source. For that you have to execute the following commands:

git clone [email protected]:KYVENetwork/kyvejs.git
cd kyvejs

If you want to build a specific version you can checkout the tag and continue from the version branch. If you want to build the latest version you can skip this step.

git checkout tags/@kyvejs/[email protected] -b x.x.x

After you have cloned the project and have the desired version the dependencies can be installed and the project build:

yarn install
yarn setup

Finally, you can build the runtime binaries.

INFO: During the binary build log warnings can occur. You can safely ignore them.

cd integrations/tendermint
yarn build:binaries

You can verify the installation with printing the version:

./out/kyve-linux-64 version

After the build succeeded you can find the binaries in the out folder where you can move them to use desired location (like KYSOR).

Download prebuilt binary

You can find all prebuilt binaries in the releases of the kyvejs repository. For this specific runtime they can be found here.

You can verify the installation with printing the version:

./kyve-linux-64 version

Once you have downloaded the binary for the correct platform and version you can simply unzip them and move them to your desired location (like KYSOR).

Run a node

This section explains which runtime specific setup you must have in order to run a node. This is only relevant for protocol node operators who have already installed the binary (previous section) and want to run a node in a pool which has this runtime.

Depending on the integration which are currently live the following setup has to be done.

Evmos

Requirements

Creating a pool with the runtime

This section explains how you can create a storage pool on KYVE with this specific runtime. This is only relevant for users or projects, who are interested in archiving and validating a new data source.

Config

This runtime requires the following config format in order to run:

{
  "network": "CHAIN_ID_OF_INTEGRATION",
  "rpc": "https://rpc-endpoint-of-integration:26657"
}

Here the properties have the following reason:

  • network: the chain ID of the network. This is a check to verify that only blocks from this network are validated and archived. The runtime rejects blocks that do not match with this ID
  • rpc: the default rpc endpoint of the network to collect blocks from. This should only be a base URL without a trailing slash. This can be a public rpc endpoint from a dedicated provider or an URL pointing to localhost in order to signal that every protocol node has to host their own blockchain node

This config should then be stringified on the pool and should look like this:

{
  "config": "{\"network\":\"CHAIN_ID_OF_INTEGRATION\",\"rpc\":\"https://rpc-endpoint-of-integration:26657\"}"
}

With this setup the runtime is able to run. Furthermore an optional environment variable can be set to override the default rpc endpoint (rpc).

export KYVEJS_TENDERMINT_RPC="https://my-custom-rpc-endpoint:26657"

Create Pool governance proposal

In order to create a pool it has to go through the Governance process (more on that can be found here). An example proposal with which a storage pool with this runtime could be created can be found below:

{
  messages: [
    {
      '@type': '/kyve.pool.v1beta1.MsgCreatePool',
      authority: 'kyve10d07y265gmmuvt4z0w9aw880jnsr700jdv7nah',
      name: '<your pool name>',
      runtime: '@kyvejs/tendermint',
      logo: 'ar://<your logo stored on arweave>',
      config: '<your config like described above>',
      start_key: '<the initial height of the tendermint chain>',
      upload_interval: '120', // 120s is the recommended value
      operating_cost: '<your base bundle reward>', // for example 1000000 if the base reward per bundle should be 1 $KYVE
      min_delegation: '<your required min delegation', // for example 1000000000 if the pool should only run if more than 1000 $KYVE are bonded in this pool
      max_bundle_size: '100', // 100 blocks per bundle is the recommended value
      version: '<runtime version>', // the current version of this runtime
      binaries: '{"kyve-linux-arm64":"<linux-arm64 binary download URL>","kyve-linux-x64":"<linux-x64 binary download URL>","kyve-macos-x64":"<macos-x64 binary download URL>"}', // download URLs of binaries for KYSOR
      storageProviderId: '1', // Arweave is the recommended storage provider
      compressionId: '1', // Gzip is the recommended bundle compression
    },
  ],
  metadata: '<your ipfs metadata info>', // gov proposal metadata
  deposit: '<your deposit>ukyve', // proposal deposit, check the required min deposit
}

Once your proposal is ready you can submit it to the network. Please follow the official governance process to increase the chances of getting your proposal accepted.