README
¶
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.
Documentation
SDK documentation can be viewed at GoDoc.
The packages intended for end developer usage are within the pkg/client folder along with the main SDK package (pkg/fabsdk).
If you wish to use the Fabric 'Gateway' programming model, then the API is in the pkg/gateway folder.
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.
Client SDK
Current Compatibility
The SDK's integration tests run against three tagged Fabric versions:
- prev (currently v1.4.7)
- stable (currently v2.2.0)
- 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.3: ac70276
- fabric v1.2: 5e291d3
- fabric v1.1: f7ae259
- fabric v1.0: 5ac5226
Running the test suite
Obtain the client SDK packages for Fabric and Fabric CA.
git clone https://github.com/hyperledger/fabric-sdk-go.git
# 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 for review. For general guidelines, please refer to the Fabric project's contribution page.
You need:
- Go 1.14
- Make
- Docker
- Docker Compose
- Git
- gobin (GO111MODULE=off go get -u github.com/myitcv/gobin)
- libtool
Notes:
- Dependencies are handled using Go modules.
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.yamlin case your Hyperledger Fabric network is not running onlocalhostor 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.
Documentation
¶
Overview ¶
Package fabricsdk enables Go developers to build solutions that interact with Hyperledger Fabric.
Packages for end developer usage ¶
pkg/fabsdk: The main package of the Fabric SDK. This package enables creation of contexts based on configuration. These contexts are used by the client packages listed below. Reference: https://godoc.org/github.com/tw-bc-group/fabric-sdk-go-gm/pkg/fabsdk
pkg/client/channel: Provides channel transaction capabilities. Reference: https://godoc.org/github.com/tw-bc-group/fabric-sdk-go-gm/pkg/client/channel
pkg/client/event: Provides channel event capabilities. Reference: https://godoc.org/github.com/tw-bc-group/fabric-sdk-go-gm/pkg/client/event
pkg/client/ledger: Enables queries to a channel's underlying ledger. Reference: https://godoc.org/github.com/tw-bc-group/fabric-sdk-go-gm/pkg/client/ledger
pkg/client/resmgmt: Provides resource management capabilities such as installing chaincode. Reference: https://godoc.org/github.com/tw-bc-group/fabric-sdk-go-gm/pkg/client/resmgmt
pkg/client/msp: Enables identity management capability. Reference: https://godoc.org/github.com/tw-bc-group/fabric-sdk-go-gm/pkg/client/msp
Basic workflow
- Instantiate a fabsdk instance using a configuration. Note: fabsdk maintains caches so you should minimize instances of fabsdk itself.
- Create a context based on a user and organization, using your fabsdk instance. Note: A channel context additionally requires the channel ID.
- Create a client instance using its New func, passing the context. Note: you create a new client instance for each context you need.
- Use the funcs provided by each client to create your solution!
- Call fabsdk.Close() to release resources and caches.
Support for Hyperledger Fabric programming model ¶
In order to support the 'Gateway' programming model, the following package is provided:
pkg/gateway: Enables Go developers to build client applications using the Hyperledger Fabric programming model as described in the 'Developing Applications' chapter of the Fabric documentation. Reference: https://godoc.org/github.com/tw-bc-group/fabric-sdk-go-gm/pkg/gateway
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
internal
|
|
|
pkg
|
|
|
client/channel
Package channel enables access to a channel on a Fabric network.
|
Package channel enables access to a channel on a Fabric network. |
|
client/channel/invoke
Package invoke provides the handlers for performing chaincode invocations.
|
Package invoke provides the handlers for performing chaincode invocations. |
|
client/common/filter
Package filter provides common filters (e.g.
|
Package filter provides common filters (e.g. |
|
client/common/verifier
Package verifier provides various verifier (e.g.
|
Package verifier provides various verifier (e.g. |
|
client/event
Package event enables access to a channel events on a Fabric network.
|
Package event enables access to a channel events on a Fabric network. |
|
client/ledger
Package ledger enables ledger queries on specified channel on a Fabric network.
|
Package ledger enables ledger queries on specified channel on a Fabric network. |
|
client/msp
Package msp enables creation and update of users on a Fabric network.
|
Package msp enables creation and update of users on a Fabric network. |
|
client/resmgmt
Code generated by counterfeiter.
|
Code generated by counterfeiter. |
|
common/errors/multi
Package multi is an error type that holds multiple errors.
|
Package multi is an error type that holds multiple errors. |
|
common/errors/retry
Package retry provides retransmission capabilities to fabric-sdk-go.
|
Package retry provides retransmission capabilities to fabric-sdk-go. |
|
common/errors/status
Package status defines metadata for errors returned by fabric-sdk-go.
|
Package status defines metadata for errors returned by fabric-sdk-go. |
|
common/logging
Package logging enables setting custom logger implementation.
|
Package logging enables setting custom logger implementation. |
|
common/providers/test/mockcontext
Package mockcontext is a generated GoMock package.
|
Package mockcontext is a generated GoMock package. |
|
common/providers/test/mockcore
Package mockcore is a generated GoMock package.
|
Package mockcore is a generated GoMock package. |
|
common/providers/test/mockfab
Package mockfab is a generated GoMock package.
|
Package mockfab is a generated GoMock package. |
|
common/providers/test/mockmsp
Package mockmsp is a generated GoMock package.
|
Package mockmsp is a generated GoMock package. |
|
fab/resource
Package resource provides access to fabric network resource management, typically using system channel queries.
|
Package resource provides access to fabric network resource management, typically using system channel queries. |
|
fab/txn
Package txn enables creating, endorsing and sending transactions to Fabric peers and orderers.
|
Package txn enables creating, endorsing and sending transactions to Fabric peers and orderers. |
|
fabsdk
Package fabsdk enables client usage of a Hyperledger Fabric network.
|
Package fabsdk enables client usage of a Hyperledger Fabric network. |
|
fabsdk/test/mocksdkapi
Package mocksdkapi is a generated GoMock package.
|
Package mocksdkapi is a generated GoMock package. |
|
gateway
Package gateway enables Go developers to build client applications using the Hyperledger Fabric programming model as described in the 'Developing Applications' chapter of the Fabric documentation: https://hyperledger-fabric.readthedocs.io/en/master/developapps/developing_applications.html A Gateway object is created using the Connect() function to connect to a 'gateway' peer as specified in a network configuration file, using an identity stored in a wallet.
|
Package gateway enables Go developers to build client applications using the Hyperledger Fabric programming model as described in the 'Developing Applications' chapter of the Fabric documentation: https://hyperledger-fabric.readthedocs.io/en/master/developapps/developing_applications.html A Gateway object is created using the Connect() function to connect to a 'gateway' peer as specified in a network configuration file, using an identity stored in a wallet. |
|
msp/test/mockmspapi
Package mockmspapi is a generated GoMock package.
|
Package mockmspapi is a generated GoMock package. |
|
test
|
|
|
metadata
Package metadata contains variables used by tests
|
Package metadata contains variables used by tests |
|
integration
Module
|
|
|
performance
Module
|
|
|
third_party
|
|