End-to-End Flow
The end-to-end verification demonstrates usage of the configuration transaction tool for orderer bootstrap and channel creation. The tool consumes a configuration transaction yaml file, which defines the cryptographic material (certs) used for member identity and network authentication. In other words, the MSP information for each member and its corresponding network entities.
Currently the crypto material is baked into the directory. However, there will be a tool in the near future to organically generate the certificates
Prerequisites
Follow the steps for setting up a development environment
Clone the Fabric code base.
git clone http://gerrit.hyperledger.org/r/fabric
or though a mirrored repository in github:
git clone https://github.com/hyperledger/fabric.git
Make the
configtxgentool.cd $GOPATH/src/github.com/hyperledger/fabric/devenv vagrant up vagrant ssh # ensure sure you are in the /fabric directory where the Makefile resides make configtxgen
Make the peer and orderer images.
# make sure you are in vagrant and in the /fabric directory make peer-docker orderer-dockerExecute a
docker imagescommand in your terminal. If the images compiled successfully, you should see an output similar to the following:vagrant@hyperledger-devenv:v0.3.0-4eec836:/opt/gopath/src/github.com/hyperledger/fabric$ docker images REPOSITORY TAG IMAGE ID CREATED SIZE hyperledger/fabric-orderer latest 264e45897bfb 10 minutes ago 180 MB hyperledger/fabric-orderer x86_64-0.7.0-snapshot-a0d032b 264e45897bfb 10 minutes ago 180 MB hyperledger/fabric-peer latest b3d44cff07c6 10 minutes ago 184 MB hyperledger/fabric-peer x86_64-0.7.0-snapshot-a0d032b b3d44cff07c6 10 minutes ago 184 MB hyperledger/fabric-javaenv latest 6e2a2adb998a 10 minutes ago 1.42 GB hyperledger/fabric-javaenv x86_64-0.7.0-snapshot-a0d032b 6e2a2adb998a 10 minutes ago 1.42 GB hyperledger/fabric-ccenv latest 0ce0e7dc043f 12 minutes ago 1.29 GB hyperledger/fabric-ccenv x86_64-0.7.0-snapshot-a0d032b 0ce0e7dc043f 12 minutes ago 1.29 GB hyperledger/fabric-baseimage x86_64-0.3.0 f4751a503f02 4 weeks ago 1.27 GB hyperledger/fabric-baseos x86_64-0.3.0 c3a4cf3b3350 4 weeks ago 161 MB
Configuration Transaction Generator
The configtxgen tool is used to create two artifacts: - orderer bootstrap block - fabric channel configuration transaction
The orderer block is the genesis block for the ordering service, and the channel transaction file is broadcast to the orderer at channel creation time.
The configtx.yaml contains the definitions for the sample network.
There are two members, each managing and maintaining two peer nodes.
Inspect this file to better understand the corresponding cryptographic
material tied to the member components. The /crypto directory
contains the admin certs, ca certs, private keys for each entity, and
the signing certs for each entity.
For ease of use, a script - generateCfgTrx.sh - is provided. The
script will generate the two configuration artifacts.
Run the shell script
Make sure you are in the examples/e2e directory and in your
vagrant environment. You can elect to pass in a unique name for your
channel or simply execute the script without the channel-ID
parameter. If you choose not to pass in a unique name, then a channel
with the default name of mychannel will be generated.
cd examples/e2e
# note the <channel-ID> parm is optional
./generateCfgTrx.sh <channel-ID>After you run the shell script, you should see an output in your terminal similar to the following:
2017/02/28 17:01:52 Generating new channel configtx
2017/02/28 17:01:52 Creating no-op MSP instance
2017/02/28 17:01:52 Obtaining default signing identity
2017/02/28 17:01:52 Creating no-op signing identity instance
2017/02/28 17:01:52 Serializing identity
2017/02/28 17:01:52 signing message
2017/02/28 17:01:52 signing message
2017/02/28 17:01:52 Writing new channel txThese configuration transactions will bundle the crypto material for the participating members and their network components and output an orderer genesis block and channel transaction artifact. These two artifacts are required for a functioning transactional network with sign/verify/authenticate capabilities.
Manually generate the artifacts (optional)
In your vagrant environment, navigate to the /common/configtx/tool
directory and replace the configtx.yaml file with the supplied yaml
file in the /e2e directory. Then return to the /e2e
directory.
# Generate orderer bootstrap block
configtxgen -profile TwoOrgs -outputBlock <block-name>
# example: configtxgen -profile TwoOrgs -outputBlock orderer.block
# Generate channel configuration transaction
configtxgen -profile TwoOrgs -outputCreateChannelTx <cfg txn name> -channelID <channel-id>
# example: configtxgen -profile TwoOrgs -outputCreateChannelTx channel.tx -channelID mychannelRun the end-to-end test
Make sure you are in the /e2e directory. Then use docker-compose
to spawn the network entities and drive the tests.
[CHANNEL_NAME=<channel-id>] docker-compose up -dIf you created a unique channel name, be sure to pass in that parameter. For example,
CHANNEL_NAME=abc docker-compose up -dWait, 30 seconds. Behind the scenes, there are transactions being sent
to the peers. Execute a docker ps to view your active containers.
You should see an output identical to the following:
vagrant@hyperledger-devenv:v0.3.0-4eec836:/opt/gopath/src/github.com/hyperledger/fabric/examples/e2e$ docker ps
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
45e3e114f7a2 dev-peer3-mycc-1.0 "chaincode -peer.a..." 4 seconds ago Up 4 seconds dev-peer3-mycc-1.0
5970f740ad2b dev-peer0-mycc-1.0 "chaincode -peer.a..." 24 seconds ago Up 23 seconds dev-peer0-mycc-1.0
b84808d66e99 dev-peer2-mycc-1.0 "chaincode -peer.a..." 48 seconds ago Up 47 seconds dev-peer2-mycc-1.0
16d7d94c8773 hyperledger/fabric-peer "peer node start -..." About a minute ago Up About a minute 0.0.0.0:10051->7051/tcp, 0.0.0.0:10053->7053/tcp peer3
3561a99e35e6 hyperledger/fabric-peer "peer node start -..." About a minute ago Up About a minute 0.0.0.0:9051->7051/tcp, 0.0.0.0:9053->7053/tcp peer2
0baad3047d92 hyperledger/fabric-peer "peer node start -..." About a minute ago Up About a minute 0.0.0.0:8051->7051/tcp, 0.0.0.0:8053->7053/tcp peer1
1216896b7b4f hyperledger/fabric-peer "peer node start -..." About a minute ago Up About a minute 0.0.0.0:7051->7051/tcp, 0.0.0.0:7053->7053/tcp peer0
155ff8747b4d hyperledger/fabric-orderer "orderer" About a minute ago Up About a minute 0.0.0.0:7050->7050/tcp ordererAll in one
You can also generate the artifacts and drive the tests using a single
shell script. The configtxgen and docker-compose commands are
embedded in the script.
./network_setup.sh up <channel-ID>Once again, if you choose not to pass the channel-ID parameter, then
your channel will default to mychannel.
What's happening behind the scenes?
- A script -
script.sh- is baked inside the CLI container. The script drives thecreateChannelcommand against the defaultmychannelname. - The output of
createChannelis a genesis block -mychannel.block- which is stored on the file system. - the
joinChannelcommand is exercised for all four peers who will pass in the genesis block. - Now we have a channel consisting of four peers, and two organizations.
PEER0andPEER1belong to Org0;PEER2andPEER3belong to Org1- Recall that these relationships are defined in the
configtx.yaml - A chaincode - chaincode_example02 is installed on
PEER0andPEER2 - The chaincode is then "instantiated" on
PEER2. Instantiate simply refers to starting the container and initializing the key value pairs associated with the chaincode. The initial values for this example are "a","100" "b","200". This "instantiation" results in a container by the name ofdev-peer2-mycc-1.0starting. - The instantiation also passes in an argument for the endorsement
policy. The policy is defined as
-P "OR ('Org0MSP.member','Org1MSP.member')", meaning that any transaction must be endorsed by a peer tied to Org0 or Org1. - A query against the value of "a" is issued to
PEER0. The chaincode was previously installed onPEER0, so this will start another container by the name ofdev-peer0-mycc-1.0. The result of the query is also returned. No write operations have occurred, so a query against "a" will still return a value of "100" - An invoke is sent to
PEER0to move "10" from "a" to "b" - The chaincode is installed on
PEER3 - A query is sent to
PEER3for the value of "a". This starts a third chaincode container by the name ofdev-peer3-mycc-1.0. A value of 90 is returned, correctly reflecting the previous transaction during which the value for key "a" was modified by 10.
What does this demonstrate?
Chaincode MUST be installed on a peer in order for it to
successfully perform read/write operations against the ledger.
Furthermore, a chaincode container is not started for a peer until a
read/write operation is performed against that chaincode (e.g. query for
the value of "a"). The transaction causes the container to start. Also,
all peers in a channel maintain an exact copy of the ledger which
comprises the blockchain to store the immutable, sequenced record in
blocks, as well as a state database to maintain current fabric state.
This includes those peers that do not have chaincode installed on them
(like Peer3 in the above example) . Finally, the chaincode is accessible
after it is installed (like Peer3 in the above example) because it
already has been instantiated.
How do I see these transactions?
Check the logs for the CLI docker container.
docker logs -f cli
You should see the following output:
2017-02-28 04:31:20.841 UTC [logging] InitFromViper -> DEBU 001 Setting default logging level to DEBUG for command 'chaincode'
2017-02-28 04:31:20.842 UTC [msp] GetLocalMSP -> DEBU 002 Returning existing local MSP
2017-02-28 04:31:20.842 UTC [msp] GetDefaultSigningIdentity -> DEBU 003 Obtaining default signing identity
2017-02-28 04:31:20.843 UTC [msp] Sign -> DEBU 004 Sign: plaintext: 0A8F050A59080322096D796368616E6E...6D7963631A0A0A0571756572790A0161
2017-02-28 04:31:20.843 UTC [msp] Sign -> DEBU 005 Sign: digest: 52F1A41B7B0B08CF3FC94D9D7E916AC4C01C54399E71BC81D551B97F5619AB54
Query Result: 90
2017-02-28 04:31:30.425 UTC [main] main -> INFO 006 Exiting.....
===================== Query on chaincode on PEER3 on channel 'mychannel' is successful =====================
===================== All GOOD, End-2-End execution completed =====================How can I see the chaincode logs?
Inspect the individual chaincode containers to see the separate transactions executed against each container. Here is the combined output from each container:
$ docker logs dev-peer2-mycc-1.0
04:30:45.947 [BCCSP_FACTORY] DEBU : Initialize BCCSP [SW]
ex02 Init
Aval = 100, Bval = 200
$ docker logs dev-peer0-mycc-1.0
04:31:10.569 [BCCSP_FACTORY] DEBU : Initialize BCCSP [SW]
ex02 Invoke
Query Response:{"Name":"a","Amount":"100"}
ex02 Invoke
Aval = 90, Bval = 210
$ docker logs dev-peer3-mycc-1.0
04:31:30.420 [BCCSP_FACTORY] DEBU : Initialize BCCSP [SW]
ex02 Invoke
Query Response:{"Name":"a","Amount":"90"}Manually create the channel and join peers through CLI
From your vagrant environment exit the currently running containers:
docker rm -f $(docker ps -aq)Execute a docker images command in your terminal to view the
chaincode images. They will look similar to the following:
REPOSITORY TAG IMAGE ID CREATED SIZE
dev-peer3-mycc-1.0 latest 3415bc2e146c 5 hours ago 176 MB
dev-peer0-mycc-1.0 latest 140d7ee3e911 5 hours ago 176 MB
dev-peer2-mycc-1.0 latest 6e4fc412969e 5 hours ago 176 MBRemove these images:
docker rmi <IMAGE ID> <IMAGE ID> <IMAGE ID>For example:
docker rmi -f 341 140 6e4Ensure you have the configuration artifacts. If you deleted them, run the shell script again:
./generateCfgTrx.sh <channel-ID>Modify the docker-compose file
Open the docker-compose file and comment out the command to run
script.sh. Navigate down to the cli image and place a # to the
left of the command. For example:
working_dir: /opt/gopath/src/github.com/hyperledger/fabric/peer
# command: /bin/bash -c './scripts/script.sh ${CHANNEL_NAME}'Save the file and return to the /e2e directory.
Now restart your network:
# make sure you are in the /e2e directory where you docker-compose script resides
docker-compose up -dCommand syntax
Refer to the create and join commands in the script.sh.
For any of the following commands to work, you need to preface the commands with the following environment variables.
# Environment variables for PEER0
CORE_PEER_MSPCONFIGPATH=/opt/gopath/src/github.com/hyperledger/fabric/peer/crypto/peer/peer0/localMspConfig
CORE_PEER_ADDRESS=peer0:7051
CORE_PEER_LOCALMSPID="Org0MSP"These environment variables for each peer are defined in the supplied docker-compose file.
Create channel
Exec into the cli container:
docker exec -it cli bashIf successful you should see the following:
root@0d78bb69300d:/opt/gopath/src/github.com/hyperledger/fabric/peer#Specify your channel name with the -c flag. Specify your channel
configuration transaction with the -f flag. In this case it is
channeltx, however you can mount your own configuration transaction
with a different name.
# the channel.tx and orderer.block are mounted in the crypto/orderer folder within your cli container
# as a result, we pass the full path for the file
peer channel create -o orderer:7050 -c mychannel -f crypto/orderer/channel.txRecall that the environment variables are required for this manual operation. So the command in its entirety would be:
CORE_PEER_MSPCONFIGPATH=/opt/gopath/src/github.com/hyperledger/fabric/peer/crypto/peer/peer0/localMspConfig CORE_PEER_ADDRESS=peer0:7051 CORE_PEER_LOCALMSPID="Org0MSP" peer channel create -o orderer:7050 -c mychannel -f crypto/orderer/channel.txNote: You will remain in the CLI container for the remainder of these manual commands. You must also remember to preface all commands with the corresponding env variables for the targeted peer.
Join channel
Join specific peers to the channel
# the mychannel.block is also mounted in the crypto/orderer directory
peer channel join -b mychannel.blockThis command in its entirety would be:
CORE_PEER_MSPCONFIGPATH=/opt/gopath/src/github.com/hyperledger/fabric/peer/crypto/peer/peer0/localMspConfig CORE_PEER_ADDRESS=peer0:7051 CORE_PEER_LOCALMSPID="Org0MSP" peer channel join -b crypto/orderer/mychannel.blockInstall chaincode onto a remote peer
Install the sample go code onto one of the four peer nodes
peer chaincode install -o orderer:7050 -n mycc -v 1.0 -p github.com/hyperledger/fabric/examples/chaincode/go/chaincode_example02Instantiate chaincode and define the endorsement policy
Instantiate the chaincode on a peer. This will launch a chaincode
container for the targeted peer and set the endorsement policy for the
chaincode. In this snippet, we define the policy as requiring an
endorsement from one peer node that is a part of Org1. In our scenario,
this is PEER2 or PEER3
#
peer chaincode instantiate -o orderer:7050 -C mychannel -n mycc -v 1.0 -p github.com/hyperledger/fabric/examples/chaincode/go/chaincode_example02 -c '{"Args":["init","a", "100", "b","200"]}' -P "AND('Org1MSP.member')"See the endorsement policies documentation for more details on policy implementation.
Invoke chaincode
peer chaincode invoke -o orderer:7050 -C mychannel -n mycc -c '{"Args":["invoke","a","b","10"]}'NOTE: Make sure to wait a few seconds for the operation to complete.
Query chaincode
peer chaincode query -o orderer:7050 -C mychannel -n mycc -c '{"Args":["query","a"]}'The result of the above command should be as below:
Query Result: 90Using the native binaries
Open your vagrant environment:
cd $GOPATH/src/github.com/hyperledger/fabric/devenv# you may have to first start your VM with vagrant up
vagrant sshFrom the fabric directory build the issue the following commands to
build the peer and orderer executables:
make clean
make nativeYou will also need the ccenv image. From the fabric directory:
make peer-dockerNext, open two more terminals and start your vagrant environment in each. You should now have a total of three terminals, all within vagrant.
Before starting, make sure to clear your ledger folder
/var/hyperledger/. You will want to do this after each run to avoid
errors and duplication.
rm -rf /var/hyperledger/*
Vagrant window 1
Use the configtxgen tool to create the orderer genesis block:
configtxgen -profile SampleSingleMSPSolo -outputBlock orderer.blockVagrant window 2
Start the orderer with the genesis block you just generated:
ORDERER_GENERAL_GENESISMETHOD=file ORDERER_GENERAL_GENESISFILE=./orderer.block ordererVagrant window 1
Create the channel configuration transaction:
configtxgen -profile SampleSingleMSPSolo -outputCreateChannelTx channel.tx -channelID <channel-ID>This will generate a channel.tx file in your current directory
Vagrant window 3
Start the peer in "chainless" mode
peer node start --peer-defaultchain=falseNote: Use Vagrant window 1 for the remainder of commands
Create channel
Ask peer to create a channel with the configuration parameters in
channel.tx
peer channel create -o 127.0.0.1:7050 -c mychannel -f channel.txThis will return a channel genesis block - mychannel.block - in your
current directory.
Join channel
Ask peer to join the channel by passing in the channel genesis block:
peer channel join -b mychannel.blockInstall
Install chaincode on the peer:
peer chaincode install -o 127.0.0.1:7050 -n mycc -v 1.0 -p github.com/hyperledger/fabric/examples/chaincode/go/chaincode_example02Make sure the chaincode is in the filesystem:
ls /var/hyperledger/production/chaincodesYou should see mycc.1.0
Instantiate
Instantiate the chaincode:
peer chaincode instantiate -o 127.0.0.1:7050 -C mychannel -n mycc -v 1.0 -p github.com/hyperledger/fabric/examples/chaincode/go/chaincode_example02 -c '{"Args":["init","a", "100", "b","200"]}'Check your active containers:
docker psIf the chaincode container started successfully, you should see:
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
bd9c6bda7560 dev-jdoe-mycc-1.0 "chaincode -peer.a..." 5 seconds ago Up 5 seconds dev-jdoe-mycc-1.0Invoke
Issue an invoke to move "10" from "a" to "b":
peer chaincode invoke -o 127.0.0.1:7050 -C mychannel -n mycc -c '{"Args":["invoke","a","b","10"]}'Wait a few seconds for the operation to complete
Query
Query for the value of "a":
# this should return 90
peer chaincode query -o 127.0.0.1:7050 -C mychannel -n mycc -c '{"Args":["query","a"]}'Don't forget to clear ledger folder /var/hyperledger/ after each
run!
rm -rf /var/hyperledger/*
Troubleshooting
Ensure you clear the file system after each run
If you see docker errors, remove your images and start from scratch.
make clean make peer-docker orderer-docker
If you see the below error:
Error: Error endorsing chaincode: rpc error: code = 2 desc = Error installing chaincode code mycc:1.0(chaincode /var/hyperledger/production/chaincodes/mycc.1.0 exits)
You likely have chaincode images (e.g.
peer0-peer0-mycc-1.0orpeer1-peer0-mycc1-1.0) from prior runs. Remove them and try again.
docker rmi -f $(docker images | grep peer[0-9]-peer[0-9] | awk '{print $3}')To cleanup the network, use the
downoption:./network_setup.sh down