Keyhole Fabric API Gateway

Provides client access to a Hyperledger Fabric blockchain network through RESTful APIs.

Hyperledger Labs

Keyhole Fabric API Gateway has been accepted into Hyperledger Labs.

Hyperledger® Labs is a community-based innovation space. Entrance into Hyperledger Labs allows Byzantine Config to be further tested, innovated, and used by the wider Hyperledger community.

See Hyperledger Labs

Keyhole Fabric API Gateway Usage

This tool is used to provide access to Hyperledger Fabric (HLF) blockchain networks and its data via an API gateway implementation.

APIs are defined query channel configuration information and execute chaincode. The gateway is implemented with Node.js and uses the Express framework to provide RESTful HTTP-based endpoints that access HLF network peers.

Highlights

Useful for executing Chaincode and Smart Contracts.

Useful for querying the blockchain by client applications.

Authentication logic and validation can be performed here.

Implements a web socket to listen for new blocks being added to the blockchain.

Architecture

The gateway provides RESTful HTTP-based endpoints that access HLF network peers using the FABRIC-NODE-SDK. It is implemented with Node.js and uses the Express framework.

Authentication

Two types of API authentication validation schemes that can be applied, token-based or a session-based validation scheme. Example implementations are provided for both.

Go Right to the Code

Github