Indexers configuration reference

Before you deploy indexers, you need a basic understanding of the following:

• Kubernetes
• Helm
• Helm chart configuration, especially values.yaml

In addition, you need one or more suitable distributed ledger network nodes on the blockchain ledger.

To deploy an indexer, you need to create and update a values.yaml file.

Use this empty template to help you get started:

ledgers:
  bitcoin:
    regtest-1:
      enabled: false
      nodeEndpoint:
      url:
      user:
      password:
      fallbackFeeRate:
    testnet:
      enabled: false
      nodeEndpoint:
      url:
      user:
      password:
      fallbackFeeRate:
    mainnet:
      enabled: false
      nodeEndpoint:
      url:
      user:
      password:
      fallbackFeeRate:

Each network appears as a separate object under the ledger name object, for example regtest-1 in the template example. Enable or disable the deployment of an indexer for each network by modifying its enabled field.

Each network has its own configuration structure, but we can group them into the following families.

• bitcoin
  • regtest-1
  • testnet
  • mainnet
• litecoin
  • regtest-1
  • testnet
  • mainnet
• dogecoin
  • regtest-1
  • testnet
  • mainnet
• dash
  • regtest-1
  • testnet
  • mainnet

The following example shows a values.yaml file for deploying a Bitcoin indexer for the mainnet:

harmonize:
  ledgers:
      bitcoin:
        mainnet:
          enabled: true
          nodeEndpoint: NODEURL:PORT
          url: https://NODEUR?auth=TOKEN
          user: <user>
          password: <password>
          fallbackFeeRate: 100

In the example, you need to replace <user> and <password> with your actual username and password for the indexer.

• ethereum
  • geth-dev
  • testnet-holesky
  • testnet-sepolia
  • parity-dev
  • mainnet
  • pow-mainnet
• polygon
  • testnet-amoy
  • mainnet
• avalanche-c-chain
  • testnet-fuji
  • mainnet
• bsc
  • testnet
  • mainnet
• xrpl
  • regtest-1
  • devnet
  • testnet
  • mainnet
• tezos
  • sandbox
  • testnet
  • mainnet

The following example shows a values.yaml file for deploying an Ethereum indexer for the testnet:

harmonize:
  ledgers:
    ethereum:
      testnet-holesky:
        enabled: true
        uri: 'https://test-holesky-node.bdnodes.net?auth=uamvQornmOiUr0Dg7nbf48jjnPt'

• substrate
  • dev
  • polkadot
  • kusama
  • westend

The following example shows a values.yaml file for deploying a Polkadot indexer for the mainnet:

harmonize:
  ledgers:
    substrate:
      polkadot:
        enabled: true
        ws: ws://my-web-socket-server.com
        sidecar: mySuperSecretPassphrase

• stellar
  • devnet
  • mainnet
• solana
  • devnet
  • mainnet

The following example shows a values.yaml file for deploying a Solana indexer for the mainnet:

harmonize:
  ledgers:
    solana:
      mainnet:
        enabled: true
        url: 'https://test-solana-node.bdnodes.net?auth=uamvQornmOiUr0Dg7nbf48jjnPt'
        passphrase: mySuperSecretPassphrase

• cardano
  • preprod
  • preview
  • testnet
  • mainnet

The following example shows a values.yaml file for deploying a Cardano indexer for the mainnet:

harmonize:
  ledgers:
    cardano:
      mainnet:
        enabled: true
        http: 'https://test-cardano-node.bdnodes.net?auth=uamvQornmOiUr0Dg7nbf48jjnPt'
        ws: ws://my-web-socket-server.com

• hedera
  • testnet
  • mainnet
• algorand
  • testnet
  • mainnet

The following example shows a values.yaml file for deploying a Hedera indexer for the mainnet:

harmonize:
  ledgers:
    hedera:
      mainnet:
        enabled: true
        http: 'https://test-hedera-node.bdnodes.net?auth=uamvQornmOiUr0Dg7nbf48jjnPt'

To deploy your indexer, run the following Helm command:

helm install <my-release-name> <helm-chart-repository> -f my-custom-values.yaml

Where <my-release-name> is the name of your Helm release, <helm-chart-repository> is the chart you want to install, and my-custom-values.yaml is the file you completed with your configuration.

• Telemetry configuration