Skip to content
This repository was archived by the owner on Apr 22, 2025. It is now read-only.

Commit 3835d9f

Browse files
kashyap-prabhatcr22rc
authored andcommitted
[FAB-4628]: Documentation updates
Fixed typographical mistakes in README.md Change-Id: If1f5c7b95e855857d636f722668e9c9cfa6fd78e Signed-off-by: Prabhat Kashyap <prabhatkashyap33@gmail.com>
1 parent 6382c27 commit 3835d9f

File tree

1 file changed

+13
-14
lines changed

1 file changed

+13
-14
lines changed

README.md

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@ Welcome to Java SDK for Hyperledger project. The SDK helps facilitate Java appli
44
user chaincode, query blocks
55
and transactions on the channel, and monitor events on the channel.
66

7-
THe SDK acts on behave of a particular User which is defined by the embedding application through the implementation
7+
The SDK acts on behave of a particular User which is defined by the embedding application through the implementation
88
of the SDK's `User` interface.
99

1010
Note, the SDK does ***not*** provide a means of persistence
1111
for the application defined channels and user artifacts on the client. This is left for the embedding application to best manage.
1212

1313
The SDK also provides a client for Hyperledger's certificate authority. The SDK is however not dependent on this
14-
particular implementation of a certificate authority. Other Certificate authority's maybe use by implementing the
14+
particular implementation of a certificate authority. Other Certificate authority's maybe used by implementing the
1515
SDK's `Enrollment` interface.
1616

1717
This provides a summary of steps required to get you started with building and using the Java SDK.
@@ -49,7 +49,7 @@ The SDK is published to Maven so you can directly use in your application's pom.
4949

