Skip to content
Use a Kubernetes cluster to deploy a Fabric network smart contract onto blockchain
Branch: master
Clone or download
Laura Bennett Laura Bennett
Laura Bennett and Laura Bennett adding linting
Latest commit 32b4ac1 Jun 30, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
contract adding linting Jun 30, 2019
docs updating arch diagram Jun 29, 2019
web-app fixing bug due to case sensitivity Jun 14, 2019
.gitignore Updated application (#1) Feb 14, 2019
CONTRIBUTING.md Initial Upload Feb 6, 2019
LICENSE Initial Upload Feb 6, 2019
MAINTAINERS.md Initial Upload Feb 6, 2019
README.md fixing bug due to case sensitivity Jun 14, 2019
package-lock.json adding linting Jun 30, 2019

README.md

FabCar Blockchain Sample

Hyperledger Fabric sample Fabcar on IBM Blockchain Platform

This code pattern demonstrates setting up a network on the IBM Blockchain Platform and deploying the Fabcar smart contract on the network. Next, we setup our application to interact with the network including identities to submit transactions on the smart contract. The application is setup with a Node.js server using the Fabric Node SDK to process requests to the network, and an Angular client to bring up a web interface.

When the reader has completed this code pattern, they will understand how to:

  • Setup a Hyperledger Fabric network on IBM Blockchain Platform
  • Install and instantiate smart contract through the IBM Blockchain Platform
  • Develop a Node.js server with the Hyperledger Fabric SDK to interact with the deployed network
  • Create an Angular frontend for the web app to interface with the network

Architecture flow

The developer uses the IBM Blockchain Platform Extension for VS Code to:

  1. The Blockchain Operator sets up the IBM Blockchain Platform service
  2. The IBM Blockchain Platform enables to create a Hyperledger Fabric network onto a IBM Kubernetes Service, allowing to install and instantiate the Fabcar smart contract on the network
  3. The Node.js application server uses the Fabric sdk to interact with the deployed network on IBM Blockchain Platform and creates APIs for a web client
  4. The Angular client uses the Node.js application API to interact with the network
  5. The User interacts with the Fabcar Angular web interface to update and query the blockchain ledger and state

Included components

  • IBM Blockchain Platform gives you total control of your blockchain network with a user interface that can simplify and accelerate your journey to deploy and manage blockchain components on the IBM Cloud Kubernetes Service.
  • IBM Cloud Kubernetes Service creates a cluster of compute hosts and deploys highly available containers. A Kubernetes cluster lets you securely manage the resources that you need to quickly deploy, update, and scale applications.
  • IBM Blockchain Platform Extension for VS Code is designed to assist users in developing, testing, and deploying smart contracts -- including connecting to Hyperledger Fabric environments.

Featured technologies

  • Hyperledger Fabric v1.4 is a platform for distributed ledger solutions, underpinned by a modular architecture that delivers high degrees of confidentiality, resiliency, flexibility, and scalability.
  • Node.js is an open source, cross-platform JavaScript run-time environment that executes server-side JavaScript code.
  • Express.js is a minimal and flexible Node.js web application framework that provides a robust set of features for web and mobile applications.
  • Angular.io is a front-end framework for building web applications.

Prerequisites

Running the application

Follow these steps to set up and run this code pattern. The steps are described in detail below.

Steps

To run a local network, you can find steps here

  1. Clone the repo
  2. Package the smart contract
  3. Create IBM Cloud services
  4. Build a network
  5. Deploy FabCar Smart Contract on the network
  6. Connect application to the network
  7. Run the application

1. Clone the repo

Clone this repository in a folder your choice:

git clone https://github.com/IBM/fabcar-blockchain-sample.git
cd fabcar-blockchain-sample

2. Package the smart contract

We will use the IBM Blockchain Platform extension to package the Fabcar smart contract.

  • Open Visual Studio code and open the contract folder from this repository that was cloned earlier.

  • Press the F1 key to see the different VS code options. Choose IBM Blockchain Platform: Package a Smart Contract Project.

  • Click the IBM Blockchain Platform extension button on the left. This will show the packaged contracts on top and the blockchain connections on the bottom.

  • Next, right click on the packaged contract to export it and choose Export Package.

  • Choose a location on your machine and save .cds file. We will use this packages smart contract later to deploy on our work.

Now, we will start creating our Hyperledger Fabric network on the IBM Cloud.

3. Create IBM Cloud services

  • Create the IBM Cloud Kubernetes Service. You can find the service in the Catalog. For this code pattern, we can use the Free cluster, and give it a name. Note, that the IBM Cloud allows one instance of a free cluster and expires after 30 days.


  • Create the IBM Blockchain Platform service on the IBM Cloud. You can find the service in the Catalog, and give a name.


  • After your kubernetes cluster is up and running, you can deploy your IBM Blockchain Platform on the cluster. The service walks through few steps and finds your cluster on the IBM Cloud to deploy the service on.


  • Once the Blockchain Platform is deployed on the Kubernetes cluster, you can launch the console to start operating on your blockchain network.


4. Build a network

We will build a network as provided by the IBM Blockchain Platform documentation. This will include creating a channel with a single peer organization with its own MSP and CA (Certificate Authority), and an orderer organization with its own MSP and CA. We will create the respective identities to deploy peers and operate nodes.

Create your organization and your entry point to your blockchain

  • Create your peer organization CA

    • Click Add Certificate Authority.
    • Click IBM Cloud under Create Certificate Authority and Next.
    • Give it a Display name of Org1 CA.
    • Specify an Admin ID of admin and Admin Secret of adminpw.


  • Use your CA to register identities

    • Select the Org 1 CA Certificate Authority that we created.
    • First, we will register an admin for our organization "org1". Click on the Register User button. Give an Enroll ID of org1admin, and Enroll Secret of org1adminpw. Click Next. Set the Type for this identity as client and select from any of the affiliated organizations from the drop-down list. We will leave the Maximum enrollments and Add Attributes fields blank.
    • We will repeat the process to create an identity of the peer. Click on the Register User button. Give an Enroll ID of peer1, and Enroll Secret of peer1pw. Click Next. Set the Type for this identity as peer and select from any of the affiliated organizations from the drop-down list. We will leave the Maximum enrollments and Add Attributes fields blank.


  • Create the peer organization MSP definition

    • Navigate to the Organizations tab in the left navigation and click Create MSP definition.
    • Enter the MSP Display name as Org1 MSP and an MSP ID of org1msp.
    • Under Root Certificate Authority details, specify the peer CA that we created Org1 CA as the root CA for the organization.
    • Give the Enroll ID and Enroll secret for your organization admin, org1admin and org1adminpw. Then, give the Identity name, Org1 Admin.
    • Click the Generate button to enroll this identity as the admin of your organization and export the identity to the wallet. Click Export to export the admin certificates to your file system. Finally click Create MSP definition.


  • Create a peer
    • On the Nodes page, click Add peer.
    • Click IBM Cloud under Create a new peer and Next.
    • Give your peer a Display name of Peer Org1.
    • On the next screen, select Org1 CA as your Certificate Authority. Then, give the Enroll ID and Enroll secret for the peer identity that you created for your peer, peer1, and peer1pw. Then, select the Administrator Certificate (from MSP), Org1 MSP, from the drop-down list and click Next.
    • Give the TLS Enroll ID, admin, and TLS Enroll secret, adminpw, the same values are the Enroll ID and Enroll secret that you gave when creating the CA. Leave the TLS CSR hostname blank.
    • The last side panel will ask you to Associate an identity and make it the admin of your peer. Select your peer admin identity Org1 Admin.
    • Review the summary and click Submit.


Create the node that orders transactions

  • Create your orderer organization CA

    • Click Add Certificate Authority.
    • Click IBM Cloud under Create Certificate Authority and Next.
    • Give it a unique Display name of Orderer CA.
    • Specify an Admin ID of admin and Admin Secret of adminpw.


  • Use your CA to register orderer and orderer admin identities

    • In the Nodes tab, select the Orderer CA Certificate Authority that we created.
    • First, we will register an admin for our organization. Click on the Register User button. Give an Enroll ID of ordereradmin, and Enroll Secret of ordereradminpw. Click Next. Set the Type for this identity as client and select from any of the affiliated organizations from the drop-down list. We will leave the Maximum enrollments and Add Attributes fields blank.
    • We will repeat the process to create an identity of the orderer. Click on the Register User button. Give an Enroll ID of orderer1, and Enroll Secret of orderer1pw. Click Next. Set the Type for this identity as peer and select from any of the affiliated organizations from the drop-down list. We will leave the Maximum enrollments and Add Attributes fields blank.


  • Create the orderer organization MSP definition

    • Navigate to the Organizations tab in the left navigation and click Create MSP definition.
    • Enter the MSP Display name as Orderer MSP and an MSP ID of orderermsp.
    • Under Root Certificate Authority details, specify the peer CA that we created Orderer CA as the root CA for the organization.
    • Give the Enroll ID and Enroll secret for your organization admin, ordereradmin and ordereradminpw. Then, give the Identity name, Orderer Admin.
    • Click the Generate button to enroll this identity as the admin of your organization and export the identity to the wallet. Click Export to export the admin certificates to your file system. Finally click Create MSP definition.


  • Create an orderer

    • On the Nodes page, click Add orderering service.
    • Click IBM Cloud and proceed with Next.
    • Give your peer a Display name of Orderer.
    • On the next screen, select Orderer CA as your Certificate Authority. Then, give the Enroll ID and Enroll secret for the peer identity that you created for your orderer, orderer1, and orderer1pw. Then, select the Administrator Certificate (from MSP), Orderer MSP, from the drop-down list and click Next.
    • Give the TLS Enroll ID, admin, and TLS Enroll secret, adminpw, the same values are the Enroll ID and Enroll secret that you gave when creating the CA. Leave the TLS CSR hostname blank.
    • The last side panel will ask to Associate an identity and make it the admin of your peer. Select your peer admin identity Orderer Admin.
    • Review the summary and click Submit.


  • Add organization as Consortium Member on the orderer to transact

    • Navigate to the Nodes tab, and click on the Orderer that we created.
    • Under Consortium Members, click Add organization.
    • From the drop-down list, select Org1 MSP, as this is the MSP that represents the peer's organization org1.
    • Click Submit.


Create and join channel

  • Create the channel

    • Navigate to the Channels tab in the left navigation.
    • Click Create channel.
    • Give the channel a name, mychannel.
    • Select the orderer you created, Orderer from the orderers drop-down list.
    • Select the channel member under the Organization section, This should be Org1 MSP (org1msp).
    • Select the MSP identifying the organization of the channel creator from the drop-down list. This should be Org1 MSP (org1msp).
    • Click Add next to your organization. Make your organization an Operator.
    • Select identity under the Channel creator organization section as Org1 Admin.
    • Click Create channel.


  • Join your peer to the channel

    • Click Join channel to launch the side panels.
    • Select your Orderer and click Next.
    • Enter the name of the channel you just created. mychannel and click Next.
    • Select which peers you want to join the channel, click Peer Org1 .
    • Click Join Channel.


5. Deploy FabCar Smart Contract on the network

  • Install a smart contract

    • Click the Smart contracts tab to install the smart contract.
    • Click Install smart contract to upload the Fabcar smart contract package file, which you packaged earlier using the Visual Studio code extension.
    • Click on Add file and find your packaged smart contract.
    • Once the contract is uploaded, click Install.


  • Instantiate smart contract

    • On the smart contracts tab, find the smart contract from the list installed on your peers and click Instantiate from the overflow menu on the right side of the row.
    • On the side panel that opens, select the channel, mychannel to instantiate the smart contract on. Click Next.
    • Select the organization members to be included in the policy, org1msp. Click Next twice.
    • Give Function name of initLedger and leave Arguments blank.
    • Click Instantiate.


6. Connect application to the network

  • Connect with sdk through connection profile

    • Under the Instantiated Smart Contract, click on Connect with SDK from the overflow menu on the right side of the row.
    • Choose from the dropdown for MSP for connection, org1msp.
    • Choose from Certificate Authority dropdown, Org1 CA.
    • Download the connection profile by scrolling down and clicking Download Connection Profile. This will download the connection json which we will use soon to establish connection.
    • You can click Close once the download completes.


  • Create an application admin

    • Go to the Nodes tab on the left bar, and under Certificate Authorities, choose your organization CA, Org1 CA.
    • Click on Register user.
    • Give an Enroll ID and Enroll Secret to administer your application users, app-admin and app-adminpw.
    • Choose client as Type.
    • You can leave the Maximum enrollments blank.
    • Under Attributes, click on Add attribute. Give attribute as hf.Registrar.Roles = *. This will allow this identity to act as registrar and issues identities for our app. Click Add-attribute.
    • Click Register.


  • Update application connection

    • Copy the connection profile you downloaded into server folder
    • Update the config.json file with:
      • The connection json file name you downloaded.
      • The enroll id and enroll secret for your app admin, which we earlier provided as app-admin and app-adminpw.
      • The orgMSP ID, which we provided as org1msp.
      • The caName, which can be found in your connection json file under "organization" -> "org1msp" -> certificateAuthorities". This would be like an IP address and a port.
      • The username you would like to register.
      • Update gateway discovery to { enabled: true, asLocalhost: false } to connect to IBP.

the current default setup is to connect to a local fabric instance from VS Code

{
    "connection_file": "mychannel_fabcar_profile.json",
    "appAdmin": "app-admin",
    "appAdminSecret": "app-adminpw",
    "orgMSPID": "org1msp",
    "caName": "169.46.208.151:30404",
    "userName": "user1",
    "gatewayDiscovery": { "enabled": true, "asLocalhost": false }
}

7. Run the application

  • Enroll admin

    • First, navigate to the web-app directory, and install the node dependencies.

      cd web-app/server
      npm install
    • Run the enrollAdmin.js script

      node enrollAdmin.js
    • You should see the following in the terminal:

      msg: Successfully enrolled admin user app-admin and imported it into the wallet
  • Register User

    • Run the registerUser.js script.

      node registerUser.js
    • You should see the following in the terminal:

      Successfully registered and enrolled admin user user1 and imported it into the wallet
  • Start the application server

    • From the server directory, start the server.

      npm start
  • Start the web client

    • In a new terminal, open the web client folder and install the dependencies.

      cd web-app/client
      npm install
    • Start the client:

      npm start

You can find the app running at http://localhost:4200/



You can go to the IBM Blockchain Platform console to monitor your users and get information on your channel including the blocks added.



Troubleshooting

  • If you encounter an error discover error: access denied, you need to set the gatewayDiscovery properly in your config.json file. This is REQUIRED You must set it as follows to connect to IBP:

               `"gatewayDiscovery": {"enabled": true, "asLocalhost": false }`
    

Links

License

This code pattern is licensed under the Apache Software License, Version 2. Separate third-party code objects invoked within this code pattern are licensed by their respective providers pursuant to their own separate licenses. Contributions are subject to the Developer Certificate of Origin, Version 1.1 (DCO) and the Apache Software License, Version 2.

Apache Software License (ASL) FAQ

You can’t perform that action at this time.