Package Health Score

64 / 100

security
No known security issues
popularity
Recognized
maintenance
Inactive
community
Active

Explore Similar Packages

v1
47

Popularity

Recognized

Imported By: 0
GitHub Stars: 903
Forks: 512
Contributors: 60

Usage Popularity

Based on project statistics from the GitHub repository for the Golang package fabricsdk, we found that it has been 903 times.

The popularity score for Golang modules is calculated based on the number of stars that the project has on GitHub as well as the number of imports by other modules.

Security

No known security issues

Security risks

Direct Vulnerabilities: 0
C
0
H
0
M
0
L

Indirect Vulnerabilities: Check with Snyk

Release Date

Feb 1, 2021

License

Apache-2.0

Security Policy

Yes

You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.

Keep your project free of vulnerabilities with Snyk

Maintenance

Inactive

Commit Frequency

Open Issues: 41
Open PR: 13
Last Release: 3 years ago
Last Commit: 3 months ago

Further analysis of the maintenance status of github.com/hyperledger/fabric-sdk-go based on released golang versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for github.com/hyperledger/fabric-sdk-go is that it hasn't seen any new versions released to golang in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Community

Active

Readme.md: Yes
Contributing.md: Yes
Code of Conduct: Yes
Contributors: 60
Funding: No

With more than 10 contributors for the github.com/hyperledger/fabric-sdk-go repository, this is possibly a sign for a growing and inviting community.

Embed Package Health Score Badge

Keep your project healthy

Check your go.mod

Ensure all the packages you're using are healthy and well-maintained

Readme

Hyperledger Fabric Client SDK for 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.

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

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

FAQs

What is fabricsdk?

. Visit Snyk Advisor to see a full health score report for fabricsdk, including popularity, security, maintenance & community analysis.

Is fabricsdk popular?

The golang package fabricsdk receives a total of ? weekly downloads. As such, fabricsdk popularity was classified as a recognized. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is fabricsdk well maintained?

We found indications that fabricsdk is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is fabricsdk safe to use?

The golang package fabricsdk was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 23 April-2024, at 03:33 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Explore Similar Packages

Usage Popularity

Security risks

Commit Frequency

Embed Package Health Score Badge

Keep your project healthy

Check your go.mod

Readme

Hyperledger Fabric Client SDK for Go

Getting started

Documentation

Examples

Community

Client SDK

Current Compatibility

Retired versions

Running the test suite

Go Tags

Contributing to the Go SDK

Running a portion of the test suite

Running package unit tests manually

Running integration tests manually

Testing with Fabric Images at Docker Hub

Running Integration Tests

Testing with Local Build of Fabric (Advanced)

License

FAQs

What is fabricsdk?

Is fabricsdk popular?

Is fabricsdk well maintained?

Is fabricsdk safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues