Skip to content
/ Hyperledger-Fabric_Simple-Network Public

A simple Hyperledger Fabric project. It involves a simple architecture, chaincode and web application.

3 stars 0 forks Branches Tags Activity
Star
Notifications You must be signed in to change notification settings

rajan-31/Hyperledger-Fabric_Simple-Network

BranchesTags

Repository files navigation

Branches in this repo

*Note: Branches with a name like "v1", "v2", etc. are only for understanding that what is changed since the last update. This means that the latest "v" branch is the same as "main".

main

  • main development branch

v1

  • the first network developed

v2

  • EnableNodeOUs: true

    • setting this to true will allow us to define additional policies for the network members

  • Chaincode operations - chaincode install dependencies, package, install, approve, commit, init, invoke

v3

  • Chaincode development

v4

  • Application to interact with chaincode, using fabric-node-sdk

v5

  • Simple web app to interact with chaincode.

v6

  • Make chaincode modular, test performance using scripts

Helpful Commands

  • Start docker daemon orderer.example.com sudo systemctl start docker

  • docker ps, Print selected columns

    docker ps --format "table {{.ID}}\t{{.Command}}\t{{.Names}}"

Future Goals

- add events in chaincode
- use Hyperledger Explorer (similar to Etherscan)

Steps used

  • Installations

    • Git
    • Curl
    • Docker
    • Docker Compose
    • GO
    • JQ
    • Fabric Binaries

  • Env Setup

    • add user to docker group
    • add go bin to PATH
    • copy fabric bin to user/local/bin
      • sudo cp ./fabric-samples/bin/* /usr/local/bin

  • cryptogen

    • cryptogen generate --config="./crypto-config.yaml" --output="crypto-material"

  • configtxgen

    • Create genesis block for "channel1"
      • configtxgen -profile OneOrgApplicationGenesis -outputBlock ./channel-artifacts/genesis.block -channelID channel1

  • docker

    • write docker-compose.yaml
    • in root directory run
      • docker-compose -f ./docker-compose.yaml up -d
      • check all containers
        • docker ps -a
      • stop services (use after you stop development of the project)
        • docker-compose -f ./docker-compose.yaml stop
      • start services (use when you again start development of the project)
        • docker-compose -f ./docker-compose.yaml stop
      • Stop and remove containers, networks, images, and volumes (careful: for destroying everything)
        • docker-compose -f ./docker-compose.yaml down -v

  • connect to cli container

    • docker exec -it cli bash

    • enroll (https://hyperledger-fabric.readthedocs.io/en/latest/create_channel/create_channel_participation.html)

    • export CHANNEL_NAME=channel1

export OSN_TLS_CA_ROOT_CERT=/opt/gopath/src/github.com/hyperledger/fabric/peer/crypto/ordererOrganizations/example.com/orderers/orderer.example.com/msp/tlscacerts/tlsca.example.com-cert.pem

export ADMIN_TLS_SIGN_CERT=/opt/gopath/src/github.com/hyperledger/fabric/peer/crypto/ordererOrganizations/example.com/orderers/orderer.example.com/tls/server.crt

export ADMIN_TLS_PRIVATE_KEY=/opt/gopath/src/github.com/hyperledger/fabric/peer/crypto/ordererOrganizations/example.com/orderers/orderer.example.com/tls/server.key

    • osnadmin channel join --channelID $CHANNEL_NAME --config-block ./channel-artifacts/genesis.block -o "orderer.example.com:7053" --ca-file $OSN_TLS_CA_ROOT_CERT --client-cert $ADMIN_TLS_SIGN_CERT --client-key $ADMIN_TLS_PRIVATE_KEY

    • list channels

      osnadmin channel list --channelID $CHANNEL_NAME -o "orderer.example.com:7053" --ca-file $OSN_TLS_CA_ROOT_CERT --client-cert $ADMIN_TLS_SIGN_CERT --client-key $ADMIN_TLS_PRIVATE_KEY

    • peer join channel (https://hyperledger-fabric.readthedocs.io/en/latest/commands/peerchannel.html)

    • export CORE_PEER_TLS_ENABLED=true
export CORE_PEER_LOCALMSPID="Org1MSP"
export CORE_PEER_TLS_ROOTCERT_FILE=/opt/gopath/src/github.com/hyperledger/fabric/peer/crypto/peerOrganizations/org1.example.com/peers/peer1.org1.example.com/tls/ca.crt
export CORE_PEER_MSPCONFIGPATH=/opt/gopath/src/github.com/hyperledger/fabric/peer/crypto/peerOrganizations/org1.example.com/users/[email protected]/msp
export CORE_PEER_ADDRESS=peer1.org1.example.com:7051


      peer channel join -b ./channel-artifacts/genesis.block
peer channel list

    • export CORE_PEER_TLS_ENABLED=true
export CORE_PEER_LOCALMSPID="Org1MSP"
export CORE_PEER_TLS_ROOTCERT_FILE=/opt/gopath/src/github.com/hyperledger/fabric/peer/crypto/peerOrganizations/org1.example.com/peers/peer2.org1.example.com/tls/ca.crt
export CORE_PEER_MSPCONFIGPATH=/opt/gopath/src/github.com/hyperledger/fabric/peer/crypto/peerOrganizations/org1.example.com/users/[email protected]/msp
export CORE_PEER_ADDRESS=peer2.org1.example.com:7061


      peer channel join -b ./channel-artifacts/genesis.block
peer channel list

    • anchor peer transaction, use configtxlator

      • env vars

        export CORE_PEER_LOCALMSPID="Org1MSP"
export CORE_PEER_TLS_ROOTCERT_FILE=/opt/gopath/src/github.com/hyperledger/fabric/peer/crypto/peerOrganizations/org1.example.com/peers/peer1.org1.example.com/tls/ca.crt
export CORE_PEER_MSPCONFIGPATH=/opt/gopath/src/github.com/hyperledger/fabric/peer/crypto/peerOrganizations/org1.example.com/users/[email protected]/msp
export CORE_PEER_ADDRESS=peer1.org1.example.com:7051
export ORDERER_CA=/opt/gopath/src/github.com/hyperledger/fabric/peer/crypto/ordererOrganizations/example.com/orderers/orderer.example.com/msp/tlscacerts/tlsca.example.com-cert.pem

      • The channel configuration block config_block.pb is stored in the channel-artifacts folder to keep the update process separate from other artifacts. (at this stage both genesis and the latest channel config will be the same because we haven't updated the channel config)

        # pb (extension for output): protobuf

peer channel fetch config channel-artifacts/config_block.pb -o "orderer.example.com:7050" --ordererTLSHostnameOverride orderer.example.com -c channel1 --tls --cafile "$ORDERER_CA"

      • decode the block from protobuf into a JSON object that can be read and edited

        configtxlator proto_decode --input config_block.pb --type common.Block --output config_block.json

jq '.data.data[0].payload.data.config' config_block.json > config.json

      • convert the channel configuration block into a streamlined JSON, config.json, that will serve as the baseline for our update. Because we don't want to edit this file directly, we will make a copy that we can edit. We will use the original channel config in a future step

        cp config.json config_copy.json

      • use the jq tool to add the Org1 anchor peer to the channel configuration

        jq '.channel_group.groups.Application.groups.Org1MSP.values += {"AnchorPeers":{"mod_policy": "Admins","value":{"anchor_peers": [{"host": "peer1.org1.example.com","port": 7051}]},"version": "0"}}' config_copy.json > modified_config.json

      • convert both the original and modified channel configurations back into protobuf format and calculate the difference between them

        configtxlator proto_encode --input config.json --type common.Config --output config.pb

configtxlator proto_encode --input modified_config.json --type common.Config --output modified_config.pb

configtxlator compute_update --channel_id channel1 --original config.pb --updated modified_config.pb --output config_update.pb

      • wrap the configuration update in a transaction envelope to create the channel configuration update transaction

        configtxlator proto_decode --input config_update.pb --type common.ConfigUpdate --output config_update.json

echo '{"payload":{"header":{"channel_header":{"channel_id":"channel1", "type":2}},"data":{"config_update":'$(cat config_update.json)'}}}' | jq . > config_update_in_envelope.json

configtxlator proto_encode --input config_update_in_envelope.json --type common.Envelope --output config_update_in_envelope.pb

      • use the final artifact, config_update_in_envelope.pb, that can be used to update the channel

      • We can add the anchor peer by providing the new channel configuration to the peer channel update command. Because we are updating a section of the channel configuration that only affects Org1, other channel members do not need to approve the channel update.

        export CORE_PEER_LOCALMSPID="Org1MSP"
export CORE_PEER_TLS_ROOTCERT_FILE=/opt/gopath/src/github.com/hyperledger/fabric/peer/crypto/peerOrganizations/org1.example.com/peers/peer1.org1.example.com/tls/ca.crt
export CORE_PEER_MSPCONFIGPATH=/opt/gopath/src/github.com/hyperledger/fabric/peer/crypto/peerOrganizations/org1.example.com/users/[email protected]/msp
export CORE_PEER_ADDRESS=peer1.org1.example.com:7051
export ORDERER_CA=/opt/gopath/src/github.com/hyperledger/fabric/peer/crypto/ordererOrganizations/example.com/orderers/orderer.example.com/msp/tlscacerts/tlsca.example.com-cert.pem

        peer channel update -f channel-artifacts/config_update_in_envelope.pb -c channel1 -o "orderer.example.com:7050" --ordererTLSHostnameOverride orderer.example.com --tls --cafile $ORDERER_CA

    • Chaincode

      • go to chaincode folder in cli file system

      • put chaincode file there

      • go mod init github.com/chaincode - from chaincode directory itself

        • it will create go.mod

      • (https://golang.org/doc/tutorial/create-module)

      • go mod tidy

        • it will add and dependencies definde in chaincode file

      • GO111MODULE=on go mod vendor

        • it will install all dependencies and put them in the vendor folder

      • package and install chaincode

        export CORE_PEER_LOCALMSPID="Org1MSP"
export CORE_PEER_TLS_ROOTCERT_FILE=/opt/gopath/src/github.com/hyperledger/fabric/peer/crypto/peerOrganizations/org1.example.com/peers/peer1.org1.example.com/tls/ca.crt
export CORE_PEER_MSPCONFIGPATH=/opt/gopath/src/github.com/hyperledger/fabric/peer/crypto/peerOrganizations/org1.example.com/users/[email protected]/msp
export CORE_PEER_ADDRESS=peer1.org1.example.com:7051

export CORE_PEER_LOCALMSPID="Org1MSP"
export CORE_PEER_TLS_ROOTCERT_FILE=/opt/gopath/src/github.com/hyperledger/fabric/peer/crypto/peerOrganizations/org1.example.com/peers/peer2.org1.example.com/tls/ca.crt
export CORE_PEER_MSPCONFIGPATH=/opt/gopath/src/github.com/hyperledger/fabric/peer/crypto/peerOrganizations/org1.example.com/users/[email protected]/msp
export CORE_PEER_ADDRESS=peer2.org1.example.com:7061

        # peer lifecycle chaincode package mycc.tar.gz -p . -n mycc --lang golang -v 1.0 -s -S
peer lifecycle chaincode package ./packages/simple_cc_v1_v1.tar.gz -p . --label simplecc_v1_v1

# peer lifecycle chaincode install mycc.tar.gz
peer lifecycle chaincode install ./packages/simple_cc_v1_v1.tar.gz


peer lifecycle chaincode queryinstalled

      • approve chaincode and check commit readiness (admin of org)

        export CORE_PEER_TLS_ENABLED=true
export CORE_PEER_LOCALMSPID="Org1MSP"
export CORE_PEER_TLS_ROOTCERT_FILE=/opt/gopath/src/github.com/hyperledger/fabric/peer/crypto/peerOrganizations/org1.example.com/peers/peer1.org1.example.com/tls/ca.crt
export CORE_PEER_MSPCONFIGPATH=/opt/gopath/src/github.com/hyperledger/fabric/peer/crypto/peerOrganizations/org1.example.com/users/[email protected]/msp
export CORE_PEER_ADDRESS=peer1.org1.example.com:7051

export ORDERER_CA=/opt/gopath/src/github.com/hyperledger/fabric/peer/crypto/ordererOrganizations/example.com/orderers/orderer.example.com/msp/tlscacerts/tlsca.example.com-cert.pem

export CC_PACKAGE_ID=simplecc_v1_v1:802ae430bc3e78eaf96bdac4c895cb33a57c54dacbeb7392f2e7a3071e77b858

peer lifecycle chaincode approveformyorg -n simplecc -v 1 -C  channel1 --sequence 1 --init-required --package-id $CC_PACKAGE_ID --tls --cafile $ORDERER_CA

peer lifecycle chaincode checkcommitreadiness -n simplecc -v 1 -C  channel1 --sequence 1 --init-required

      • commit and check committed

        peer lifecycle chaincode commit -n simplecc -v 1 -C channel1 --sequence 1 --init-required --tls --cafile $ORDERER_CA

peer lifecycle chaincode querycommitted -n simplecc  -C channel1

      • after commit (change function name and args according to your chaincode)

        • FOR SHIM

          1. Init the chaincode peer chaincode invoke --isInit -n simplecc -C channel1 -c '{"Args":["init","a","100","b","200"]}' --tls --cafile $ORDERER_CA

          2. Query the chaincode peer chaincode query -C channel1 -n simplecc -c '{"Args":["query","a"]}'

          3. Invoke the chaincode peer chaincode invoke -C channel1 -n simplecc -c '{"Args":["invoke","a","b","10"]}' --tls --cafile $ORDERER_CA

        • FOR TRANSACTION API

          1. Init the chaincode peer chaincode invoke --isInit -n simplecc -C channel1 -c '{"Function":"InitLedger","Args":[]}' --tls --cafile $ORDERER_CA

          2. Query the chaincode peer chaincode query -C channel1 -n simplecc -c '{"Function":"Query", "Args":["a"]}'

    • Application (https://hyperledger-fabric.readthedocs.io/en/release-2.2/developapps/application.html)

      1. Wallet (https://hyperledger-fabric.readthedocs.io/en/release-2.2/developapps/wallet.html#wallet)

        • add a user identity we created previously ([email protected]) to the wallet
        • use addToWallet.js

      2. Gateway

        • Write a connection profile file

      3. Run the app

        • use node transaction-CreateOrModify_Admin.js to execute a transaction

          • response buffer will be empty because no return value for the respective function in chaincode

        • use node transaction-CreateOrModify_Admin.js to execute another transaction

          • response will be a buffer which we will convert to json, here we will get the newly added user. Because respective function in chaincode has a return value

    • Web App (based on above application)

      • setup gateway connection
      • make "contract" variable global(OR any other way so that it can be accessible in API routes)
      • user "contract" to execute transactions

*Note: Instructions given below are not proper, so don't try to follow unless you know what you are doing

  • Update the same chaincode - for both org and channel (to upgrade i.e. to deploy new version skip this go to next point/step, upgrade chaincode)

    • It will upgrade the binary, it will not create a new container/image
    • It is useful if you mistakenly committed a previous chaincode, and you want to change something
    • stop chaincode container
    • package chaincode
    • install chaincode
      • you will get a new package id
    • approve with same name and version as before
    • commit with same name and version as before
    • Query new (see that I changed function name query -> query_new) peer chaincode query -C channel1 -n simplecc -c '{"Args":["query_new","a"]}'

  • Upgrade chaincode

    • It will create new container/image
    • /var/hyperledger/production/lifecycle/chaincodes

CHAINCODE DEV scripts sequence

  • In cli bash

      1. main
    • to find seq no. peer lifecycle chaincode querycommitted -n simplecc -C channel1
    • docker exec cli sh -c 'sh ./scripts/chaincode_dev-main.sh . <seq no.>'

  • In "first" folder

      1. clear_old_installations
    • sh ./scripts/chaincode_dev-clear_old_installations-OR-combined.sh

OR

  • to combine both in one command

  • sh ./scripts/chaincode_dev-clear_old_installations-OR-combined.sh -

  • it uses sh ./scripts/chaincode_dev-main.sh . $(($(peer lifecycle chaincode querycommitted -n simplecc -C channel1 -O json | jq -r '.sequence') + 1))

MISC

  • Remove chaincode from peer (stop it from launching all installed chaincodes in containers)
    • kill chaincode container
    • docker exec -it peer1.org1.example.com /bin/sh
    • remove chaincodes from /var/hyperledger/production/lifecycle/chaincodes
    • restart peer

Solved Error by:

  • going through official documentation
  • research on the internet regarding a specific problem
  • going through the source code of fabric
  • Lot of testing and modifications

Other points:

  • Created StackOverflow questions and ans for future devs
  • opened an issue on fabric github repo regarding error/bugs

Copyright

About

A simple Hyperledger Fabric project. It involves a simple architecture, chaincode and web application.

Topics

golang blockchain hyperledger hyperledger-fabric chaincode hyperledger-fabric-network

Resources

Readme
Activity

Stars

3 stars

Watchers

1 watching

Forks

0 forks
Report repository

Languages