Divvy

Micro-equity platform built on Hyperledger Fabric

This is a proof-of-concept and NOT production ready

Getting started

There are a few things to cover, so allow yourself an hour to get up and running.

Install the prerequisites

You'll need these things installed to run the platform.

• Vagrant
• VirtualBox

You'll also need about 10gb of free space available.

Platform components

While things are downloading, here's a quick introduction to the various platform components.

Host

The host is responsible for running all services which make up the platform. It is a Vagrant virtual machine running Ubuntu 18.04 LTS with Docker installed. The following components run on the host as Docker containers.

Network

Hyperledger Fabric network, the core platform component.

It has three core containers:

• ca.divvy.com
• orderer.divvy.com
• cli.divvy.com

The network is initially empty, it has no organisations. Each organisation added to the network creates three more containers:

• ca.ORG_NAME.divvy.com
• peer.ORG_NAME.divvy.com
• cli.ORG_NAME.divvy.com

See the network docs for more info.

Chaincode

Chaincode is used by network peers to query and update ledger state.

See the chaincode docs for more info.

Application

Primary user interface (UI) for interacting with the network. Users can signup (create an organisation), join channels, and trade shares using the app.

See the application docs for more info.

API

The API component connects the client app to the network.

See the API docs for ore info.

Stand up the host

Once you have installed the prerequisites, clone the repo:

$ git clone [email protected]:trinsiclabs/divvy.git

Stand up and provision the host VM:

$ cd divvy
$ vagrant up

This will download the ubuntu/bionic64 image and provision the box with various tools. The provisioning script is in Vagrantfile if you want to see exactly what happens.

Once that finishes, login to the host:

$ vagrant ssh

Verify the platform components have been installed:

$ ls

You should see these directories:

• api
• application
• chaincode
• network

Start the network component

From the host VM navigate to the network directory and bring up the network:

$ cd /home/vagrant/network
$ ./network.sh up

This brings up the base network consisting of a solo order, CA, and CLI container. Logging information is streamed to this window, so keep it open, and use a new window for the next steps.

Start the API component

See the Getting Started section of the API docs for steps on bringing up the API component.

Start the application component

See the Getting Started section of the application docs for steps on bringing up the client application.

Once have the network, API, and application components running you're ready to start using the platform at http://divvy.local

Host queue

Containers run on the network_divvy Docker network. This allows containers to communicate with each other on any ports where services are available, by supplying container_name and a port number.

An exception to this is where the application container web.app.divvy.com needs to tell the network a new user has registered and to create a new organisation (by executing the network.sh script, on the host).

To execute the host script from inside web.app.divvy.com we mount a named pipe (FIFO) called host_queue (created during provisioning). The container writes commands to host_queue and the commands are read then executed by the host.

The process to read the pipe is created and killed by the network.sh up and network.sh down commands respectively.

Development

During provisioning each platform component is cloned onto the host VM. To make changes to components you to connect your IDE to the host. Here's how to do it using Visual Studio Code.

Install the Remote SSH plugin

Bring up the host if you haven't already:

$ vagrant up

Print and copy the Vagrant SSH config:

$ vagrant ssh-config

Configure the Remote SSH plugin:

1. Open Visual Studio Code
2. Open the Remote SSH plugin (bottom left corner)
3. Select 'Open configuration file...'
4. Select 'YOUR_HOME_DIR/.ssh/config'
5. Paste the Vagrant SSH config
6. Close the file

Now connect to the host VM:

1. Open the Remote SSH plugin again
2. Select 'Connect to host...'
3. Select 'divvy'

A new editor window should open with your remote connection.

Gotchas

Here's a few things to look out for along the way...

Destorying the host VM

VMs are great because you can mess stuff up, blow away the machine, and start again. Because this project clones repos (code you're working on) into the VM, you have to be a bit careful when destroying the VM.

When you destroy the VM you're also destroying your code. Always push your changes back upstream before destroying the host VM.

Commit signing

If you try to commit changes and see:

error: gpg failed to sign the data

Support for signing commits is currently not implemented. You need to edit .gitconfig on the host VM and set the flag to false.