Solidity Design Pattern Analyzer

Un utility per il riconoscimento di design pattern su blockchain tramite analisi statica del codice

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

Tabella dei Contenuti

1. Avviso
2. Informazioni sul Progetto
   • Basato su
3. Guida all'utilizzo
   • Prerequisiti
   • Come usarlo
4. Licenza
5. Bibliografia

Avviso

Successivamente alla laurea, il progetto ha subito cambiamente e miglioramenti, perciò quanto descritto nell'elaborato della tesi potrebbe non rispecchiare più attendibile.

Per visionare il progetto nella forma descritta nell'elaborato della tesi e la tesi stessa, fare riferimento al branch frozen, clicca qui .

Informazioni sul Progetto

Solidity Design Pattern Analyzer è un applicativo software sviluppato per la mia tesi di laurea per il CdL Triennale in Informatica presso l'Università degli Studi di Catania.

L’applicativo software e in grado di eseguire le seguenti operazioni:

• Rilevare, nei limiti linguistici e delle dipendenze utilizzate, tutti e ventidue i design pattern documentati nella tesi, i cui relativi descriptor sono inclusi nel codice sorgente, ed e possibile, mediante la combinazione di controlli generici, definire nuovi descriptor per riconoscere design pattern futuri;
• Descrivere uno smart-contract, ovvero estrarre le informazioni utili a creare un nuovo descriptor;

(back to top)

Basato su

• Python
• python-solidity-parser
• python-jsonschema
• matplotlib

(back to top)

Guida all'utilizzo

Prima di utilizzare l'applicativo è necessario installare le dipendenze.

Prerequisiti

Per installare le dipendeze puoi usare il package installer di python denominato pip:

• Come pacchetti globali:

  pip install -r requirements.txt

• Tramite ambiente virtuale:

  python3 -m venv /path/to/new/virtual/environment
  source /path/to/new/virtual/environment/bin/activate
  pip install -r requirements.txt

Come usarlo

Per utilizzare Analyzer e necessario fornire una serie di parametri, qui elencati:

Parametro	Descrizione
-h, --help	Un parametro opzionale che, se fornito, fara stampare una guida sull’utilizzo nel terminale
-a, --action	Un parametro obbligatorio che accetta soltanto i valori analyze e describe, a seconda dell’operazione che si vuole eseguire.
-t, --target	Un parametro obbligatorio che rappresenta la path, assoluta o relativa, del file o cartella contenente del codice sorgente Solidity. Nel caso venga fornita una directory verrà eseguità la modalità batch che salverà tutti i risultati ottenuti in un'unico file.
-d, --descriptor	Un parametro opzionale per l’operazione analyze che rappresenta la path, assoluta o relativa, del file o cartella contenente i Design Pattern Descriptor. Se omesso verra usato un path predefinito.
-v, --verbose	Un parametro opzionale che, se fornito, fara stampare nel terminale i log di debug, normalmente non visualizzati.
-ai, --allow-incompatible	Un parametro opzionale che determina il controllo di compatibilita della versione di Solidity utilizzata nel file fornito. Accetta come valori: ask, skip, always. Default: ask, chiede conferma.
-p, --plot	Un parametro opzionale che determina la visualizzazione di un grafico riassuntivo. Accetta come valori: ask, skip, always. Default: ask, chiede conferma.
-pr, --print-result	Un parametro opzionale che, se fornito, farà stampare sul terminale un riassunto dei risultati ottenuti dall'analisi.
-wr, --write-result	Un parametro opzionale che determina il salvataggio su disco dei risultati ottenuti dall'analisi dei singoli file. Accetta come valori: ask, skip, always. Default: ask, chiede conferma.
-fr, --format-result	Un parametro opzionale che determina il formato con cui i dati ottenuti vengono salvati. Accetta come valori: json, csv. Default: json.
--debug-analysis	Un parametro opzionale che, se fornito, farà eseguire un analisi di debug sull'AST.

Per esempio, volendo analizzare uno smart-contract al fine di individuare l’utilizzo dell’Ownership pattern e necessario eseguire il comando:

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

(back to top)

Licenza

Il software è rilasciato sotto licenza MIT. Visionare LICENSE per maggiori informazioni.

(back to top)

Bibliografia

• What is Ethereum?
• Solidity Documentation.
• The official home of the Python Programming Language.
• ANother Tool for Language Recognition.
• [An experimental Solidity parser for Python built on top of a robust ANTLR4 grammar.](https://github.com/ConsenSys/ python-solidity-parser)
• [JSON Schema — The home of JSON Schema.](https://json- schema.org/)
• [JSON Schema Draft-07 Release Notes.](https://json- schema.org/draft-07/json-schema-release-notes.html)
• An implementation of the JSON Schema specification for Python.
• M. Wohrer e U. Zdun. “From Domain-Specific Language to Code: Smart Contracts and the Application of Design Patterns”. In: IEEE Software 37.05 (set. 2020), pp. 37–1. issn: 1937-4194. doi: 10.1109/- MS.2020.2993470
• Lodovica Marchesi et al. “Design Patterns for Gas Optimization in Ethereum”. In: 2020 IEEE International Workshop on Blockchain Oriented Software Engineering (IWBOSE).Feb.2020, pp.9–15.doi:10.- 1109/IWBOSE50093. 2020.9050163
• Smart Contracts Design Patterns in the Ethereum Ecosystem and Solidity Code.
• Smart-Contract Patterns written in Solidity, collated for community good.
• A compilation of patterns and best practices for the smart contract programming language Solidity.
• Maximilian Wohrer e Uwe Zdun. “Smart contracts: security patterns in the ethereum ecosystem and solidity”. In: 2018 International Workshop on Blockchain Oriented Software Engineering (IWBOSE). - Mar. 2018, pp.2–8.doi: 10.1109/IWBOSE.2018.8327565
• OpenZeppelin Contracts is a library for secure smart contract development.

(back to top)