@hyperledger/caliper-core

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

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.6.0 (Wed 1 May 11:13:41 BST 2024)

Notable

• Security Fix: Address issue in Prometheus monitor that allows the loading and running of an arbitrary binary on a system running a caliper worker
• Feature: Official support for Node 18 and Node 20 for users and contributors (previous versions of node are now unsupported)
• Breaking: Support for Fisco-BCOS has been removed

Commits

• 0877b16 Removed unused dependencies (#1544)
• 62c7593 Remove collection of node gc stats in prometheus (#1545)
• 25ee0f9 Remove Caliper-gui-server packages and Caliper-gui-dashboard packages #1538 (#1540)
• 3fafbf5 Update PSWG whitepaper link in README (#1524)
• 16d4983 Update the versions of fabric sdks (#1519)
• 4bdb98c downgrade npm on publish as temp fix (#1523)
• 7477c70 Temporarily revert publish to using node 16.x to fix broken publish (#1520)
• f24f777 test node 18/20, minimum version 18.19.0 (#1517)
• 31b978f Remove fisco-bcos (#1515)
• 26da2f2 Terminate workers if caliper manager is terminated prematurely (#1514)
• 8cef10c docker monitor remote monitoring bugfix (#1499)
• 943ab2a Update go chaincode dependencies in integration tests (#1485)
• 7c9c5d2 Use go chaincode in integration tests (#1484)
• 35dcc86 Add directory structure and introduction for the development documentation (#1400)
• 91870b7 Update cache action (#1469)
• dc1ce93 Fix npmignore for report html (#1466)
• 4a64acf Add CODEOWNERS file (#1463)
• 394357f Move inactive maintainers to emeritus status (#1462)
• cc3edeb Bump moment-timezone from 0.5.34 to 0.5.38 (#1461)
• 2d58e09 Add TxObserver for Prometheus manager (#1448)
• 2097812 Fix integration test CI trigger (#1458)
• e504bee Revert "Add Node 18 to CI (#1455)" (#1460)
• 1eade51 Fix calculation and doc comment in prometheus observer (#1456)
• 85cf073 Add Node 18 to CI (#1455)
• 69000d4 Add VSCode extension skeleton and runtime config schema (#1404)
• 64f3868 Upload coverage reports on merge (#1433)
• 2cdd46d Add coverage report workflow (#1428)
• c648fa9 Distinguish different workers in Prometheus PushGateway (#1427)
• 2efba52 Revert "Add workflow for gh-pages branch (#1423)" (#1425)
• 954eba5 Add workflow for gh-pages branch (#1423)
• e476ba7 Execute integration tests based on changes (#1421)
• acb518e Cache node modules across CI workflows (#1406)
• 9ecfb02 Migrate generator tests to test network (#1414)
• c29fc0f Migrate to npm workspaces (#1394)
• dd5c85c update fabric bindings (#1412)
• 78e4e84 Remove channel and chaincode ops from Fabric v1 (#1411)
• 5025d20 Migrate Fabric integration tests to test network (#1410)
• 8a792e0 Updated fabric bindings: fabric-network@2.2.12 -> 2.2.13, @hyperledger/fabric-gateway@1.0.1 -> 1.1.0 (#1402)
• 04a1154 Add DCI linting to CI of PRs (#1393)
• f1634b5 Fix #536: Minor changes in the error messages of '@hyperledger/caliper-fisco-bcos' package (#1383)
• 158a367 change the generator binding from 2.2 to 1.4 (#1391)
• 3d22571 Pass secrets to CI workflow for publish (#1390)
• e7a5a17 Port the publish workflow to GitHub Actions (#1384)
• ae23774 Fix #536 Update error messages for '@hyperledger/caliper-ethereum' package (#1363)
• 7ca519b Disable unit and integration tests in Azure Pipelines (#1382)
• 2a3839f Port the integration test workflow to GitHub Actions (#1376)
• 5b96845 Port the unit test workflow to GitHub Actions (#1364)
• 0c1e973 Fix #536 Update error messages for '@hyperledger/caliper-cli' package (#1348)