Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
sr2echa authored Dec 1, 2023
1 parent f0038db commit 4c674d5
Showing 1 changed file with 22 additions and 82 deletions.
104 changes: 22 additions & 82 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,94 +1,34 @@
![image](https://github.com/sr2echa/dirty-moni-detector/assets/65058816/f2d86ce3-9d19-499a-bc6e-7ef83f8f7083)

---
> [!NOTE]
> **Made for RevaHack 23 ❤️** <br>
> <samp> We even won the **1st place** and were the **Title Winners of RevaHack 23**! More about it here 👉 <a href="https://devfolio.co/projects/dmd-dirty-money-detector-54b2">Devfolio</a> </samp>
Here's the properly formatted content:

## Frontend
### STREAMLIT: [https://dirtymoneydetector.streamlit.app](https://dirtymoneydetector.streamlit.app)
🔗 [Source Code](./web)
---
### API LINK: [https://dirtyapi.replit.app/](https://dirtyapi.replit.app)

## API Reference
### Path: `/api/<wallet_add>`
### Output:
```json
{
"Address": "string",
"Avg min between received tnx": "float",
"Avg min between sent tnx": "float",
"AvgValSent": "float",
"AvgValueReceived5Average": "float",
"AvgValueSentToContract": "int",
"ERC20AvgTimeBetweenRec_Tnx": "float",
"ERC20AvgTimeBetweenSent_Tnx": "float",
"ERC20AvgVal_Rec": "float",
"ERC20AvgVal_Sent": "float",
"ERC20MaxVal_Rec": "float",
"ERC20MaxVal_Sent": "float",
"ERC20MinVal_Rec": "float",
"ERC20MinVal_Sent": "float",
"ERC20MostRecTokenType": "string",
"ERC20MostSentTokenType": "string",
"ERC20TotalEtherSentContract": "float",
"ERC20TotalEther_Received": "float",
"ERC20TotalEther_Sent": "float",
"ERC20UniqRecContractAddr": "int",
"ERC20UniqRecTokenName": "int",
"ERC20UniqRec_Addr": "int",
"ERC20UniqSentTokenName": "int",
"ERC20UniqSent_Addr": "int",
"MaxValSent": "float",
"MaxValueReceived": "float",
"MaxValueSentToContract": "float",
"MinValSent": "float",
"MinValueReceived": "float",
"MinValueSentToContract": "float",
"NumberofCreated_Contracts": "int",
"Received_tnx": "int",
"Sent_tnx": "int",
"Time Diff between first and_last (Mins)": "float",
"TotalERC20Tnxs": "int",
"TotalEtherBalance": "float",
"TotalEtherReceived": "float",
"TotalEtherSent": "float",
"TotalEtherSent_Contracts": "float",
"TotalTransactions": "int",
"UniqueReceivedFrom_Addresses": "int",
"UniqueSentTo_Addresses20": "int"
}
```
---
## ML Model
[sourcecode](./ML)

## How to Use
## The Problem It Solves
In the world of digital finance, the rise of cryptocurrencies has been meteoric. While they offer unprecedented opportunities for investment and transaction, they have also opened up new avenues for financial misconduct, such as fraud and money laundering. Traditional methods of tracking and scrutinizing financial transactions are often ill-suited to the decentralized and anonymous nature of blockchain-based currencies. This is where "DMD" steps in as a game-changer.
Our web app, "DMD," is designed to tackle this very challenge by providing a robust analysis of wallet transactions within the blockchain ecosystem. Here’s how "DMD" stands out and solves pressing problems:

### `Fraud Detection`
By monitoring transaction patterns, "DMD" can identify anomalies that may indicate fraudulent activity. This preemptive detection helps users and financial institutions mitigate risks before they balloon into significant threats.

1. Clone the Repository
```bash
git clone https://github.com/sr2echa/dirty-moni-detector.git
```
### `Anti-Money Laundering (AML)`
"DMD" applies advanced algorithms to scrutinize the rate and nature of transactions, as well as smart contract interactions, to flag potential money laundering activities, ensuring compliance with AML regulations.

2. Install all requirments and dependencies
```bash
pip install -r requirments.txt
```
3. Run the application:
```bash
streamlit run website.py
```
### `User Empowerment`
By providing detailed analyses and reports, "DMD" empowers users with knowledge about their transaction habits and network health, enabling informed decision-making.

## Tech Stack
<figure style="text-align: right;">
<img src="web/Group 323.png" alt="Tech Stack" style="width:300px;height:300px;">
</figure>
### `Boosting Confidence`
"DMD" instills confidence in cryptocurrency users, enabling them to engage in digital transactions without fear of hidden dangers. It fosters a safer environment for all participants in the crypto market.

- [x] Streamlit
- [x] Tensorflow
- [x] Github
- [x] replit
- [x] Flask
- [x] Seaborn
<br>

In summary, "DMD" is not just a tool—it's an essential ally in maintaining the integrity of financial transactions within the digital space. It transforms the complex and often opaque landscape of blockchain transactions into a more secure and transparent domain, ensuring that the digital economy remains a level playing field for all participants.

---


> [!IMPORTANT]
> Documentation of the codebase has been shifted to [docs.md](./docs.md)

0 comments on commit 4c674d5

Please sign in to comment.