README.md

TheSentinel

A Blockchain Wallet Transaction Security Platform

Description

A Secure Scanning Platform for Blockchain Wallet Transactions.
Porject Report: Link
Only support Ethereum right now

Main Features

• Transaction history query and visualization
  • Data Sources: Ethescan API / GoPlus Security API
• Blacklist address and website detection
  • Data Source: GoPlus Security API
• Smart contract security scanning and reporting
  • Data Source: Slither

Example Vedio

Please Check in the Path: static/pic/example_vedio.mp4

Running Environment

1. Upper than Python 3.10
2. Windows/MacOS/Linux

Installation

1. Clone the repository.

2. Install the required dependencies by running the following command:

   pip3 install -r requirements.txt

Configuration

1. Create a file named .env in the project root directory.

2. Open the .env file and add the following line:

   etherscan_api=YOUR_API_KEY
   

   Replace YOUR_API_KEY with your actual Etherscan API key. API key apply in https://etherscan.io/

3. If you need to change running port, open the app.py file and change in line 20:

   app.run(port=5008,host='0.0.0.0')
   

   Replace 5008 with other port.

4. Use python3 app.py to running the Project. If you want to running on background or hold a website, use nohup python3 app.py & in Linux system.

System Structure

System Component

Future To-do List

• Mobile Screen Adaptability Development
• Deep Tracking in Transaction Visualization
• Support Blockchain Wallet Connection
  • MetaMask
  • Coinbase
  • Trust Wallet
  • ....
• Muti-chain Development
• Futher User Functions Development (Subscription etc.)

Acknowledgements List

Not Particular Order

• Ethereum
• Ethescan
• GoPlus Security
• Newcastle University
• My Tutor and Supervisor
• @whatly2

Final Comment

The entire project was completed by myself, and this is the final project of my undergraduate degree at Newcastle University.