README.md

SmartContractScanning

HKUS3Lab - Scripts, modifications of repos, and other utils for smart contract scanning.

Table of Contents

• SmartContractScanning
  • Table of Contents
  • Installation & Setup
  • Usage
  • Contributing
  • License

Installation & Setup

1. Download the Dockerfile.
2. Run docker build -t <image_name> . to build the image.
3. Run docker run -it <image_name> to run the image.
4. Run pip show slither-analyzer to find Slither's path and make changes to Slither as described in this file.

Usage

1. Create an API key at etherscan.io and add it to scripts/key.py: api_key = "EXAMPLEKEYXXXXXXXXX"
2. Create a directory for the contracts you want to scan. For example, mkdir ProjectA
3. Run python scripts/scan.py 0x1234567890123456789012345678901234567890 ProjectA/ to scan the contract at address 0x1234567890123456789012345678901234567890. The results will be saved in ProjectA/<contract_name>/

Contributing

License

MIT © HKUS3Lab