Skip to content

Commit e9c5602

Browse files
[FAB-12223] Adding FAQ file
With master build instructions and inter versions explanations Change-Id: I278d35ec856f2f258d08c0ea51debf0dfb9c8a4b Signed-off-by: gennady <gennady@il.ibm.com> (cherry picked from commit b1710e9)
1 parent af01201 commit e9c5602

File tree

2 files changed

+43
-26
lines changed

2 files changed

+43
-26
lines changed

FAQ.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Frequently Asked Questions - Hyperledger Fabric Shim for Java chaincode
2+
3+
### Q. How to build latest master code?
4+
5+
#### Install prerequisites
6+
7+
Make sure you installed all [fabric prerequisites](https://hyperledger-fabric.readthedocs.io/en/latest/prereqs.html)
8+
9+
Install java shim specific prerequisites:
10+
* Java 8
11+
* gradle 4.4
12+
13+
#### Build shim
14+
15+
Clone the fabric shim for java chaincode repo.
16+
17+
```
18+
git clone https://github.com/hyperledger/fabric-chaincode-java.git
19+
```
20+
21+
Build java shim jars (proto and shim jars) and install them to local maven repository.
22+
```
23+
cd fabric-chaincode-java
24+
gradle clean build install
25+
```
26+
27+
Build javaenv docker image, to have it locally.
28+
```
29+
gradle buildImage
30+
```
31+
32+
#### Update your chaincode dependencies
33+
34+
Make your chanincode depend on java shim master version and not on version from maven central
35+
36+
```
37+
dependencies {
38+
compile group: 'org.hyperledger.fabric-chaincode-java', name: 'fabric-chaincode-shim', version: '1.4.0-SNAPSHOT'
39+
}
40+
```

README.md

Lines changed: 3 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
# Hyperledger Fabric Shim for Java chaincode
22

33
This is a Java based implementation of Hyprledger Fabric chaincode shim APIs, which enables development of chaincodes using Java language.
4-
The following instructions are intended for a contributor or early adopter that needs to
5-
be able to build and test the Java chaincode shim, docker image and protobuf artifacts.
64

75
Application developers interested in developing smart contracts (what we call chaincode) for Hyperledger Fabric should
86
read the tutorial in TUTORIAL.md file and visit
97
`Chaincode for developers <https://hyperledger-fabric.readthedocs.io/en/latest/chaincode4ade.html>`__.
108

9+
Contributors or early adopters who need to be able to build and test recent Java chaincode shim, should reference [FAQ.md](FAQ.md) file.
10+
1111
This project creates `fabric-chaincode-protos` and `fabric-chaincode-shim` jar
1212
files for developers consumption and the `hyperledger/fabric-javaenv` docker image
1313
to run Java chaincode.
@@ -24,27 +24,4 @@ The "fabric-chaincode-docker" folder contains instructions to the build
2424
`hyperledger/fabric-javaenv` docker image.
2525

2626
The "fabric-chaincode-example-gradle" contains an example java chaincode gradle
27-
project that includes sample chaincode and basic gradle build instructions.
28-
29-
## Prerequisites
30-
* Java 8
31-
* gradle 4.4
32-
33-
## Build shim
34-
35-
Clone the fabric shim for java chaincode repo.
36-
37-
```
38-
git clone https://github.com/hyperledger/fabric-chaincode-java.git
39-
```
40-
41-
Build and install java shim jars (proto and shim jars).
42-
```
43-
cd fabric-chaincode-java
44-
gradle clean build install
45-
```
46-
47-
Build javaenv docker image, to have it locally.
48-
```
49-
gradle buildImage
50-
```
27+
project that includes sample chaincode and basic gradle build instructions.

0 commit comments

Comments
 (0)