Fabric Gateway is a service, introduced in Hyperledger Fabric v2.4 peers, that provides a simplified, minimal API for submitting transactions to a Fabric network. Requirements previously placed on the client SDKs, such as gathering transaction endorsements from peers of various organizations, are delegated to the Fabric Gateway service running within a peer to enable simplified application development and transaction submission in v2.4.
Writing client applications¶
Starting with Fabric v2.4, client applications should use one of the gateway SDKs (Go, Node, or Java), which are optimized to interact with the Fabric Gateway. These SDKs expose the same high-level programming model which was initially introduced in Fabric v1.4.
Fabric Gateway (aka the gateway) manages the following transaction steps:
- Evaluate a transaction proposal. This will invoke a smart contract (chaincode) function on a single peer and return the result to the client. This is typically used to query the current state of the ledger without making any ledger updates. The gateway will preferably select a peer in the same organization as the gateway peer and choose the peer with the highest ledger block height. If no peer is available in the gateway’s organization, then it will choose a peer from another organization.
- Endorse a transaction proposal. This will gather enough endorsement responses to satisfy the combined signature policies (see below) and return a prepared transaction envelope to the client for signing.
- Submit a transaction. This will send a signed transaction envelope to the ordering service to commit to the ledger.
- Wait for commit status events. This allows the client to wait for the transaction to be committed to the ledger and to get the commit (validation/invalidation) status code.
- Receive chaincode events. This will allow client applications to respond to events that are emitted by a smart contract function when a transaction is committed to the ledger.
The gateway SDKs combine the Endorse/Submit/CommitStatus actions into a single blocking SubmitTransaction function to support transaction submission with a single line of code. Alternatively, the individual actions can be invoked to support flexible application patterns.
Software Development Kits (SDKs)¶
The Gateway and its SDKs are designed to allow you, as a client application developer, to concentrate on the business logic of your application without having to concern yourself with the infrastructure logic associated with a Fabric network. As such, the APIs provide logical abstractions such as organization and contract rather than operational abstractions such as peer and chaincode. [Side note - clearly an admin API would want to expose these operational abstractions, but this is not an admin API].
Hyperledger Fabric currently supports client application development in three languages:
- Go. See the Go SDK for Fabric Gateway documentation for full details.
- Java. See the Java SDK for Fabric Gateway documentation for full details.
How the gateway endorses your transaction proposal¶
In order for a transaction to be successfully committed to the ledger, a sufficient number of endorsements are required in order to satisfy the endorsement policy. Getting an endorsement from an organization involves connecting to one of its peers and have it simulate (execute) the transaction proposal against its copy of the ledger. The peer simulates the transaction by invoking the chaincode function, as specified by its name and arguments in the proposal, and building (and signing) a read-write set. The read-write set contains the current ledger state and proposed changes in response to the state get/set instructions in that function.
The endorsement policy, or sum of multiple policies, that gets applied to a transaction depends on the implementation of the chaincode function that is being invoked, and could be a combination of the following:
- Chaincode endorsement policies. These are the policies agreed to by channel members when they approve a chaincode definition for their organization. If the chaincode function invokes a function in another chaincode, then both policies will need to be satisfied.
- Private data collection endorsement policies. If the chaincode function writes to a state in a private data collection, then the endorsement policy for that collection will override the chaincode policy for that state. If the chaincode function reads from a private data collection, then it will be restricted to organizations that are members of that collection.
- State-based endorsement (SBE) policies. Also known as key-level signature policies, these can be applied to individual states and will override the chaincode policy or collection policy for private data collection states. The endorsement policies themselves are stored in the ledger and can be updated by new transactions.
The combination of endorsement policies to be applied to the transaction proposal is determined at chaincode runtime and cannot necessarily be derived from static analysis.
The Fabric Gateway manages the complexity of transaction endorsement on behalf of the client, using the following process:
- The Fabric Gateway selects the endorsing peer from the gateway peer’s organization (MSPID) by identifying the (available) peer with the highest ledger block height. The assumption is that all peers within the gateway peer’s organization are trusted by the client application that connects to the gateway peer.
- The transaction proposal is simulated on the selected endorsement peer. This simulation captures information about the accessed states, and therefore the endorsement policies to be combined (including any individual state-based policies stored on the endorsement peer’s ledger).
- The captured policy information is assembled into a
ChaincodeInterestprotobuf structure and passed to the discovery service in order to derive an endorsement plan specific to the proposed transaction.
- The gateway applies the endorsement plan by requesting endorsement from the organizations required to satisfy all policies in the plan. For each organization, the gateway peer requests endorsement from the (available) peer with the highest block height.
The gateway is dependent on the discovery service to get the connection details of both the available peers and ordering service nodes, and for calculating the combination of peers that are required to endorse the transaction proposal. The discovery service must therefore always remain enabled on peers where the gateway service is enabled.
The gateway endorsement process is more restrictive for private data passed in the proposal as transient data because it often contains sensitive or personal information that must not be passed to peers of all organizations. In this case, the gateway will restrict the set of endorsing organizations to those that are members of the private data collection to be accessed (either read or write). If this restriction for transient data would not satisfy the endorsement policy, the gateway returns an error to the client rather than forwarding the private data to organizations that may not be authorized to access the private data. In these cases, client applications should be written to explicitly define which organizations should endorse the transaction.
Targeting specific endorsement peers¶
In some cases, a client application must explicitly select the organizations to evaluate or endorse a transaction proposal. For example, transient data often contains personal or sensitive information which must be written only to a private data collection, thereby limiting the pool of endorsement organizations. In these cases, the client application can explicitly specify the endorsing organizations to meet both the privacy and endorsement requirements of the application; the gateway will then select the (available) endorsing peer with the highest block count from each specified organization. However, if the client specifies a set of organizations that does not satisfy an endorsement policy, the transaction may still get endorsed by the specified peers and submitted for ordering, but the transaction will later be invalidated by all peers in the channel during the validation and commit phase. This invalidated transaction is recorded on the ledger but the transaction’s updates are not written to the state database on any channel peer.
Retry and error handling¶
Fabric Gateway handles node connectivity retry attempts, errors, and timeouts as described below.
The gateway will use discovery service information to retry any transaction that fails due to an unavailable peer or ordering node. If an organization is running multiple peer or ordering nodes, then another qualifying node will be attempted. If an organization fails to endorse a transaction proposal, then another one will be selected. If an organization fails to endorse entirely, a group of organizations that satisfies the endorsement policy will be targeted. Only if there is no combination of available peers that satisfies the endorsement policy will the gateway stop retrying. The gateway will continue with retry attempts until all possible combinations of endorsing peers have been tried once.
The Fabric Gateway manages gRPC connections to network peer and ordering nodes. If a gateway service request error originates from a network peer or ordering node (i.e. external to the gateway), the gateway returns error, endpoint, and organization (MSPID) information to the client in the message
Details field. If the
Details field is empty, then the error originated from the gateway peer.
The Fabric Gateway
Endorse methods make gRPC requests to peers external to the gateway. In order to limit the length of time that the client must wait for these collective responses, the
peer.gateway.endorsementTimeout value can be overridden in the gateway section of the peer
core.yaml configuration file.
Each Gateway SDK also provides a mechanism for setting timeouts for each gateway method when invoked from the client application.
Listening for events¶
The gateway provides a simplified API for client applications to receive chaincode events in the client applications. Each SDK provides a mechanism to handle these events using its language-specific idiom.