A portable development level Indy Node network, including a Ledger Browser. The Ledger Browser (for example the BC Gov's Ledger for the dFlow Demo Application) allows a user to see the status of the nodes of a network and browse/search/filter the Ledger Transactions.
von-network is being developed as part of the Verifiable Organizations Network (VON). For more information on VON see https://vonx.io. Even, better - join in with what we are doing and contribute to VON and the Indy community.
The VON-Network Ledger Browser and API
With the Ledger Browser (for example: http://dflow.bcovrin.vonx.io/), you can see:
- The status of the Ledger nodes
- The detailed status of the Ledger Nodes in JSON format (click the "Detailed Status" link)
- The three ledger's of an Indy Network - Domain, Pool and Config (click the respective links)
- The Genesis Transactions for the Indy Network instance.
- In an Indy Agent, use the URL
<server>/genesisto GET the genesis file to use in initializing the Agent.
- In an Indy Agent, use the URL
By using the "Authenticate a new DID" part of the UI or posting the appropriate JSON to the VON-Network API (see an example script here), a new DID can be added to the Ledger. A known and published Trust Anchor DID is used to write the new DID to the Ledger. This operation would not be permitted in this way on the Sovrin Main Network. However, it is a useful mechanism on sandbox Indy Networks used for testing.
Domain Ledger screen (example), you can browse through all of the transactions that have been created on this instance of the Ledger. As well, you can use a drop down filter to see only specific Ledger transaction types (
nym - aka DID,
CredDef, etc.), and search for strings in the content of the transactions.
VON Quick Start Guide
The VON Quick Start Guide provides the instructions for running a local instance of the VON applications, including an Indy Network, an instance of TheOrgBook and [dFlow](https://github.com/bcgov/dFlow. This is a great way to see the VON Network in action.
Running the Network Locally
First, install Docker. Download the installer for your operating system here. Once it is installed, keep the Docker daemon running in the background.
Linux users will also need to install docker-compose. Mac and Windows users will have this already.
Once Docker has been installed, open a terminal session, change directories to where you store repos, and clone the von-network repository:
git clone <repository url> von-network
- Move to the new directory:
- Build the docker images that will be used to run the Indy network containers (this process will take several minutes):
./manage script has a number of commands. Run it without arguments to see the set of options.
- Once the build process completes, you can test the build to make sure everything works properly:
Monitor the logs for error messages as the nodes start up.
- Verify the network is running
In a browser, go to http://localhost:9000. You should see the VON Indy Ledger Browser and the status of the four nodes of the Indy Network. All should show a lovely, complete blue circle. If not - check the logs in the terminal.
- Stopping the Network
To stop the scrolling logs and get to a command prompt, hit Ctrl-C. To stop and remove the network persistence (the Ledger), run:
If necessary, you can use
stop instead of
down to stop the containers but retain the persistence.
Running the the web server in Docker against another ledger
- Run docker to start the ledger, and pass in GENESIS_URL and LEDGER_SEED parameters:
For example to connect to the STN:
./manage start-web GENESIS_URL=https://raw.githubusercontent.com/sovrin-foundation/sovrin/master/sovrin/pool_transactions_sandbox_genesis LEDGER_SEED=000000000000000000000IanCostanzo
Running the the web server on your local machine
You can run the web server/ledger browser on its own, and point to another Indy/Sovrin network.
Install python and pip (recommend to use a virtual environment such as virtualenv)
Download this repository:
git clone https://github.com/bcgov/von-network.git cd von-network
- If using virtualenv, setup a virtual environment and activate it:
virtualenv --python=python3.6 venv source venv/bin/activate
- Install requirements:
pip install -r server/requirements.txt
- Run the server, you can specify a genesis file, or a url from which to download a genesis file - you can also specify a seed for the DID to use to connect to this ledger:
GENESIS_FILE=/tmp/some-genesis.txt PORT=9000 python -m server.server
GENESIS_URL=https://some.domain.com/some-genesis.txt LEDGER_SEED=000000000000000000000000SomeSeed PORT=9000 python -m server.server
For example to connect to the STN:
GENESIS_URL=https://raw.githubusercontent.com/sovrin-foundation/sovrin/master/sovrin/pool_transactions_sandbox_genesis LEDGER_SEED=000000000000000000000IanCostanzo PORT=9000 python -m server.server
Running the Network on a VPS
- ubuntu 16.04
- at least 1GB RAM
- accepting incoming TCP connections on ports 9701-9708
- root access
- Install unzip utility:
# Requires root privileges apt install unzip
- Install Docker and Docker Compose:
curl -fsSL get.docker.com -o get-docker.sh
# Requires root privileges sh get-docker.sh
curl -L https://github.com/docker/compose/releases/download/1.17.1/docker-compose-`uname -s`-`uname -m` -o /usr/local/bin/docker-compose
chmod +x /usr/local/bin/docker-compose
- Download this repository:
curl -L https://github.com/bcgov/von-network/archive/master.zip > bcovrin.zip && \ unzip bcovrin.zip && \ cd von-network-master && \ chmod a+w ./server/
- Map service port to 80 in docker-compose.yml
ports: - 9000:8000
ports: - 80:8000
- Build the Docker container:
- Run the network of nodes:
# This command requires the publicly accesible ip address of the machine `public_ip_address` ./manage start public_ip_address &
Connecting to the Network
With the CLI
Once the nodes are all running and have connected to each other, you can run the Indy client to test the connection in a separate terminal window:
If you want to connect to a remote indy-node pool, you can optionally supply an ip address. (Currently only supports a test network running on a single machine with a single ip address.)
./manage cli <ip address>
The Indy CLI should boot up and you should see the following:
Indy-CLI (c) 2017 Evernym, Inc. Type 'help' for more information. Running Indy 1.1.159 indy>
Now connect to our new Indy network to make sure network is running correctly:
pool connect sandbox
What you should see is:
indy> pool connect sandbox Pool "sandbox" has been connected
If you see this, congratulations! Your nodes are running correctly and you have a connection to the network.
Extra Features for Development
Running BCovrin also runs a thin webserver (at http://localhost:9000 when using docker) to expose some convenience functions:
Genesis Transaction Exposed
The genesis transaction record required to connect to the node pool is made available at:
Write new did for seed
The node pool can have a trust anchor write a did for you. That feature is available in the UI.
Customize your Ledger Browser Deployment
It is possible to customize some of the aspects of the Ledger Browser at run-time, by using the following environment variables:
REGISTER_NEW_DIDS: if set to
True, it will enable the user interface allowing new identity owners to write a DID to the ledger. It defaults to
LEDGER_INSTANCE_NAME: the name of the ledger instance the Ledger Brwoser is connected to. Defaults to
INFO_SITE_URL: a URL that will be displayed in the header, and can be used to reference anotheran external website containing details/resources on the current ledger browser instance.
INFO_SITE_TEXT: the display text used for the
INFO_SITE_URL. If not specified, it will default to the value set for
LEDGER_CACHE_PATH: if set, it will instruct the ledger to create an on-disk cache, rather than in-memory. The image supplies a folder for this purpose;
$HOME/.indy_client/ledger-cache. The file should be placed into this directory (e.g.: