README

Holochain Playground

This is an experimental ongoing effort to build a holochain playground simulation. It's trying to follow as accurately as possible the internal mechanisms of holochain, displaying the DHT and enabling detailed inspection.

This package is distributed as an NPM package component library, in the form of a collection of web-components build with the Custom Elements API.

Library Usage

Install the package with npm i holochain-playground .
Import the holochain-playground-container in your application like this:

import "holochain-playground/elements/holochain-playground-container";

Declare the <holochain-playground-container></holochain-playground-container> element:

<body>
    <holochain-playground-container id="playground"></holochain-playground-container>
</body>

This is the fundamental element for the playground to work, as it provides the state for all other elements you declare inside it.

Import any elements you want from the library, and declare them inside the holochain-playground-container :

import 'holochain-playground/elements/holochain-playground-dht-graph'

<body>
    <holochain-playground-container id="playground">
        <holochain-playground-dht-graph></holochain-playground-dht-graph>
    </holochain-playground-container>
</body>

Optionally, set the conductor urls to the nodes you want to bind the playground to:

<body>
    <holochain-playground-container id="playground"></holochain-playground-container>

    <script>
        const playground = document.getElementById("playground");
        playground.initialPlayground = {
            conductorUrls: ["ws://localhost:33000"];
        };
    </script>
</body>

Elements Library

In the future, this will be shown with storybook.

Technical data display

holochain-playground-dht-graph
holochain-playground-dht-stats
holochain-playground-dht-shard
holochain-playground-entry-detail
holochain-playground-entry-graph
holochain-playground-source-chain

Utilities

holochain-playground-conductor-detail
holochain-playground-create-entries
holochain-playground-import-export
holochain-playground-connect-to-nodes
holochain-playground-select-dna