Skip to content

Latest commit

 

History

History
80 lines (56 loc) · 2.77 KB

README.md

File metadata and controls

80 lines (56 loc) · 2.77 KB

Poktroll LocalNet

Background

Poktroll comes with a LocalNet that can be used for development and testing on a local machine. As a rollup, it requires an underlying Data Availability layer, which is provisioned by the locally running celestia node.

Table of Contents

Run Poktroll locally

Report issues

If you encounter a problem using this guide, please create a new GitHub Issue.

TL;DR

  1. Install dependencies:
    1. Ignite
    2. Docker
    3. Kind
    4. Helm
    5. Tilt (note: we recommend using Kind cluster with Tilt)
  2. Run make localnet_up to start the network
  3. When prompted, click space to see the web UI with logs and current status of the network. Alternatively, you can go directly to localhost:10350

Develop on the LocalNet

Once LocalNet is started, a new file localnet_config.yaml is generated in the root directory of the repository. This file contains the configuration of the network. It looks like this:

helm_chart_local_repo:
  enabled: false
  path: ../helm-charts
relayers:
  count: 1

Scaling network actors

To scale the number of actors, edit the localnet_config.yaml file and change the count of the relayers.

For example:

helm_chart_local_repo:
  enabled: false
  path: ../helm-charts
relayers:
-   count: 1
+   count: 2

NOTE: You may need to up to 1 minute for the new actors to be registered and deployed locally.

Modify Kubernetes workloads

If you need to modify Kubernetes resources, follow these steps:

  1. Clone the helm-charts repository.
  2. In localnet_config.yaml, set helm_chart_local_repo.enabled to true and path to the relative path of the cloned repository.

The following is an example that has not been tested yet:

cd ~/src/pocket
git clone [email protected]:pokt-network/helm-charts.git

cd ~/src/pocket/poktroll
sed -i.bak "s/helm_chart_local_repo\.enabled: false.*/helm_chart_local_repo.enabled: true/" localnet_config.yaml
sed -i.bak "s#path: .*#path: ../helm-charts#" localnet_config.yaml