SolidityDesignPatternAnalyzer

Penganalisa pola desain soliditas

Utilitas untuk pengakuan pola desain pada blockchain melalui analisis statis kode

Readme ini tersedia dalam bahasa berikut:
Italia · Bahasa Inggris

Tabel konten

1. Saya memberi tahu
2. Informasi Proyek
   • Berdasarkan
3. Gunakan panduan
   • Prasyarat
   • Cara menggunakannya
4. Lisensi
5. Bibliografi

Saya memberi tahu

Setelah derajat, proyek telah mengalami variasi dan perbaikan, oleh karena itu apa yang dijelaskan dalam rumit tesis mungkin tidak mencerminkan lebih dapat diandalkan.

Untuk melihat proyek dalam bentuk yang dijelaskan dalam rumit tesis dan tesis itu sendiri, lihat cabang frozen , klik di sini.

Informasi Proyek

Solidity Design Pattern Analyzer adalah aplikasi perangkat lunak yang dikembangkan untuk tesis gelar saya untuk tiga tahun CDL dalam ilmu komputer di University of Catania.

Aplikasi perangkat lunak dan dapat melakukan operasi berikut:

• Deteksi, dalam bahasa linguistik dan dependensi yang digunakan, semua dan dua puluh dua pola desain yang didokumentasikan dalam tesis, yang deskriptor relatifnya termasuk dalam kode sumber, dan mungkin, melalui kombinasi kontrol generik, untuk mendefinisikan deskriptor baru untuk mengenali desain pola di masa depan;
• Jelaskan kontrak pintar, atau ekstrak informasi yang berguna untuk membuat deskriptor baru;

(kembali ke atas)

Berdasarkan

• Python
• Python-Solidity-Parser
• Python-hsonschema
• matplotlib

(kembali ke atas)

Gunakan panduan

Sebelum menggunakan aplikasi, perlu menginstal kecanduan.

Prasyarat

Untuk menginstal karyawan, Anda dapat menggunakan paket penginstal Python yang disebut PIP :

• Seperti paket global:

  pip install -r requirements.txt

• Melalui lingkungan virtual:

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

Cara menggunakannya

Untuk menggunakan penganalisa, perlu memberikan serangkaian parameter, yang tercantum di sini:

Parameter	Keterangan
-h, --help	Parameter opsional yang, jika disediakan, akan membuat panduan tentang penggunaan di terminal
-a, --action	Parameter wajib yang hanya menerima analyze dan describe nilai, tergantung pada operasi yang ingin Anda lakukan.
-t, --target	Parameter wajib yang mewakili jalur absolut atau relatif dari file atau folder yang berisi kode sumber Solidty. Jika direktori disediakan, modalità batch akan dilakukan yang akan menyimpan semua hasil yang diperoleh dalam satu file.
-d, --descriptor	Parameter opsional untuk operasi analyze yang mewakili jalur, absolut atau relatif, dari file atau folder yang berisi Design Pattern Descriptor . Jika Anda menghilangkan jalur yang telah ditentukan, itu akan digunakan.
-v, --verbose	Parameter opsional yang, jika disediakan, dapat mencetak log debug di terminal, biasanya tidak ditampilkan.
-ai, --allow-incompatible	Parameter opsional yang menentukan kontrol kompatibilitas versi Soliditch yang digunakan dalam file yang disediakan. Menerima sebagai nilai: ask , skip , always . Default: ask , meminta konfirmasi.
-p, --plot	Parameter opsional yang menentukan tampilan grafik ringkasan. Menerima sebagai nilai: ask , skip , always . Default: ask , meminta konfirmasi.
-pr, --print-result	Parameter opsional yang, jika disediakan, akan membuat ringkasan hasil yang diperoleh dari cetakan analisis di terminal.
-wr, --write-result	Parameter opsional yang menentukan penyelamatan pada disk hasil yang diperoleh dari analisis masing -masing file. Menerima sebagai nilai: ask , skip , always . Default: ask , meminta konfirmasi.
-fr, --format-result	Parameter opsional yang menentukan format yang diperoleh data disimpan. Menerima sebagai nilai: json , csv . Default: json .
--debug-analysis	Parameter opsional yang, jika disediakan, akan membuat analisis debug di AST.

Misalnya, ingin menganalisis kontrak pintar untuk mengidentifikasi penggunaan pola kepemilikan dan perlu menjalankan perintah:

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

(kembali ke atas)

Lisensi

Perangkat lunak ini dirilis di bawah lisensi MIT. Lihat LICENSE untuk informasi lebih lanjut.

(kembali ke atas)

Bibliografi

• Apa itu Ethereum?
• Dokumentasi soliditas.
• Rumah resmi bahasa pemrograman Python.
• Alat lain untuk pengenalan bahasa.
• [Parser soliditas yang ahli untuk Python yang dibangun di atas tata bahasa Antlr4 yang kuat.] (Https://github.com/consensys/ python-solidity-parser)
• [Skema JSON- Rumah Skema JSON.] (Https: // json- scheme.org/)
• [Catatan rilis JSON Draft-07.
• Implementasi Spesifikasi Skema JSON untuk Python.
• M. Wohrer dan U. Zdun. "Dari bahasa khusus domain ke kode: kontrak pintar dan penerapan pola desain". Dalam: IEEE Software 37.05 (set 2020), hlm. 37–1. ISSN: 1937-4194. Doi: 10.1109/- ms.2020.293470
• Lodovica Marchesi et al. "Pola Desain untuk Optimalisasi Gas di Ethereum". Dalam: 2020 IEEE International Workshop tentang Rekayasa Perangkat Lunak Berorientasi Blockchain (IWBose) 2020.9050163
• Kontrak pintar pola desain dalam ekosistem Ethereum dan kode soliditas.
• Pola kontrak pintar yang ditulis dalam solide, dikumpulkan untuk kebaikan komunitas.
• Kompilasi pola dan praktik terbaik untuk soliditas bahasa pemrograman kontrak pintar.
• Maximilian Wohrer dan Uwe Zdun. "Kontrak Cerdas: Pola Keamanan dalam Ekosistem dan Soliditas Ethereum". Dalam: 2018 Workshop Internasional tentang Rekayasa Perangkat Lunak Berorientasi Blockchain (IWBose). - Mar. 2018, pp.2–8.doi: 10.1109/iwbose.2018.8327565
• Kontrak OpenZeppelin adalah perpustakaan untuk pengembangan kontrak pintar yang aman.

(kembali ke atas)