lib-estimate-sol

Script to estimate the size of solidity source code


Keywords
solidity, solidity-contracts
License
MIT
Install
pip install lib-estimate-sol==0.0.2

Documentation

estimate-sol

Requirements

  • python3
  • On ubuntu, install the python3-setuptools package (or install setuptools via pip in your env) and python3-wheel (or install wheel via pip in your env) to make the packages

Package generation

Run python3 setup.py bdist_wheel to generate the .whl file.

Releases

You can download the project releases from google-drive

Installation

  1. Activate the proper env to do the install (optional)
  2. Install:
    1. Via pip: Run pip install path/to/generated.whl (if using the .egg generated via setup.py it will be in the dist/ directory).
    2. Via easy_install: Run python3 -m easy_install path/to/generated.egg (if using the .egg generated via setup.py, it will be in the dist/ directory).

Estimating solidity audits

After installing the egg, you can run estimate-sol to estimate solidity audits. See different options by running estimate-sol --help.

The defaults for the number of lines per week, the number of punctuations per week, the dependencies multiplier and the assembly multiplier can be set via the following environment variables:

  • ESTIMATE_SOL_DEFAULT_LINES_PER_WEEK
  • ESTIMATE_SOL_DEFAULT_PUNCTUATIONS_PER_WEEK
  • ESTIMATE_SOL_DEFAULT_DEPENDENCIES_MULTIPLIER
  • ESTIMATE_SOL_DEFAULT_ASSEMBLY_MULTIPLIER

Run tests

To run all the tests run python3 -m unittest -v. See python documentation on how to run unit tests at: https://docs.python.org/3/library/unittest.html#command-line-interface