5050
[Maven Repository Hyperledger Fabric Java SDK](https://mvnrepository.com/artifact/org.hyperledger.fabric-sdk-java/fabric-sdk-java)
5151

52-
_Make sure you're using docker images at the level of the Fabric that matches with the level of the SDK you're using in your application._
52+
_Make sure you're using docker images at the level of the Fabric that matches the level of the SDK you're using in your application._
5353

5454
<p &nbsp; />
5555
<p &nbsp; />
@@ -74,7 +74,7 @@ You should use the following commit levels of the Hyperledger projects:
7474

7575
You can clone these projects by going to the [Hyperledger repository](https://gerrit.hyperledger.org/r/#/admin/projects/).
7676

77-
As SDK developement continues, this file will be updated with compatible Hyperledger Fabric and Fabric-ca commit levels.
77+
As SDK development continues, this file will be updated with compatible Hyperledger Fabric and Fabric-ca commit levels.
7878

7979
Once you have cloned `fabric` and `fabric-ca`, use the `git reset --hard commitlevel` to set your repositories to the correct commit.
8080

@@ -142,7 +142,7 @@ Alternatively, <code> mvn dependency:analyze-report </code> will produce a repor
142142
The SDK's test cases uses chaincode in the SDK's source tree: `/src/test/fixture`
143143

144144
The SDK's JAR is in `target/fabric-sdk-java-1.0.0-SNAPSHOT.jar` and you will need the additional dependencies listed above.
145-
When the SDK is published to `Maven` you will be able to simply include it in a your application's `pom.xml`.
145+
When the SDK is published to `Maven` you will be able to simply include it in your application's `pom.xml`.
146146

147147
Add below code in your `pom.xml` to download fabric-sdk-java-1.0.0-SNAPSHOT
148148

@@ -189,7 +189,7 @@ To run the unit tests, please use <code>mvn test</code> or <code>mvn install</co
189189
You must be running a local peer and orderer to be able to run the unit tests.
190190

191191
### Running the integration tests
192-
You must be running local instances of Fabric-ca, Fabric peers and Fabric orderers to be able to run the integration tests. See above for running these services in Vagrant.
192+
You must be running local instances of Fabric-ca, Fabric peers, and Fabric orderers to be able to run the integration tests. See above for running these services in Vagrant.
193193
Use this `maven` command to run the integration tests:
194194
* _mvn failsafe:integration-test -DskipITs=false_
195195

@@ -216,7 +216,7 @@ In the directory src/test/fixture/sdkintegration/e2e-2Orgs/channel
216216

217217
```build/bin/cryptogen generate --config crypto-config.yaml --output=crypto-config```
218218

219-
For ease of assigning ports and mapping of artifacts to physical files, all peers, orderers and fabric-ca are run as Docker containers controlled via a docker-compose configuration file.
219+
For ease of assigning ports and mapping of artifacts to physical files, all peers, orderers, and fabric-ca are run as Docker containers controlled via a docker-compose configuration file.
220220

221221
The files used by the end to end are:
222222
* _src/test/fixture/sdkintegration/e2e-2Orgs/channel_ (everything needed to bootstrap the orderer and create the channels)
@@ -237,10 +237,10 @@ We need certificate and key for each of the Orderer and Peers for TLS connection
237237
* sign the csr with the CA private key to generate a certificate: <code>openssl ca -days 365 -in csr.pem -keyfile {CA's privatekey} -notext -out cert.pem</code>
238238
* put the resulting cert.pem and key.pem together with the CA's certificate (as the name cacert.pem) in the directory where the docker container can access.
239239

240-
The option -notext in the last openssl command in the above is important. Without the option, the resulting cert.pemmay not work for some Java implementation (e.g. IBM JDK).
240+
The option -notext in the last openssl command in the above is important. Without the option, the resulting cert.pemmay does not work for some Java implementation (e.g. IBM JDK).
241241
The certificates and keys for the end-to-end test case are stored in the directory _src/test/fixture/sdkintegration/e2e-2Org/tls/_.
242242

243-
Currently, the pom.xml is set to use netty-tcnative-boringssl for TLS connection to Orderer and Peers, however you can change the pom.xml (uncomment a few lines) to use an alternative TLS connection via ALPN.
243+
Currently, the pom.xml is set to use netty-tcnative-boringssl for TLS connection to Orderer and Peers, however, you can change the pom.xml (uncomment a few lines) to use an alternative TLS connection via ALPN.
244244

245245
### Chaincode endorsement policies
246246
Policies are described in the [Fabric Endorsement Policies document](https://gerrit.hyperledger.org/r/gitweb?p=fabric.git;a=blob;f=docs/endorsement-policies.md;h=1eecf359c12c3f7c1ddc63759a0b5f3141b07f13;hb=HEAD).
@@ -254,13 +254,13 @@ For testing purposes, there are 2 policy files in the _src/test/resources_ direc
254254
* _policyBitsAdmin_ ( which has policy **AND(DEFAULT.admin)** meaning _1 signature from the DEFAULT MSP admin' is required_ )
255255
* _policyBitsMember_ ( which has policy **AND(DEFAULT.member)** meaning _1 signature from a member of the DEFAULT MSP is required_ )
256256

257-
and one file in th _src/test/fixture/sdkintegration/e2e-2Orgs/channel_ directory specifically for use in the end to end test scenario
257+
and one file in the _src/test/fixture/sdkintegration/e2e-2Orgs/channel_ directory specifically for use in the end to end test scenario
258258
* _members_from_org1_or_2.policy_ ( which has policy **OR(peerOrg1.member, peerOrg2.member)** meaning _1 signature from a member of either organizations peerOrg1, PeerOrg2 is required_)
259259

260-
Alternatively you can also use ChaincodeEndorsementPolicy class by giving it a YAML file that has the policy defined in it.
260+
Alternatively, you can also use ChaincodeEndorsementPolicy class by giving it a YAML file that has the policy defined in it.
261261
See examples of this in the End2endIT testcases that use _src/test/fixture/sdkintegration/chaincodeendorsementpolicy.yaml_
262262
The file chaincodeendorsementpolicy.yaml has comments that help understand how to create these policies. The first section
263-
lists all the signature identities you can use in the policy. Currently only ROLE types are supported.
263+
lists all the signature identities you can use in the policy. Currently, only ROLE types are supported.
264264
The policy section is comprised of `n-of` and `signed-by` elements. Then n-of (`1-of` `2-of`) require that many (`n`) in that
265265
section to be true. The `signed-by` references an identity in the identities section.
266266

@@ -301,7 +301,7 @@ Keep in mind that you can perform the enrollment process with the membership ser
301301

302302
To address this, remove any stored crypto material from the CA server by following the instructions <a href="https://github.com/hyperledger/fabric/blob/master/docs/Setup/Chaincode-setup.md#removing-temporary-files-when-security-is-enabled">here</a> which typically involves deleting the /var/hyperledger/production directory and restarting the membership services. You will also need to remove any of the crypto tokens stored on the client side by deleting the KeyValStore . That KeyValStore is configurable and is set to ${FSUser.home}/test.properties within the unit tests.
303303

304-
When running the unit tests, you will always need to clean the membership services database, and delete the KeyValStore file, otherwise the unit tests will fail.
304+
When running the unit tests, you will always need to clean the membership services database and delete the KeyValStore file, otherwise, the unit tests will fail.
305305

306306
**java.security.InvalidKeyException: Illegal key size**
307307

@@ -354,4 +354,3 @@ Upload full logs to the JIRA not just where the issue occurred if possible
354354

355355

356356
<a rel="license" href="http://creativecommons.org/licenses/by/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by/4.0/88x31.png" /></a><br />This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by/4.0/">Creative Commons Attribution 4.0 International License</a>.
357-
s

0 commit comments

Comments
 (0)