Skip to content

Latest commit

 

History

History
59 lines (33 loc) · 2.44 KB

README.md

File metadata and controls

59 lines (33 loc) · 2.44 KB
Raw

RuntimeMgr

This document outlines the purpose of this module, its components and how they all interact with the other modules.

Contents

Overview

The RuntimeMgr's purpose is to abstract the runtime so that it's easier to test and reason about various configuration scenarios.

It works like a black-box that takes the current environment/machine and therefore the configuration files, flags supplied to the binary, etc. and returns a structure that can be queried for settings that are relevant for the functioning of the modules and the system as a whole.

Components

This module includes the following components:

  • Config As the name says, it includes, in the form of properties, module-specific configurations.

    It also has a Base configuration that is supposed to contain more cross-functional settings that cannot really find a place in module-specific "subconfigs" (as another way to define module-specific configurations).

    Configuration can be supplied via JSON file but also via environment variables (12 factor app).

    The naming convention is as follows:

    POCKET_[module][configuration key]

    So, for example, if you want to override the default RPC port we would use:

    POCKET_RPC_PORT=yourport

    The config.json file is resolved by the ParseConfig function in the configs package. It takes an optional cfgFile parameter. If a file path is provided, it will attempt to read the configuration from the file at the specified path. If no file path is provided, it will search for the configuration file in the following locations:

    • /etc/pocket/
    • $HOME/.pocket
    • The working directory

    The file should be named config with a .json extension.

    If no config.json file is found or provided, the application will use default configuration values.

  • Genesis

    The genesis represents the initial state of the blockchain.

    This allows the binary to start with a specific initial state.

  • Clock

    Clock is a drop-in replacement for some of the features offered by the time package, it acts as an injectable clock implementation used to provide time manipulation while testing.

    By default, the real clock is used and while testing it's possible to override it by using the "option" WithClock(...)