Skip to content

Commit

Permalink
Add information about BFT consensus in docs for fabric (#1663)
Browse files Browse the repository at this point in the history
Signed-off-by: Dave Kelsey <d_kelsey@uk.ibm.com>
Co-authored-by: Dave Kelsey <d_kelsey@uk.ibm.com>
  • Loading branch information
davidkel and Dave Kelsey authored Nov 23, 2024
1 parent 48434c2 commit 9107f00
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions docs/source/connectors/fabric-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ You must bind Caliper to a specific Fabric SDK to target the corresponding (or c

### Binding with Fabric 1.4 Client SDK

To bind with this client sdk, use `fabric:1.4`.
To bind with this client sdk, use `fabric:1.4`. Do not use this binding if using the BFT Concensus mechanism in Hyperledger Fabric that was introduced in version 3.0.0, use fabric:fabric-gateway instead.

It is confirmed that a 1.4 Fabric SDK is compatible with a Fabric 2.2 and later Fabric 2.x SUTs, therefore this binding can be used with later Fabric SUTs

Expand All @@ -41,7 +41,7 @@ Note that when using the binding target for the Fabric SDK 1.4 there are capabil

### Binding with Fabric 2.2 Client SDK

To bind with this client sdk, use `fabric:2.2`.
To bind with this client sdk, use `fabric:2.2`. Do not use this binding if using the BFT Concensus mechanism in Hyperledger Fabric that was introduced in version 3.0.0, use fabric:fabric-gateway instead.

It is confirmed that a 2.2 Fabric SDK is compatible with 2.2 and later Fabric SUTs, therefore this binding can be used with 2.2 and later Fabric SUTs

Expand All @@ -51,7 +51,7 @@ It is confirmed that a 2.2 Fabric SDK is compatible with 2.2 and later Fabric SU

### Binding with Fabric Gateway Client SDK

To bind with this client sdk, use `fabric:gateway`. This is now the preferred SDK to use given that Fabric 2.2 and earlier is now not in LTS and as such the Fabric 1.4 and 2.2 SDKs are now deprecated.
To bind with this client sdk, use `fabric:fabric-gateway`. This is now the preferred SDK to use given that Fabric 2.2 and earlier are now not in LTS and as such the Fabric 1.4 and 2.2 SDKs are deprecated.

Only Fabric 2.4 and later with the Peer Gateway capability enabled (which is the default setting for a Fabric peer) can be used so for older versions of Hyperledger Fabric you cannot bind with this client SDK.

Expand All @@ -73,7 +73,7 @@ Network builders and providers should generate connection profiles (for example

Unfortunately the documentation provided by Hyperledger Fabric is more focused on static connection profiles rather than dynamic connection profiles and your aim should be to create the simpler and smaller dynamic connection profile.

With the introduction of using the Peer Gateway rather than the traditional node sdks (1.4 and 2.2) caliper has introduced the concept of declaring peers in an organization within the network configuration file as an alternative to connection profiles. This provides a simple way to describe either peers to discover from (when binding to Fabric 1.4 or 2.2, for Fabric 1.4 you must enable the gateway option as it won’t work otherwise as discovery is not supported with the Fabric 1.4 binding when the gateway option is not enabled) or the peer to be used as a gateway into the Fabric network (when binding to Fabric 2.4/2.5/gateway). An example of a peers section in the network configuration is
With the introduction of using the Peer Gateway rather than the traditional node sdks (1.4 and 2.2) caliper has introduced the concept of declaring peers in an organization within the network configuration file as an alternative to connection profiles. This provides a simple way to describe either peers to discover from (when binding to Fabric 1.4 or 2.2, for Fabric 1.4 you must enable the gateway option as it won’t work otherwise as discovery is not supported with the Fabric 1.4 binding when the gateway option is not enabled) or the peer to be used as a gateway into the Fabric network (when binding to Fabric 2.4/fabric-gateway). An example of a peers section in the network configuration is

```sh
peers:
Expand Down

0 comments on commit 9107f00

Please sign in to comment.