Skip to main content

Key Manager Node

info

These instructions are for setting up a key manager node. Key manager nodes run a special runtime that provides confidentiality to other ParaTimes. If you want to run a validator node instead, see the instructions for running a validator node. Similarly, if you want to run a ParaTime node instead, see the instructions for running a ParaTime node.

tip

At time of writing the key manager ParaTime is deployed only on the Testnet to support Cipher and Sapphire ParaTimes, and limited to be run by trustworthy partners.

This guide will cover setting up your key manager node for the Oasis Network. This guide assumes some basic knowledge on the use of command line tools.

Prerequisites​

Before following this guide, make sure you've followed the Prerequisites and Run a Non-validator Node sections and have:

  • Oasis Node binary installed on your system and a dedicated non-root user that will run your Oasis Node.
  • The chosen top-level /node/ working directory prepared (feel free to name it as you wish, e.g. /srv/oasis/) with:
    • etc: This will store the node configuration and genesis file.
    • data: This will store the data directory needed by Oasis Node, including your node identity and the blockchain state. The directory permissions should be rwx------.
    • bin: This will store binaries needed by Oasis Node for running the ParaTimes.
    • runtimes: This will store the ParaTime bundles.
  • Downloaded or compiled the correct versions of everything according to Network Parameters page (Mainnet, Testnet).
    • The genesis file copied to /node/etc/genesis.json.
    • The binaries needed by Oasis Node for running the ParaTimes copied to /node/bin/.
    • The key manager ParaTime bundle (.orc extension) copied to /node/runtimes/.
  • Initialized a new node and updated your entity registration by following the Register a New Entity or Update Your Entity Registration instructions.
    • The entity descriptor file copied to /node/etc/entity.json.
tip

Reading the rest of the validator node setup instructions and ParaTime node setup instructions may also be useful.

Setting up Trusted Execution Environment (TEE)​

The key manager ParaTime requires the use of a TEE. See the Set up trusted execution environment doc for instructions on how to set it up before proceeding.

Configuration​

In order to configure the node create the /node/etc/config.yml file with the following content:

datadir: /node/data

log:
  level:
    default: info
    tendermint: info
    tendermint/context: error
  format: JSON

genesis:
  file: /node/etc/genesis.json

consensus:
  tendermint:
    core:
      listen_address: tcp://0.0.0.0:26656

      # The external IP that is used when registering this node to the network.
      # NOTE: If you are using the Sentry node setup, this option should be
      # omitted.
      external_address: tcp://{{ external_address }}:26656

    p2p:
      # List of seed nodes to connect to.
      # NOTE: You can add additional seed nodes to this list if you want.
      seed:
        - "{{ seed_node_address }}"

runtime:
  mode: keymanager
  paths:
    # Path to the key manager ParaTime bundle.
    - "{{ keymanager_runtime_orc_path }}"

  # The following section is required for ParaTimes which are running inside the
  # Intel SGX Trusted Execution Environment.
  sgx:
    loader: /node/bin/oasis-core-runtime-loader

worker:
  registration:
    # In order for the node to register itself, the entity ID must be set.
    entity_id: {{ entity_id }}

  keymanager:
    runtime:
      id: "{{ keymanager_runtime_id }}"

  p2p:
    # External P2P configuration.
    port: 20104
    addresses:
      # The external IP that is used when registering this node to the network.
      - "{{ external_address }}:20104"

# The following section is required for ParaTimes which are running inside the
# Intel SGX Trusted Execution Environment.
ias:
  proxy:
    address:
      # List of IAS proxies to connect to.
      # NOTE: You can add additional IAS proxies to this list if you want.
      - "{{ ias_proxy_address }}"

Before using this configuration you should collect the following information to replace the {{ ... }} variables present in the configuration file:

  • {{ external_address }}: The external IP you used when registering this node.
  • {{ seed_node_address }}: The seed node address in the form ID@IP:port.
    • You can find the current Oasis Seed Node address in the Network Parameters page (Mainnet, Testnet).
  • {{ keymanager_runtime_orc_path }}: Path to the key manager ParaTime bundle of the form /node/runtimes/foo-paratime.orc.
    • You can find the current Oasis-supported key manager ParaTime in the Network Parameters page (Mainnet, Testnet).
  • {{ entity_id }}: The node's entity ID from the entity.json file.
  • {{ keymanager_runtime_id }}: Runtime identified for the key manager ParaTime.
    • You can find the current Oasis-supported key manager ParaTime identifiers in the Network Parameters page (Mainnet, Testnet).
  • {{ ias_proxy_address }}: The IAS proxy address in the form ID@HOST:port.
caution

Make sure the consensus port (default: 26656) and p2p.port (default: 9200) are exposed and publicly accessible on the internet (for TCP and UDP traffic).

Starting the Oasis Node​

You can start the node by running the following command:

oasis-node --config /node/etc/config.yml

Checking Node Status​

To ensure that your node is properly connected with the network, you can run the following command after the node has started:

oasis-node control status -a unix:/node/data/internal.sock