Skip to content

README.adoc

Latest commit

 

History

History
94 lines (76 loc) · 3.7 KB

README.adoc

File metadata and controls

94 lines (76 loc) · 3.7 KB

The Interbit Configuration File

The interbit configuration file contains instructions for the build script. It details how to read and bundle your covenants and deploy them to a network. The build script will consume a configuration and file and resolve the variables inside of it to generate a manifest file used to deploy your network.

The configuration file is a Javascript file, typically called interbit.config.js, and contains:

  • configuration of each blockchain in the network,

  • network information for peer nodes,

  • public keys for each blockchain’s validator nodes,

  • run-time configuration for each Interbit application’s browser nodes,

  • the list of covenants to apply to blockchains in the network.

It contains network information such as peers, validator public keys, the different chains your network may run. It also contains a list of covenants and which blockchains they run on.

Note

The configuration file is one that you manage; you can update it at any time. It is used to generate an Interbit manifest file, which should never be manually edited.

Example

Your interbit.config.js file would look something like this:

{% include "config.js" %}
Important

The public and private keys used by your Interbit nodes and applications are used for identification, authentication, and authorization. They should be maintained securely, just as you should do with passwords and other sensitive information. The keys should never be committed to version control.

The example configuration achieves this goal by using environment variables, for example: process.env.PUBKEY_3. See the Simple Platform Example for a technique that automates setting up the environment variables without including them in version control.

Top-level properties

peers Array Optional

The list of peer nodes in your network that this node should connect to. Only regular nodes should be specified; do not specify browser nodes.

Each peer must specify a host and a port in the format host:port.
adminValidators Array Required

The list of validator nodes for the root blockchain that administers your network. Each entry in the list is the public key of the respective validator. The first validator in the list is the block master for the root blockchain.
staticChains Object Required

Defines all of the blockchains that should be created and deployed at the genesis of the blockchain network, and should persist for the lifespan of the network (unless explicitly removed by an administrator). Dynamic chains, by contrast, are created, updated, or destroyed by other blockchains or applications.

Each key within staticChains is a chain alias, a string representing a simple name for the blockchain. Each value is a staticChain configuration object.
covenants Object Required

Defines all of the covenants which should be deployed on this node. Each key within covenants is a covenant alias, a string representing a simple name for the covenant. Each value is a covenant configuration object.
apps Object Optional

Defines the applications that should load blockchains from this configuration into browser nodes, and which peer nodes they should connect to. Each key is an app alias, a string representing a simple name for the application. Each value is an app configuration object.