GitHub - hyperledger/fabric-sdk-go: Read-only mirror of https://gerrit.hyperledg...
source link: https://github.com/hyperledger/fabric-sdk-go
Go to the source link to view the article. You can view the picture content, updated content and better typesetting reading experience. If the link is broken, please click the button below to view the snapshot at that time.
README.md
Hyperledger Fabric Client SDK for Go
This SDK enables Go developers to build solutions that interact with Hyperledger Fabric.
Getting started
Obtain the client SDK packages for Fabric and Fabric CA.
go get github.com/hyperledger/fabric-sdk-go
You're good to go, happy coding! Check out the examples for usage demonstrations.
Examples
- E2E Test: Basic example that uses SDK to query and execute transaction
- Ledger Query Test: Basic example that uses SDK to query a channel's underlying ledger
- Multi Org Test: An example that has multiple organisations involved in transaction
- Dynamic Endorser Selection: An example that uses dynamic endorser selection (based on chaincode policy)
- E2E PKCS11 Test: E2E Test using a PKCS11 crypto suite and configuration
- CLI: An example CLI for Fabric built with the Go SDK.
- More examples needed!
Community
- Discussion is happening in Rocket Chat.
- Issue tracking is handled in Jira.
- Active development occurs in the Gerrit repository.
Client SDK
Current Compatibility
The SDK's integration tests run against three tagged Fabric versions:
- prev (currently v1.3.0)
- stable (currently v1.4.2)
- prerelease (currently disabled)
Additionally for development purposes integration tests also run against the devstable Fabric version as needed.
Retired versions
When the 'prev' code level is updated, the last tested fabric-sdk-go commit or tag is listed below.
- fabric v1.2: 5e291d3
- fabric v1.1: f7ae259
- fabric v1.0: 5ac5226
Auth Token payload compatibility between Fabric CA v1.4 and earlier releases
Fabric CA v1.4 introduced a more secure Auth Token payload signing which requires a non compatible update. In order to maintain compatibility with Fabric CA v1.3, the CA client queries the server to fetch the version and determine if compatibility with pre v1.4 is required.
Once v1.3 is retired, the above client code logic will need to be removed as well. No change is required from the Go SDK users.
Running the test suite
Obtain the client SDK packages for Fabric and Fabric CA.
git clone https://github.com/hyperledger/fabric-sdk-go.git # Alternatively, you should clone from gerrit to contribute. For example: # git clone ssh://<username>@gerrit.hyperledger.org:29418/fabric-sdk-go && scp -p -P 29418 <username>@gerrit.hyperledger.org:hooks/commit-msg fabric-sdk-go/.git/hooks/ # # See https://gerrit.hyperledger.org/
# In the Fabric SDK Go directory cd fabric-sdk-go/ # Optional - Automatically install Go tools used by test suite # make depend # Running test suite make # Clean test suite run artifacts make clean
Go Tags
The following Go tags can be supplied to enable additional functionality:
- experimental: includes support for experimental features.
Contributing to the Go SDK
If you want to contribute to the Go SDK, please run the test suite and submit patches to the Gerrit git repostory for review. For general guidelines, please refer to the Fabric project's contribution page.
You need:
- Go 1.12
- Make
- Docker
- Docker Compose
- Git
- gobin (GO111MODULE=off go get -u github.com/myitcv/gobin)
- libtool
Notes:
- Dep is deprecated and replaced with Go modules.
Gerrit Git repository
To contribute patches, you will need to clone (or add a remote) from Gerrit with authentication.
Running a portion of the test suite
# In the Fabric SDK Go directory cd fabric-sdk-go/ # Optional - Automatically install Go tools used by test suite # make depend # Optional - Running only code checks (linters, license, spelling, etc) # make checks # Running all unit tests and checks make unit-test # Running all integration tests make integration-test
Running package unit tests manually
# In a package directory go test
Running integration tests manually
You need:
- A working fabric and fabric-ca set up. It is recommended that you use the docker-compose file provided in
test/fixtures/dockerenv
. It is also recommended that you use the default .env settings provided intest/fixtures/dockerenv
. See steps below. - Customized settings in the
test/fixtures/config/config_test.yaml
in case your Hyperledger Fabric network is not running onlocalhost
or is using different ports.
Testing with Fabric Images at Docker Hub
The test suite defaults to the latest compatible tag of fabric images at Docker Hub. The following commands starts Fabric:
# In the Fabric SDK Go directory cd fabric-sdk-go # Start fabric (stable tag) make dockerenv-stable-up # Or more generally, start fabric at a different code level (prev, stable, prerelease, devstable) # make dockerenv-[CODELEVEL]-up
Running Integration Tests
Fabric should now be running. In a different shell, run integration tests
# In the Fabric SDK Go directory cd fabric-sdk-go # Use script to setup parameters for integration tests and execute them # Previously we use to have hostnames like Fabric CA server, orderer and peer pointed to localhost # Now since we removed this now, We will be using a different configuration make integration-tests-local # Or more generally, run integration tests at a different code level (prev, stable, prerelease, devstable) # and fixture target version # FABRIC_CODELEVEL_VER=[VER] FABRIC_CODELEVEL_TAG=[CODELEVEL] make integration-tests-local
# Previously we use to have hostnames like Fabric CA server, orderer and peer pointed to localhost # Now since we removed this now, We will be using a different config file config_test_local.yaml # which has the Fabric CA server, orderer and peers pointed to localhost # It is also possible to run integration tests using go test directly. For example: #cd fabric-sdk-go/test/integration/ #go test -args testLocal=true #cd fabric-sdk-go/test/integration/orgs #go test -args testLocal=true # You should review test/scripts/integration.sh for options and details. # Note: you should generally prefer the scripted version to setup parameters for you.
Testing with Local Build of Fabric (Advanced)
Alternatively you can use a local build of Fabric using the following commands:
# Start fabric (devstable codelevel with latest docker tags)
make dockerenv-latest-up
License
Hyperledger Fabric SDK Go software is licensed under the Apache License Version 2.0.
This document is licensed under a Creative Commons Attribution 4.0 International License.
Recommend
About Joyk
Aggregate valuable and interesting links.
Joyk means Joy of geeK