search

Byont-Ventures / smart-contract-analysis-tools

0 stars 1 forks source link

[Ready] improve documentation #28

Closed enzoevers closed 1 year ago

enzoevers commented 1 year ago

@Vitality-Booster Could you check if the text in https://github.com/Byont-Ventures/smart-contract-analysis-tools/blob/8dbab0d4c67810c23b3610958ddea77d9cf95a06/DeepDive.md is understandable? Specifically the headers "Satisfiable Modulo Theory (SMT)" and "Symbolic execution".

Vitality-Booster commented 1 year ago

As I mentioned, I believe the file would benefit from a bit more overall context, telling why do I need to know that, what the analysis checks are used for, etc. And check it with Grammarly to fix some typos. Maybe, it would also be better to put Symbolic execution before SMT checker

enzoevers commented 1 year ago

I have made some updates. There is now a short introduction to the different techniques. Then both examples have a small solidity function to be used as an example. I decided to keep the SMT example before the Symbolic execution as SMT is the basis. The short introduction mentioned Symbolic execution already.