README.md

BSOL (Benchmarking Solidity)

BSOL is a tool to write benchmark for Solidity snippets and Smart Contract.

BSOL gives as an output:

• The Average Gas Usage
• The Average Gas Usage for execution only
• Average Computation time for Ethereum to execute the code in µs(nanoseconds).

Install

git clone https://github.com/Giulio2002/bsol
cd bsol
sudo sh install.sh

Usage

Given this benchmark contract

pragma solidity ^0.5.0;

contract N {

    function BenchmarkOne() public returns(uint) {
        return 1;
    }

    function BenchmarkTwo() public returns(uint) {
        return 2;
    }
}

to execute the benchmarks just uses bsol --sol N.sol --execution-time.

Contract: N
Method: N.BenchmarkOne()
Average Computation time: 32.742638µs
Average Gas Usage: 21262 Gas
Average Gas Usage per execution: 262 Gas

Method: N.BenchmarkTwo()
Average Computation time: 34.421126µs
Average Gas Usage: 21284 Gas
Average Gas Usage per execution: 284 Gas

BSOL benchmarks every method of every smart contract in a given solidity file that:

• Benchmark at the beggining of its name (if not: the method is ignored)
• Requires 0 arguments (if more argument BSOL gives out an error message)

so the following bechmarks won't be executed:

pragma solidity ^0.5.0;

contract N {

    function One() public returns(uint) { // Does not have Benchmark at the beggining of the name
        return 1;
    }

    function BenchmarkTwo(uint a) public returns(uint) { // Requires an argument
        return a;
    }
}

Flag Options

--runs: Number of Runs to calculate averages (enabled only if --execution-time is set)
--sol: Solidity source file to benchmark
--sol-dir: Solidity source directory to 
--execution-time calculate execution time