Skip to content

Latest commit

 

History

History
37 lines (31 loc) · 2.59 KB

README.md

File metadata and controls

37 lines (31 loc) · 2.59 KB
Raw

ContractTinker

ContractTinker is a prototype of automated contract repair tool for real-world solidity smart contract projects.

This tool is developed based on the Large Language Model and Program Static Analysis tool Slither.

A brief introduction video has been uploaded to Youtube.

Workflow of ContractTinker

Workflow The workflow of ContractTinker is illustrated in the above Figure. Firstly, users input the project and audit report. Then ContractTinker performs two steps: It analyzes the project to extract an entire dependency graph and extracts the valid structural information from reports. Upon obtaining the necessary elements, the tool performs vulnerability localization to filter out useless elements, and builds a contextual dependency graph (CDG) as well as program slices. During patch generation, we adopted the "chain of thought" concept, breaking down the task to implement patch inference step by step. Finally, the tool employs another independent LLM to evaluate the generated patch code and refine it if it does not fix the vulnerability. The final output is validated patches.

Packgae Requirements

ContractTinker requires:

  • Python 3.8+
  • Slither 0.10.3
  • slither-analyzer
  • Solc-select v1.0.4
  • npm for install external dependency libraries
  • Solc 0.8.0+commit.c7dfd78e.Linux.g++
  • openai 1.25.0
  • transformers 4.41.2
  • networkX 3.2.1

Usage of ContractTinker

We provide a command-line interface for developers to use ContractTinker. The detail of arguments is shown below to illustrate its usage:

  • --report_path and --project_path: used to specify the exact report and project paths of the corresponding vulnerabilities.
  • --vul_name: specifies the vulnerability that needs to be repaired as included in the audit report.
  • --solc_remaps: associates particular external dependency libraries (e.g., OpenZeppelin) to this project.
  • --output: used to store generated patches.

After preparing all inputs, the user can use the \textit{CompilationChecker} module to test if the project can compile under the current environment. If the project cannot compile, the user needs to download the required packages as suggested by \textit{CompilationChecker}. Then, the user runs

python patch_generate.py --report_path "{your report path}" --project_path "{your project path}" --vul_name "{vulnerability name}" --solc_remaps "{rely external libiaries}" --output "{your designated path}"

with the aforementioned arguments to generate patches for the specified vulnerability. Finally, the patch will be stored in the designated path.