Skip to content

build.adoc

Latest commit

 

History

History
83 lines (62 loc) · 2.79 KB

build.adoc

File metadata and controls

83 lines (62 loc) · 2.79 KB

build

An Interbit CLI command that prepares a deployable, fully-resolved, Interbit manifest from an Interbit configuration file.

Syntax

interbit build [--config configFilePath] \
               [--manifest manifestFilePath] \
               [--artifacts outputDir]

Options

--config String Optional Default=./interbit.config.js

The path to an Interbit configuration file.

When not provided, the command looks for the file interbit.config.js in the current directory. If no configuration file is found, an error is displayed. The configuration file must be a valid Interbit configuration file, or an error is displayed.
--artifacts String Optional Default=./dist

The path where the build artifacts should be stored.

The path is created if it does not already exist. If the path cannot be created, an error is displayed.

When not provided, the command outputs artifacts to the dist directory, in the current directory.
--manifest Filepath Optional Default=./interbit.manifest.js

The path to an Interbit manifest file.

When not provided, the command looks for the file interbit.manifest.js in the same directory specified by the --artifacts option, and then in the current directory. If no manifest file is found, one is generated from the configuration provided. The manifest file must be a valid Interbit manifest file, or an error is displayed.

Important

If you wish to maintain consistent blockchain IDs, you should provide a previously-generated manifest file. This is important if you are deploying updates to the covenant or configuration.

Discussion

Fully-resolved means that:

  • All aliases are resolved to their blockchain IDs; the manifest uses the blockchain IDs instead of the alias names used in the configuration file.

  • All covenants have been packed into hashed binaries, with recorded covenants hashes and file locations.

This command:

  • generates a manifest file based on the provided configuration,

  • packs all covenants described in the configuration and outputs them to dist/covenants,

  • updates the index.html files described in configuration with the chain IDs that were resolved in the manifest. This allows browser nodes to connect to the associated blockchain networks.

Coming soon:

  • Build your front end applications by executing the build steps provided.

  • Update only the index.html file from the completed application build.