Skip to content

Latest commit

 

History

History
151 lines (114 loc) · 5.78 KB

README.md

File metadata and controls

151 lines (114 loc) · 5.78 KB
Raw

Hyperledger Composer - Tutorial 2 - Running a local application

Follow the instructions below to get started by standing up a Hyperledger Fabric, and then getting a simple Hyperledger Composer Business Network deployed and an application running against it. A 'Getting Started' application.

This sample application should be run against a v1.0 Hyperledger Fabric (and which the scripts below will stand up as a Dev environment)

Step 1: Getting Hyperledger Fabric running

These scripts use Node v6, and bash, which are Hyperledger Composer dependencies. Choose a directory that you wish to have the setup scripts within.

  1. In a directory of your choice (will assume ~/fabric-tools) get the zip file that contains the tools. There are both .tar.gz and .zip formats
$ mkdir ~/fabric-tools && cd ~/fabric-tools
$ curl -O https://raw.githubusercontent.com/hyperledger/composer-tools/master/packages/fabric-dev-servers/fabric-dev-servers.tar.gz
$ tar xvzf fabric-dev-servers.tar.gz


$ mkdir ~/fabric-tools && cd ~/fabric-tools
$ curl -O https://raw.githubusercontent.com/hyperledger/composer-tools/master/packages/fabric-dev-servers/fabric-dev-servers.zip
$ unzip fabric-dev-servers.zip

IMPORTANT if you are running this sample application using Hyperledger composer version 0.17 or higher then you need to be using Hyperledger fabric 1.1. To ensure this you must ensure you set the version to 1.1 as follows

$ export FABRIC_VERSION=hlfv11

If you have been using composer version 0.16 then you will need to clear out your file system card store as cards in there are not compatible with 0.17. The quickest way to do this is

$ rm -fr $HOME/.composer
  1. If this is the first time you've run this tutorial, you'll need to download the fabric first. If you have already downloaded a set of Fabric images then first start the fabric (see below), and create a Composer business network card. Make sure you don't have a previous network (digitalproperty-network) docker container left running as 'legacy' - remove legacy containers as necessary using docker rm). After that, you can then choose to stop the fabric, and start it again later. Alternatively, to completely clean up, you can 'teardown' the Fabric (see more below).

All the scripts will be in the directory ~/fabric-tools you created above. A typical sequence for Hyperledger Composer startup would be:

$ cd ~/fabric-tools
$ ./downloadFabric.sh
$ ./startFabric.sh
$ ./createPeerAdminCard.sh

Then at the end of your development session

$ cd ~/fabric-tools
$ ./stopFabric.sh
$ ./teardownFabric.sh

Script details

Downloading Fabric

Issue the following command from the fabric-tools directory:

$ ./downloadFabric.sh

Starting Fabric

Issue the following command from the fabric-tools directory:

$ ./startFabric.sh

Stop Fabric

Issue the following command from the fabric-tools directory:

$ ./stopFabric.sh

By default, this 'start' script will pause for 15 seconds to let Fabric start - on some systems this may not be enough. If you see fails in running startFabric.sh you can alter this value - its controlled by a environment variable that takes a numeric value representing the number of seconds to wait.

$ export FABRIC_START_TIMEOUT=30

Create Composer Business network card

This will create a business network card and import it into the card store. This card provides the ability to install and start business networks on the hyperledger fabric network.

Issue this command from the fabric-tools directory

$ ./createPeerAdminCard.sh

Note: this create a Hyperledger Composer business network card specifically to connect to the development fabric you've already started.

Teardown Fabric (when you want to 'clean' up and start afresh)

Issue from the fabric-tools directory

$ ./teardownFabric.sh

Step 2: Getting the Hyperledger Composer sample application (the Digital Property CLI sample application) up and running

  1. Make sure you've started Fabric as in Step 1 above. For example, If this is your first time for example
$ cd ~/fabric-tools
$ ./downloadFabric.sh
$ ./startFabric.sh
$ ./createPeerAdminCard.sh
  1. Clone the sample application into a directory of your choice - BUT not the same directory as in Step 1. (Assume `~/github')
$ mkdir ~/github && cd ~/github
$ git clone https://github.com/hyperledger/composer-sample-applications
$ cd composer-sample-applications
$

IMPORTANT if you are using Composer 0.17 or higher and thus Hyperledger Fabric 1.1, then you need to change the application to use the correct version of Composer. To do this open the file packages/digitalproperty-app/package.json and change all the references to composer dependencies from ^0.16.3 to ^0.17.2 eg.

  "dependencies": {
    "cli-table": "^0.3.1",
    "composer-cli": "^0.17.2",
    "composer-client": "^0.17.2",
    "digitalproperty-network": "^0.1.2",
    "jsonfile": "^2.4.0",
    "lodash": "^4.17.4",
    "prettyjson": "^1.2.1",
    "sprintf-js": "^1.0.3",
    "winston": "^2.3.0",
    "yargs": "^6.5.0"
  },

OPTIONAL: To see a summary of all the sample applications, there's a simple command that will show summary details of the sample applications available in this repository. A useful information node.js script has been created to show the available sample applications - note you will need to run npm install from the current directory (takes about 5-10 mins) before running this command.

$ node ~/github/composer-sample-applications/info.js
  1. Deploy the business network (for example - deploying the Digital Property sample application)
$ cd packages/digitalproperty-app
$ npm install
$ npm run deployNetwork
  1. Bootstrap Assets, Participants and run the sample application (Digital Property sample, for example)
$ npm test