fabric-smart-client

Fabric Smart Client

The Fabric Smart Client (FSC) is a next-generation client-side framework for Hyperledger Fabric and Fabric-x.
It lets you focus on business logic and distributed workflows, rather than low-level DLT details.

FSC abstracts away the complexity of a DLT network, enabling developers to build distributed applications with ease.

Key Features

• High-level APIs that abstract away the complexity of interactive distributed applications.
• Peer-to-peer client overlay enabling direct interaction as needed.
• Advanced transaction orchestration to implement complex application business processes.
• Integration-ready with Fabric and Fabric-x networks via simple configuration, with support for multiple versions.
• Token SDK as an example of building distributed ledger applications on top of FSC.

Quick links

• Documentation: docs/README.md
• API reference (Godoc): pkg.go.dev/github.com/hyperledger-labs/fabric-smart-client
• Examples and integration tests: integration/fabric/ and integration/fabricx/
• Token SDK: https://github.com/hyperledger-labs/fabric-token-sdk

Getting Started

To start developing and testing your application with the Fabric Smart Client:

Ensure you have a working Go environment.

Clone the repository:

git clone https://github.com/hyperledger-labs/fabric-smart-client.git
cd fabric-smart-client

Examples and Integration

The integration/ directory includes example applications and integration tests for Fabric and Fabric-x networks.

Start with:

• integration/fabric/ — examples and tests for Hyperledger Fabric
• integration/fabricx/ — examples and tests for Hyperledger Fabric-x

These examples demonstrate common FSC patterns, transaction flows, and how to wire the client with a ledger network.

Contributing

We welcome contributions from everyone. Please read CONTRIBUTING.md for detailed guidelines.

Join our community on the LFDT Discord #fabric-smart-client. We also have a community meeting every Wednesday at 1400 CET on Zoom. Please see the Hyperledger Fabric community calendar for details. Meeting notes are available here.

Versioning

This project follows Semantic Versioning (SemVer). See available releases here: https://github.com/hyperledger-labs/fabric-smart-client/tags

Disclaimer and License

The Fabric Smart Client is provided as-is and has not been formally audited. Use at your own risk. The project is actively developed and APIs may change.

This project is licensed under the Apache License, Version 2.0 (Apache-2.0). Documentation is available under the Creative Commons Attribution 4.0 International License (CC-BY-4.0).