README
¶
fabric-sdk-go
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/huijinchain/fabric-sdk-go/pkg/fabsdk
pkg/client/channel: Provides channel transaction capabilities. Reference: https://godoc.org/github.com/huijinchain/fabric-sdk-go/pkg/client/channel
pkg/client/event: Provides channel event capabilities. Reference: https://godoc.org/github.com/huijinchain/fabric-sdk-go/pkg/client/event
pkg/client/ledger: Enables queries to a channel's underlying ledger. Reference: https://godoc.org/github.com/huijinchain/fabric-sdk-go/pkg/client/ledger
pkg/client/resmgmt: Provides resource management capabilities such as installing chaincode. Reference: https://godoc.org/github.com/huijinchain/fabric-sdk-go/pkg/client/resmgmt
pkg/client/msp: Enables identity management capability. Reference: https://godoc.org/github.com/huijinchain/fabric-sdk-go/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/huijinchain/fabric-sdk-go/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 |
|
third_party
|
|