Hyperledger Caliper Benchmarks

This repository contains sample benchmarks that may be used by Caliper, a blockchain performance benchmark framework. For more information on Caliper, please see the Caliper main repository

Associated performance reports, based on running these benchmarks, are published to the repository github pages.

Repository Branches

This repository has three branches:

1. master. Contains sample benchmarks
2. reports. Contains md files that are built and published to the gh-pages branch
3. gh-pages. Contains the build output from the reports branch

Master Branch Contents

The benchmarks contained within the master branch are split into three directories:

1. benchmarks. Comprises the test configuration and callback files. The test configuration files describe the benchmark test parameters and also reference the callback files that are executed by Caliper clients during the benchmark. The Benchmark folder contains the following subfolders:
   • api Tests directed towards the API of a single target blockchain.
   • samples Tests directed towards the native samples provided by target blockchain platforms.
   • scenario Generic scenarios that are valid for all (supported) target blockchain platforms
2. networks. Comprises sample blockchain networks that may be used as target systems under test (SUT) for benchmarking purposes.
3. src. Comprises the source smart contract files that are deployed to the SUT and interacted with via the test callbacks located within the benchmarks folder. Each smart contract is held within its own folder, under the blockchain technology that the smart contract corresponds to.

Running a Benchmark

To run any of the benchmarks present in this repository, it is required to have installed Hyperledger Caliper, which is the intended consumer of all the contained files.

Steps:

1. Install the Caliper CLI - for details please see the Caliper main repository
2. Clone this repository
3. Run a Caliper CLI command that targets one of the contained benchmarks. For instance, to run the benchmark that targets the Fabric Marbles sample against a Fabric v1.4.1 network, you would:

• Ensure that the crypto configuration files have been generated. Do this by navigating to the relevant /networks/fabric/config_x directory and running the command:

  ./generate.sh

• Run the benchmark using the Caliper CLI command:

  caliper launch master --caliper-benchconfig benchmarks/samples/fabric/marbles/config.yaml --caliper-networkconfig networks/fabric/fabric-v1.4.1/2org1peergoleveldb/fabric-go.yaml --caliper-workspace <path_to_caliper_benchmarks_root_directory>

Extending the Documented Reports

The documented reports are built automatically from the reports branch of this repository and subsequently hosted on the gh-pages branch; pull requests must be target the reports branch in order for any modifications to be built.