1 Star 1 Fork 1

hey / blockchain-application-using-fabric-java-sdk

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

Create and Deploy a Blockchain Network using Hyperledger Fabric SDK Java

Blockchain is a shared, immutable ledger for recording the history of transactions. The Linux Foundation’s Hyperledger Fabric, the software implementation of blockchain IBM is committed to, is a permissioned network. Hyperledger Fabric is a platform for distributed ledger solutions underpinned by a modular architecture delivering high degrees of confidentiality, resiliency, flexibility and scalability.

In a Blockchain solution, the Blockchain network works as a back-end with an application front-end to communicate with the network using a SDK. To set up the communication between front-end and back-end, Hyperledger Fabric community offers a number of SDKs for a wide variety of programming languages like the NodeJS SDK and Java SDK. This code pattern explains the methodology to create, deploy and test the blockchain network using Hyperledger Fabric SDK Java.

It would be helpful for the Java developers, who started to look into Hyperledger Fabric platform and would like to use Fabric SDK Java for their projects. The SDK helps facilitate Java applications to manage the lifecycle of Hyperledger channels and user chaincode. The SDK also provides a means to execute user chaincode, query blocks and transactions on the channel, and monitor events on the channel. This code pattern will help to get the process started to build a Hyperledger Fabric v1.1 Java application.

When the reader has completed this pattern, they will understand how to create, deploy and test a blockchain network using Hyperledger Fabric SDK Java. This pattern will provision a Hyperledger Fabric 1.1 network consisting of two organizations, each maintaining two peer node, two certificate authorities (ca) for each organization and a solo ordering service. The following aspects will be demonstrated in this code pattern:

  • Create and initialize channel
  • Install and instantiate chain code
  • Register and enroll the users
  • Perform invoke and query on the blockchain network.

Note: This code pattern builds a Hyperledger Fabric 1.1 network and uses Hyperledger Fabric SDK java 1.0.0 .

Flow

  1. Generate the artifacts using cryptogen and configtx for peers and channel in network. Currently these are already generated and provided in the code repository to use as-is.
  2. Build the network using docker-compose and the generated artifacts.
  3. Use Hyperledger Fabric Java SDK APIs to work with and manage the network.
    • Create and initialize the channel
    • Install and instantiate the chaincode
    • Register and enroll the users
    • Perform invoke and query to test the network

Included Components

  • Hyperledger Fabric: Hyperledger Fabric is a platform for distributed ledger solutions underpinned by a modular architecture delivering high degrees of confidentiality, resiliency, flexibility and scalability.

  • Docker: Docker is an open platform for developers and sysadmins to build, ship, and run distributed applications.

  • Hyperledger Fabric Java SDK

Featured Technologies

  • Blockchain: A blockchain is a digitized, decentralized, public ledger of all transactions in a network.

  • Java: Java is a general-purpose computer-programming language that is concurrent, class-based and object-oriented.

Watch the Video

]

Pre-requisites

  • Docker - v1.13 or higher
  • Docker Compose - v1.8 or higher
  • Git Client - needed for clone commands
  • Maven - needed to build the client. Maven is a build automation tool used primarily for Java projects. Maven addresses two aspects of building software: first, it describes how software is built, and second, it describes its dependencies.

Steps

Follow these steps to setup and run this code pattern.

  1. Setup the Blockchain Network
  2. Build the client based on Fabric Java SDK
  3. Create and Initialize the channel
  4. Deploy and Instantiate the chaincode
  5. Register and enroll users
  6. Perform Invoke and Query on network

1. Setup the Blockchain Network

Clone this repo using the following command.

$ git clone https://github.com/IBM/blockchain-application-using-fabric-java-sdk.git

To build the blockchain network, the first step is to generate artifacts for peers and channels using cryptogen and configtx. The utilities used and steps to generate artifacts are explained here. In this pattern all required artifacts for the peers and channel of the network are already generated and provided to use as-is. Artifacts can be located at:

network_resources/crypto-config
network_resources/config

The automated scripts to build the network are provided under network directory. The network/docker-compose.yaml file defines the blockchain network topology. This pattern provisions a Hyperledger Fabric 1.1 network consisting of two organizations, each maintaining two peer node, two certificate authorities for each organization and a solo ordering service. Need to run the script as follows to build the network.

Note: Please clean up the old docker images (if any) from your environment otherwise you may get errors while setting up network.

cd network
chmod +x build.sh
./build.sh

To stop the running network, run the following script.

cd network
chmod +x stop.sh
./stop.sh

