The openblockchain project is IBM's proposed contribution to the Linux Foundation's Hyperledger project. We have made it available as open source to enable others to explore our architecture and design. IBM's intention is to engage rigorously in the Linux Foundation's Hyperledger project as the community establishes itself, and decides on a code base. Once established, we will transition our development focus to the Hyperledger effort, and this code will be maintained as needed for IBM's use.
While we invite contribution to the openblockchain project, we believe that the broader blockchain community's focus should be the Hyperledger project.
This project contains the core blockchain fabric.
Assuming you have followed the development environment getting started instructions
To access your VM, run
vagrant ssh
From within the VM, follow these additional steps.
cd $GOPATH/src/github.com/openblockchain/obc-peer
go build
To see what commands are available, simply execute the following command:
cd $GOPATH/src/github.com/openblockchain/obc-peer
./obc-peer
You should see some output similar to below (NOTE: rootcommand below is hardcoded in the main.go. Current build will actually create an obc-peer executable file).
Usage:
obc-peer [command]
Available Commands:
peer Run obc peer.
status Status of the obc peer.
stop Stops the obc peer.
chaincode Compiles the specified chaincode.
help Help about any command
Flags:
-h, --help[=false]: help for openchain
Use "obc-peer [command] --help" for more information about a command.
The peer command will run peer process. You can then use the other commands to interact with this peer process. For example, status will show the peer status.
To run all unit tests, in one window, run ./obc-peer peer. In a second window
cd $GOPATH/src/github.com/openblockchain/obc-peer
go test -timeout=20m $(go list github.com/openblockchain/obc-peer/... | grep -v /vendor/ | grep -v /examples/)
Note that the first time the tests are run, they can take some time due to the need to download a docker image that is about 1GB in size. This is why the timeout flag is added to the above command.
To run a specific test use the -run RE flag where RE is a regular expression that matches the test name. To run tests with verbose output use the -v flag. For example, to run TestGetFoo function, change to the directory containing the foo_test.go and enter:
go test -test.v -run=TestGetFoo
OBC also has Behave tests that will setup networks of peers with different security and consensus configurations and verify that transactions run properly. To run these tests
cd $GOPATH/src/github.com/openblockchain/obc-peer/openchain/peer/bddtests
behave
Some of the Behave tests run inside Docker containers. If a test fails and you want to have the logs from the Docker containers, run the tests with this option
behave -D logs=Y
Note, you must run the unit tests first to build the necessary Peer and OBCCA docker images. These images can also be individually built using the commands
go test github.com/openblockchain/obc-peer/openchain/container -run=BuildImage_Peer
go test github.com/openblockchain/obc-peer/openchain/container -run=BuildImage_Obcca
Since chaincode is written in Go language, you can set up the environment to accommodate the rapid edit-compile-run of your chaincode. Follow the instructions on the Sandbox Setup page, which allows you to run your chaincode off the blockchain.
To set up an Openchain network of several validating peers, follow the instructions on the Devnet Setup page. This network leverage Docker to manage multiple instances of validating peer on the same machine, allowing you to quickly test your chaincode.
When you are ready to start interacting with the Openchain peer node through the available APIs and packages, follow the instructions on the API Documentation page.
Configuration utilizes the viper and cobra libraries.
There is an openchain.yaml file that contains the configuration for the peer process. Many of the configuration settings can be overridden at the command line by setting ENV variables that match the configuration setting, but by prefixing the tree with 'OPENCHAIN_'. For example, logging level manipulation through the environment is shown below:
OPENCHAIN_PEER_LOGGING_LEVEL=CRITICAL ./obc-peer
Logging utilizes the go-logging library.
The available log levels in order of increasing verbosity are: CRITICAL | ERROR | WARNING | NOTICE | INFO | DEBUG
See [specific logging control] (https://github.com/openblockchain/obc-docs/blob/master/dev-setup/logging-control.md) when running OBC.
If you modify any .proto files, run the following command to generate new .pb.go files.
/openchain/obc-dev-env/compile_protos.sh
Openchain uses Go 1.6 vendoring for package management. This means that all required packages reside in the /vendor folder within the obc-peer project. Go will use packages in this folder instead of the GOPATH when go install or go build is run. To manage the packages in the /vendor folder, we use Govendor. This is installed in the Vagrant environment. The following commands can be used for package management.
# Add external packages.
govendor add +external
# Add a specific package.
govendor add github.com/kardianos/osext
# Update vendor packages.
govendor update +vendor
# Revert back to normal GOPATH packages.
govendor remove +vendor
# List package.
govendor list
This is not recommended, however some users may wish to build Openchain outside of Vagrant if they use an editor with built in Go tooling. The instructions are
- Follow all steps required to setup and run a Vagrant image
- Make you you have Go 1.6 or later installed
- Set the maximum number of open files to 10000 or greater for your OS
- Install RocksDB version 4.1
- Run the following commands replacing
/opt/rocksdbwith the path where you installed RocksDB:
cd $GOPATH/src/github.com/openblockchain/obc-peer
CGO_CFLAGS="-I/opt/rocksdb/include" CGO_LDFLAGS="-L/opt/rocksdb -lrocksdb -lstdc++ -lm -lz -lbz2 -lsnappy" go install
- Make sure that the Docker daemon initialization includes the options
-H tcp://0.0.0.0:4243 -H unix:///var/run/docker.sock
- Be aware that the Docker bridge (the
OPENCHAIN_VM_ENDPOINT) may not come up at the IP address currently assumed by the test environment (172.17.0.1). Useifconfigorip addrto find the docker bridge.