OpenViSTAI · Agents · Blockchain · Crypto
Submit a project
Menu
Developer Tools

Fabric Gateway

Fabric Gateway is a set of Go, TypeScript for Node.js, and Java client APIs for applications interacting with Hyperledger Fabric v2.4 and later. A gateway component in a Fabric peer exposes a gRPC interface and manages transaction invocation on behalf of client applications.

Explore the practical guide ↓

Independent OpenViST project profile, based on linked sources.

Fabric Gateway — OpenViST project profile in Developer Tools.
OpenViST project illustration. See the linked sources for product details.
Understand the project

Practical overview

When it fits

Use Fabric Gateway when building or testing an application that needs client API access to a Hyperledger Fabric v2.4 or later network.

Who it is for

  • Developers building Go, Node.js or Java applications that interact with Hyperledger Fabric.
  • Teams integrating Fabric client access into an existing application or service.
  • Contributors building or testing the Fabric Gateway client APIs.

Documented uses

  • Connect an application to a Hyperledger Fabric network through the gateway interface.
  • Submit transactions and query ledger state from client applications.
  • Run documented unit and scenario tests for the Go, Node.js and Java client APIs.
Before you choose

Requirements & limits

The project is publicly available on GitHub under the Apache-2.0 license.

  • The client APIs are provided for Go, TypeScript/Node.js and Java.
  • The gateway is a component in a Fabric peer, distinct from the application-side client APIs.
  • Repository builds and tests require language toolchains and supporting tools; the README documents a Dev Container configuration.
  • SoftHSM v2 is needed for HSM tests, not all test targets.

Check current requirements in the official documentation. Source-based guidance does not mean OpenViST has run or independently tested this project.

Source-based practical guide

Run the documented Fabric Gateway scenario tests

Use the repository's Make targets to run scenario tests that create a Docker-based Fabric network and exercise a client API.

Before you start

  • Docker
  • Go, Node.js and Java toolchains for the corresponding language tests
  • Make and Maven
  • SoftHSM v2 for scenario targets that include HSM tests

Steps

  1. Clone the Fabric Gateway repository.

  2. Select a documented scenario-test target, such as make scenario-test-go-no-hsm for Go without HSM tests, or make scenario-test for all language implementations.

  3. The scenario tests create a network with two organizations, one peer per organization and a gateway; clients connect to submit transactions and query ledger state.

Expected outcome

The selected scenario-test suite exercises client interaction with a Docker-based Fabric network.

Guide limitations

  • The repository documents that scenario-test targets without the no-hsm suffix include HSM tests; SoftHSM v2 is required for HSM tests.
  • This recipe describes the repository's documented test process, not an independently executed test.
Documentation 1 ↗
Evidence and transparency

Sources & review

Official repository ↗
Source record details
Source availability
Active
Sources checked
13 October 2026
Original website title
hyperledger/fabric-gateway · Official homepage title · retained in its source language
How we review sourcesSuggest a correction