2_cheatsheet_pocket

All accounts

pocketd keys list --keyring-backend=test

Gateway only

pocketd keys show -a gateway --keyring-backend=test

Application only

pocketd keys show -a application --keyring-backend=test

2. PATH Protocol Configuration (.config.yaml)

2.1 Generate Shannon Config

Generate config at local/path/.config.yaml:

make config_shannon_populate

Environment variables

Override defaults if needed:

• POCKETD_HOME: Path to pocketd home (default $HOME/.pocketd)

• POCKETD_KEYRING_BACKEND: Keyring backend (default test)

2.2 Verify Shannon Configuration

Check config:

cat local/path/.config.yaml

Expected format:

shannon_config:
  full_node_config:
    rpc_url: https://shannon-grove-rpc.mainnet.poktroll.com
    grpc_config:
      host_port: shannon-grove-grpc.mainnet.poktroll.com:443
    lazy_mode: false
  gateway_config:
    gateway_mode: "centralized"
    gateway_address: pokt1... # Your gateway address
    gateway_private_key_hex: "0x..." # Your gateway private key
    owned_apps_private_keys_hex:
      - "0x..." # Your application private key

2.3 Verify onchain configuration matches

Verify service configuration for each application:

pocketd query application show-application \
     $(pocketd keys show -a application --keyring-backend=test) \
     --node=https://shannon-grove-rpc.mainnet.poktroll.com

3. PATH Envoy Configuration (.values.yaml)

More details about configs

You can learn more about various configurations at Auth Configs or Helm Docs. It covers auth, rate limiting, etc...

3.1 Copy the template config

Run the following command to create local/path/.values.yaml:

make configs_copy_values_yaml

And check the contents of local/path/.values.yaml:

cat local/path/.values.yaml

3.2 Update the services

Update this section with the services you want to support. For example:

guard:
  services:
    - serviceId: eth
    - serviceId: svc1
    - serviceId: sv2
    - serviceId: oasys

Make sure this reflects both of the following:

1

What your onchain application is configured to support

Ensure the services listed match the onchain application configuration.

2

What your gateway .config.yaml is configured for

Ensure your gateway .config.yaml lists the same services.

4. Run PATH Stack Locally

PATH LocalNet

Find more about feature available for local development of PATH.

4.1 Run & Monitor PATH

Run the following command and wait 1-2 minutes:

make path_up

Your terminal should display the following:

Visit the Tilt dashboard at http://localhost:10350/r/(all)/overview and make sure everything is 🟢.

4.2 Check configured services

curl http://localhost:3070/healthz | jq

4.3 Example Relays

See Example Relays.

5. Stop PATH

When you're finished testing:

make path_down