To delete the network completely, following script need to execute.

cd network
chmod +x teardown.sh
./teardown.sh

2. Build the client based on Fabric Java SDK

The previous step creates all required docker images with the appropriate configuration.

Java Client

  • The java client sources are present in the folder java of the repo.
  • Check your environment before executing the next step. Make sure, you are able to run mvn commands properly.

    If mvn commands fails, please refer to Pre-requisites to install maven.

To work with the deployed network using Hyperledger Fabric SDK java 1.0.0, perform the following steps.

  • Open a command terminal and navigate to the java directory in the repo. Run the command mvn install.

    cd ../java
    mvn install
  • A jar file blockchain-java-sdk-0.0.1-SNAPSHOT-jar-with-dependencies.jar is built and can be found under the target folder. This jar can be renamed to blockchain-client.jar to keep the name short.

    cd target
    cp blockchain-java-sdk-0.0.1-SNAPSHOT-jar-with-dependencies.jar blockchain-client.jar
  • Copy this built jar into network_resources directory. This is required as the java code can access required artifacts during execution.

    cp blockchain-client.jar ../../network_resources

3. Create and Initialize the channel

In this code pattern, we create one channel mychannel which is joined by all four peers. The java source code can be seen at src/main/java/org/app/network/CreateChannel.java. To create and initialize the channel, run the following command.

cd ../../network_resources
java -cp blockchain-client.jar org.app.network.CreateChannel

Output:

   INFO: Deleting - users
   Apr 20, 2018 5:11:45 PM org.app.network.CreateChannel main
   INFO: Channel created mychannel
   Apr 20, 2018 5:11:45 PM org.app.network.CreateChannel main
   INFO: peer0.org1.example.com at grpc://localhost:7051
   Apr 20, 2018 5:11:45 PM org.app.network.CreateChannel main
   INFO: peer1.org1.example.com at grpc://localhost:7056
   Apr 20, 2018 5:11:45 PM org.app.network.CreateChannel main
   INFO: peer0.org2.example.com at grpc://localhost:8051
   Apr 20, 2018 5:11:45 PM org.app.network.CreateChannel main
   INFO: peer1.org2.example.com at grpc://localhost:8056

4. Deploy and Instantiate the chaincode

This code pattern uses a sample chaincode fabcar to demo the usage of Hyperledger Fabric SDK Java APIs. To deploy and instantiate the chaincode, execute the following command.

java -cp blockchain-client.jar org.app.network.DeployInstantiateChaincode

Output:

   INFO: Deploying chaincode fabcar using Fabric client Org1MSP admin
   Apr 23, 2018 10:25:22 AM org.app.network.DeployInstantiateChaincode main
   INFO: fabcar- Chain code deployment SUCCESS
   Apr 23, 2018 10:25:22 AM org.app.network.DeployInstantiateChaincode main
   INFO: fabcar- Chain code deployment SUCCESS
   Apr 23, 2018 10:25:22 AM org.app.client.FabricClient deployChainCode
   INFO: Deploying chaincode fabcar using Fabric client Org2MSP admin
   Apr 23, 2018 10:25:22 AM org.app.network.DeployInstantiateChaincode main
   INFO: fabcar- Chain code deployment SUCCESS
   Apr 23, 2018 10:25:22 AM org.app.network.DeployInstantiateChaincode main
   INFO: fabcar- Chain code deployment SUCCESS
   Apr 23, 2018 10:25:22 AM org.app.client.ChannelClient instantiateChainCode
   INFO: Instantiate proposal request fabcar on channel mychannel with Fabric client Org2MSP admin
   Apr 23, 2018 10:25:22 AM org.app.client.ChannelClient instantiateChainCode
   INFO: Instantiating Chaincode ID fabcar on channel mychannel
   Apr 23, 2018 10:25:25 AM org.app.client.ChannelClient instantiateChainCode
   INFO: Chaincode fabcar on channel mychannel instantiation java.util.concurrent.CompletableFuture@723ca036[Not completed]
   Apr 23, 2018 10:25:25 AM org.app.network.DeployInstantiateChaincode main
   INFO: fabcar- Chain code instantiation SUCCESS
   Apr 23, 2018 10:25:25 AM org.app.network.DeployInstantiateChaincode main
   INFO: fabcar- Chain code instantiation SUCCESS
   Apr 23, 2018 10:25:25 AM org.app.network.DeployInstantiateChaincode main
   INFO: fabcar- Chain code instantiation SUCCESS
   Apr 23, 2018 10:25:25 AM org.app.network.DeployInstantiateChaincode main
   INFO: fabcar- Chain code instantiation SUCCESS

