Holochain Backdrop

A Javascript library for automating the setup of a Holochain development environment.

Overview

Repeatedly configuring and running instances of holochain for development can have its complexities. The primary purpose of this module is to help establish a backdrop for testing your DNAs or UI development. It provides reliable controls for

• starting/stopping the Lair/Holochain processes
• installing Apps for one or more agents

Note: this module does not include lair-keystore and holochain binaries. They are expected to be in your environment. see nix shell configs

Holochain Version Map

For information on which versions of this package work for each Holochain release, see docs/Holochain_Version_Map.md

Features

• No configuration use-case that uses temporary directories/files
• A CLI tool that provides some of the basic options
• Reliable start/stop and subprocess management
• App installation for setting up test scenarios

Install

npm i @spartan-hc/holochain-backdrop

Basic Usage

const { Holochain } = require('@spartan-hc/holochain-backdrop');

let holochain = new Holochain();

holochain.on("lair:stdout", line => {
    console.log( "     Lair STDOUT:", line );
});

holochain.on("lair:stderr", line => {
    console.log( "     Lair STDERR:", line );
});

holochain.on("conductor:stdout", line => {
    console.log( "Conductor STDOUT:", line );
});

holochain.on("conductor:stderr", line => {
    console.log( "Conductor STDERR:", line );
});

await holochain.setup();
await holochain.start();

// ... do stuff

await holochain.stop();
await holochain.destroy();

Basic CLI Usage

[shell:~]$ npx holochain-backdrop

API Reference

See docs/API.md

CLI Reference

See docs/CLI.md

Contributing

See CONTRIBUTING.md