@hyperledger/caliper-fisco-bcos

Welcome to the Hyperledger Caliper project. Caliper is a blockchain performance benchmark framework, which allows users to test different blockchain solutions with predefined use cases, and get a set of performance test results.

Currently supported blockchain solutions:

• Hyperledger Besu, utilizing the Ethereum adapter.
• Hyperledger Fabric v1.X, v2.X
• Ethereum
• FISCO BCOS

Currently supported performance indicators:

• Success rate
• Transaction/Read throughput
• Transaction/Read latency (minimum, maximum, average)
• Resource consumption (CPU, Memory, Network IO, ...)

See the PSWG white paper to find out the definitions and corresponding measurement methods.

For more information on using Caliper, please consult the documentation site

Configuration and usage

See the related documentation page.

How to contact us

If you have any issues using Caliper that the documentation does not help you solve, please reach out to us through the following methods:

• Discord Please feel free to contact us on Discord (instant messaging). We monitor the Caliper channels as closely as possible, but even if you don't have a problem that needs resolving, why not jump on and say hi ... we'd love to hear from you about your experiences and any new features you think we should work on.
• Issues Feel free to raise an issue if you are facing a Caliper related problem

Caliper interacts with multiple blockchain technologies and consequently it might be an issue with the underlying blockchain technology being interacted with. You can seek specific help on these technologies on the same Discord server such as the Fabric or Besu channels.

How to contribute

We welcome contributions to the Caliper code base. Please see Contributing for more information.

License

Hyperledger Project source code files are made available under the Apache License, Version 2.0 (Apache-2.0), located in the LICENSE file. Hyperledger Project documentation files are made available under the Creative Commons Attribution 4.0 International License (CC-BY-4.0), available at http://creativecommons.org/licenses/by/4.0/.

Changelog

0.5.0 (Wed May 18 2022)

This release of caliper adds new capabilities and addresses lots of bugs. Note that Hyperledger Fabric 1.4 SUT binding is still available in this release however it now is deprecated.

Notable

• [Feature] Official support for Node 14 and Node 16 for users and contributors
• [Feature] Experimental release for a Declaritive Workload Module
• [Feature] Support for the new Peer Gateway API introduced in Hyperledger Fabric 2.4
• [Fix] Fix Caliper round hang with unfinished transactions never completing
• [Fix] Corrections and Improvements to the documentation
• [Breaking] Caliper no longer supports the 1.0 version of the Fabric Network Configuration format
• [Breaking] Caliper no longer supports creating channels or deploying chaincode to Hyperledger Fabric
• [Breaking] Caliper no longer supports Hyperledger Fabric 1.3 or older

Commits

