Skip to content

Latest commit

 

History

History
140 lines (108 loc) · 7.57 KB

README.en.md

File metadata and controls

140 lines (108 loc) · 7.57 KB


Preview

Solidity Design Pattern Analyzer

A tool for design pattern recognition on blockchain through static code analysis

This README is available in the following languages:
Italian · English

Table of Contents
  1. Warning
  2. About The Project
  3. Getting Started
  4. License
  5. Bibliography

Warning

Since graduation, the project has undergone changes and improvements, so what is described in the thesis paper may no longer be accurate.

To view the project in the form described in the thesis paper and the thesis itself, refer to the branch frozen, click here .

About The Project

Solidity Design Pattern Analyzer is a software application developed for my thesis for the Bachelor's Degree in Computer Science at the University of Catania.

The software application is capable of performing the following tasks:

  • Detect, within the limits of the language and dependencies used, all twenty-two design patterns documented in the thesis, whose related descriptors are included in the source code, and it is possible, through the combination of generic checks, to define new descriptors to recognize future design patterns;
  • Describing a smart-contract, i.e., extracting information useful for creating a new descriptor;

(back to top)

Built With

(back to top)

Getting Started

Dependencies must be installed before using the application.

Prerequisites

To install dependencies you must use python's package installer named pip:

  • As global packages: 
    pip install -r requirements.txt
  • Via virtual environment: 
    python3 -m venv /path/to/new/virtual/environment
source /path/to/new/virtual/environment/bin/activate
pip install -r requirements.txt

Usage

To use Analyzer it is necessary to provide a number of parameters, listed here:

Parameter Description
-h, --help An optional parameter that, if provided, will cause a guide on usage to be printed in the terminal
-a, --action A mandatory parameter that accepts only the values analyze and describe, depending on the operation to be performed.
-t, --target A mandatory parameter representing the path, absolute or relative, of the file or directory containing some Solidity source code.
In case a directory is provided the batch mode will be executed which will save all the results obtained in a single file.
-d, --descriptor An optional parameter for the analyze operation representing the path, absolute or relative, to the file or folder containing the Design Pattern Descriptors.
If omitted a default path will be used.
-v, --verbose An optional parameter that, if provided, will cause debug logs, normally not displayed, to be printed in the terminal.
-ai, --allow-incompatible An optional parameter that determines the compatibility check of the version of Solidity used in the provided file.
Accepts as values: ask, skip, always.
Default: ask, asks for confirmation.
-p, --plot An optional parameter that determines the display of a summary graph.
Accepts as values: ask, skip, always.
Default: ask, asks for confirmation.
-pr, --print-result An optional parameter that, if provided, will cause a summary of the results obtained from the analysis to be printed on the terminal.
-wr, --write-result An optional parameter that determines whether the results obtained from the analysis of individual files are saved to disk.
Accepts as values: ask, skip, always.
Default: ask, asks for confirmation.
-fr, --format-result An optional parameter that determines the format with which the obtained data is saved.
Accepts as values: json, csv.
Default: json.
--debug-analysis An optional parameter that, if provided, will perform a debug analysis of the AST.

For example, wanting to analyze a smart-contract in order to detect the use of the Ownership pattern, it is necessary to execute the command:

python analyzer.py -a analyze -t ./source_code.sol -d ./Ownership_descriptor.json --print-result --write-result always --plot always

(back to top)

License

This software is distributed under the MIT License. See LICENSE for more information.

(back to top)

Bibliography

(back to top)