Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/hyperledger/fabric-sdk-go


https://github.com/hyperledger/fabric-sdk-go

blockchain distributed-ledger go hyperledger hyperledger-fabric

Last synced: 3 months ago
JSON representation

Awesome Lists containing this project

README 

        
# Hyperledger Fabric Client SDK for Go



[![Release](https://img.shields.io/github/release/hyperledger/fabric-sdk-go.svg?style=flat-square)](https://github.com/hyperledger/fabric-sdk-go/releases/latest)

[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://raw.githubusercontent.com/hyperledger/fabric-sdk-go/main/LICENSE)

[![GoDoc](https://godoc.org/github.com/hyperledger/fabric-sdk-go?status.svg)](https://godoc.org/github.com/hyperledger/fabric-sdk-go)



[![Build Status](https://dev.azure.com/hyperledger/fabric-sdk-go/_apis/build/status/hyperledger.fabric-sdk-go?branchName=main)](https://dev.azure.com/hyperledger/fabric-sdk-go/_build/latest?definitionId=19&branchName=main)

[![codecov](https://codecov.io/gh/hyperledger/fabric-sdk-go/branch/main/graph/badge.svg)](https://codecov.io/gh/hyperledger/fabric-sdk-go)

[![Go Report Card](https://goreportcard.com/badge/github.com/hyperledger/fabric-sdk-go)](https://goreportcard.com/report/github.com/hyperledger/fabric-sdk-go)



> **Note:** This API is deprecated and is no longer maintained as of Fabric v2.5. When developing applications for Hyperledger Fabric v2.4 and later, you should use the [Fabric Gateway client API](https://hyperledger.github.io/fabric-gateway/).



This SDK enables Go developers to build solutions that interact with [Hyperledger Fabric](http://hyperledger-fabric.readthedocs.io/en/latest/).



## Getting started



Obtain the client SDK packages for Fabric and Fabric CA.



```bash

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](https://godoc.org/github.com/hyperledger/fabric-sdk-go).



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](test/integration/e2e/end_to_end.go): Basic example that uses SDK to query and execute transaction

- [Ledger Query Test](test/integration/pkg/client/ledger/ledger_queries_test.go): Basic example that uses SDK to query a channel's underlying ledger

- [Multi Org Test](test/integration/e2e/orgs/multiple_orgs_test.go): An example that has multiple organisations involved in transaction

- [Dynamic Endorser Selection](test/integration/pkg/fabsdk/provider/sdk_provider_test.go): An example that uses dynamic endorser selection (based on chaincode policy)

- [E2E PKCS11 Test](test/integration/e2e/pkcs11/e2e_test.go): E2E Test using a PKCS11 crypto suite and configuration

- More examples needed!



### Community



- Discussion is happening in [Rocket Chat](https://chat.hyperledger.org/channel/fabric-sdk-go).

- Issue tracking is handled in [Jira](https://jira.hyperledger.org/secure/RapidBoard.jspa?projectKey=FAB&rapidView=7&view=planning).



## 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.



```bash

git clone https://github.com/hyperledger/fabric-sdk-go.git

```



```bash

# 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](http://hyperledger-fabric.readthedocs.io/en/latest/CONTRIBUTING.html).



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](https://github.com/golang/go/wiki/Modules).



### Running a portion of the test suite



```bash

# 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



```bash

# 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 in `test/fixtures/dockerenv`. See steps below.

- Customized settings in the `test/fixtures/config/config_test.yaml` in case your Hyperledger Fabric network is not running on `localhost` 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:



```bash

# 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



```bash

# 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

```



```bash

# 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:



```bash

# 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](LICENSE).



---

This document is licensed under a Creative Commons Attribution 4.0 International License.