• 2fd8925 Fixes caliper hang of unfinished transactions (#1342)
• df1b96c Peer Gateway txs error messsage: added output of the contents of the err details array (#1345)
• 671ca2f explicitly bind grpc-js for fabric 2.4 connector (#1344)
• 4bbb40c changed all bit.ly links with a direct link (#1336)
• 14467a4 upgraded node-sdk binding for fabric-v2-lts from 2.2.11 to 2.2.12 (#1335)
• b554467 upgraded node-sdk binding for fabric-v1-lts from 1.4.19 to 1.4.20 (#1332)
• 1a6639c add peers property support to fabric network config (#1329)
• ca58c47 disable logging debug to file (#1331)
• 35ae4ca Ensure that connector errors finishes caliper transactions (#1328)
• d699171 Fix cli and update dependabot security dependencies (#1324)
• da99385 correct interval usage in fabric-tests (#1323)
• 031267f fixed docker monitor to use dockerode only (#1319)
• af6440f address worker cleanup when an error occurs (#1315)
• 57d8d46 Change monitor intervals from milliseconds to seconds (#1314)
• 7f4d374 fixed colors dependency to 1.4.0 (#1311)
• 6fb76f2 add integration test for peer gateway connector + updated docker compose for fabric 2.4 (#1310)
• 9e736c0 edit defaul.yaml (updated comments and deleted sllep after option for fabric) + updated the fabric Channel operations for the v1 fabric connector (#1306)
• 25f905d added logic to pick new Peer Gateway connector in the connector selector in FabriConnectorFactory.js + added 2.4 fabric SUT version with binding packages in .config.yaml + added last fixes for the Peer Gateway connector implementation (#1298)
• 7c33aca Update the usage examples to more appropriate versions (#1297)
• 66e8386 remove latency values if no successful txns in final report (#1290)
• 5f9aa29 fix RecordRate rate controller (#1292)
• a372f18 added main logic for the new peer-gateaway connector including unit tests (#1270)
• ada19c3 Caliper terminates if prometheus is not available (#1288)
• 6a76834 Remove CountQueryAsLoad Option (#1276)
• 4f03fef rename certain terms in code base (#1280)
• 4356663 improve message to help when file not found (#1262)
• ba1ffcf Improve integration tests (#1259)
• a84cdd9 add changes to ConnectionProfileDefinition for new PeerGateway connector and add peer-gateway to nyc of caliper-fabric (#1253)
• 5ee6aaa Remove the need for gateway-enabled when binding to a fabric 2.2 SUT (#1255)
• 5380af7 add txid to proposal when doing a query (#1247)
• c72dc9f ensure endorsetimeout is set on v2 fabric connector (#1246)
• 71a5a87 Update bindings to latest fabric sdks and remove old ones (#1244)
• 9043fd0 Remove the legacy fabric connectors (#1235)
• 338212d Bump version to 0.5.0-unstable (#1239)
• cbacc35 Correct timeout defaults (#1230)
• a8652a6 Reference Discord instead of Rocket Chat (#1228)
• 986c856 Add support for node 16 (#1223)
• 5922238 add new folder peer-gateway containing new connector Wallet Facade and Wallet Facade Factory (#1227)
• 24fcdf3 Node 14 support (#1221)
• 4a1860e enable support for node 14 - node engine >=14.19.0 (#1219)
• caad464 Docker monitor metrics fixes - cpu and memory usage (#1214)
• 7c2b3f7 address fabric:1.4 sut binding not working in caliper container (#1211)
• f0553d1 Declarative workload module base integration (#1194)
• a8e9ada Add GitHub web forms-based issue templates (#1189)
• 9e296ac Update CONTRIBUTING.md document (#1192)
• 8701938 Fix the unit of the interval of default-observer in the log (#1193)
• 1fb6011 Propose myself as a new caliper Maintainer (#1186)
• aa0b3db Fix CompositeRateController class bug (#1181) (#1184)
• 595942a Fix issue where init flow errors when not using mutual TLS (#1183)
• cc19cd6 Fix generator integration test (#1176)
• 5a538e1 Fix Ethereum integration test (#1175)
• c73f5a7 Fix Besu integration test (#1174)
• 14bbbcb Add ValueProviderFactory, ListElementValueProvider and FormattedStringValueProvider. (#1168)
• 6d5f071 Update branch name in Azure CI pipeline configuration (#1172)
• 4bd51cf Update link for security bug handling wiki page (#1171)
• 4f98fa7 Open in Visual Studio Code badge added
• 0053563 Add base classes for declarative workload module and unit tests for the base classes.
• 550fdb7 comparison to ===
• 61410f3 Resolve issue in which only first round would be docker-monitored
• 5a34ad7 Make Mosquitto authentication and authorization explicit for v2
• b615b17 FIX: caliper bind command now compatible with Windows OS
• 12a3e52 Adding changes related to value parameter for payable function in Ethereum. (#1122)
• 69eec09 use 0.21.1 axios (#1119)
• 369d11e use single publish script (#1118)
• c48f9ad Publish containers (#1117)
• 88a1568 prevent cascade skip (#1116)
• 5b74a2c Change build reason for publish (#1114)
• c3090ea update pipeline condition (#1113)
• 6ced65a update conditionals (#1112)
• 6fa9b12 publish to npm stage (#1110)
• 730a884 Update contributing guide (#1109)
• d6f0027 Enable builds for PRs that target main branch (#1108)
• bc436e8 Azure pipelines build (#1105)