Note: The chaincode fabcar.go was taken from the fabric samples available at - https://github.com/hyperledger/fabric-samples/tree/release-1.1/chaincode/fabcar/go.

5. Register and enroll users

A new user can be registered and enrolled to an MSP. Execute the below command to register a new user and enroll to Org1MSP.

java -cp blockchain-client.jar org.app.user.RegisterEnrollUser

Output:

   INFO: Deleting - users
   log4j:WARN No appenders could be found for logger (org.hyperledger.fabric.sdk.helper.Config).
   log4j:WARN Please initialize the log4j system properly.
   log4j:WARN See http://logging.apache.org/log4j/1.2/faq.html#noconfig for more info.
   Apr 23, 2018 10:26:35 AM org.app.client.CAClient enrollAdminUser
   INFO: CA -http://localhost:7054 Enrolled Admin.
   Apr 23, 2018 10:26:35 AM org.app.client.CAClient registerUser
   INFO: CA -http://localhost:7054 Registered User - user1524459395783
   Apr 23, 2018 10:26:36 AM org.app.client.CAClient enrollUser
   INFO: CA -http://localhost:7054 Enrolled User - user1524459395783

6. Perform Invoke and Query on network

Blockchain network has been setup completely and is ready to use. Now we can test the network by performing invoke and query on the network. The fabcar chaincode allows us to create a new asset which is a car. For test purpose, invoke operation is performed to create a new asset in the network and query operation is performed to list the asset of the network. Perform the following steps to check the same.

java -cp blockchain-client.jar org.app.chaincode.invocation.InvokeChaincode

Output:

  INFO: CA -http://localhost:7054 Enrolled Admin.
  Apr 20, 2018 5:13:04 PM org.app.client.ChannelClient sendTransactionProposal
  INFO: Sending transaction proposal on channel mychannel
  Apr 20, 2018 5:13:04 PM org.app.client.ChannelClient sendTransactionProposal
  INFO: Transaction proposal on channel mychannel OK SUCCESS with transaction       
  id:a298b9e27bdb0b6ca18b19f9c78a5371fb4d9b8dd199927baf37379537ca0d0f
  Apr 20, 2018 5:13:04 PM org.app.client.ChannelClient sendTransactionProposal
  INFO: 
  Apr 20, 2018 5:13:04 PM org.app.client.ChannelClient sendTransactionProposal
  INFO: java.util.concurrent.CompletableFuture@22f31dec[Not completed]
  Apr 20, 2018 5:13:04 PM org.app.chaincode.invocation.InvokeChaincode main
  INFO: Invoked createCar on fabcar. Status - SUCCESS
java -cp blockchain-client.jar org.app.chaincode.invocation.QueryChaincode

Output:

    Apr 20, 2018 5:13:28 PM org.app.client.CAClient enrollAdminUser
    INFO: CA -http://localhost:7054 Enrolled Admin.
    Apr 20, 2018 5:13:29 PM org.app.chaincode.invocation.QueryChaincode main
    INFO: Querying for all cars ...
    Apr 20, 2018 5:13:29 PM org.app.client.ChannelClient queryByChainCode
    INFO: Querying queryAllCars on channel mychannel
    Apr 20, 2018 5:13:29 PM org.app.chaincode.invocation.QueryChaincode main
    INFO: [{"Key":"CAR1", "Record":{"make":"Chevy","model":"Volt","colour":"Red","owner":"Nick"}}]
    Apr 20, 2018 5:13:39 PM org.app.chaincode.invocation.QueryChaincode main
    INFO: Querying for a car - CAR1
    Apr 20, 2018 5:13:39 PM org.app.client.ChannelClient queryByChainCode
    INFO: Querying queryCar on channel mychannel
    Apr 20, 2018 5:13:39 PM org.app.chaincode.invocation.QueryChaincode main
    INFO: {"make":"Chevy","model":"Volt","colour":"Red","owner":"Nick"}
   

Troubleshooting

See DEBUGGING.md.

License

Apache 2.0

Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

区块链java SDK 展开 收起
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
1
https://gitee.com/LZKH/blockchain-application-using-fabric-java-sdk.git
git@gitee.com:LZKH/blockchain-application-using-fabric-java-sdk.git
LZKH
blockchain-application-using-fabric-java-sdk
blockchain-application-using-fabric-java-sdk
master

搜索帮助