52 clean repo and remove sandwich

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021-2025 draganrakita
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,9 +1,63 @@
 # Grouper
 
-## PVP
+## What is grouper
+
+Grouper is a fourmeme sniper bot built on [Alloy](https://github.com/alloy-rs/alloy) that is triggered by on-chain trading activity to drive its buy and sell decisions.
+
+Features:
+- Sends private transactions—no worries about slippage or sandwich attacks  
+- Uses SQLite for data storage: works out of the box with zero extra config  
+- Recognizes bundle transactions  
+- Trades on both Fourmeme and PancakeSwap platforms
+- Calculates migration progress
+- Integrated with Telegram for real-time alerts on bot activity  
+- Market-driven execution with highly customizable strategies
+
+## Quick start
+
+1. In the root directory, create a `.env` file based on `.env.example`.
+
+   ```bash
+   # account
+   BOT_PRIVATE_KEY=
+
+   # rpc
+   BLOXROUTE_AUTH_HEADER=
+   IPC_URL=
+
+   # tg bot
+   TELEGRAM_BOT_TOKEN=
+   TELEGRAM_BOT_CHAT_ID=
+   ```
+
+2. Update the config base on your strategy, or just use the default strategy for quick start.
+
+3. Start the bot:
 
-1. Add `.env` file
-2. Start the bot:
 ```bash
-make pvp
-```
+cargo run .
+```
+
+## Acknowledgements
+
+This forumeme sniper bot only provides a framework and a default trading strategy; it does not guarantee profit. Developers need to conduct their own research and formulate their own trading strategies. Any property loss is not related to this repository.
+
+None of this would have been possible without them, so big shoutout to the materials below:
+
+- [alloy](https://github.com/alloy-rs/alloy): Provided comprehensive and convenient blockchain interaction tools;
+- [burberry](https://github.com/tonyke-bot/burberry): Provided a framework for transaction execution, which itself was modified from [artemis](https://github.com/paradigmxyz/artemis/)
+- Some very outstanding papers, which provide theoretical assistance:
+  - [A Midsummer Meme's Dream: Investigating Market Manipulations in the Meme Coin Ecosystem](https://arxiv.org/abs/2507.01963)
+  - [Ready, Aim, Snipe! Analysis of Sniper Bots and their Impact on the DeFi Ecosystem](https://dl.acm.org/doi/10.1145/3543873.3587612)
+  - [Token Spammers, Rug Pulls, and SniperBots: An Analysis of the Ecosystem of Tokens in Ethereum and in the Binance Smart Chain (BNB)](https://arxiv.org/abs/2206.08202)
+
+
+
+
+
+
+
+
+
+
+

doc/paper/README.md

@@ -0,0 +1,6 @@
+## Paper
+- 2507.01963v1: Systematically introduces the market situation, price manipulation, and various methods of money laundering and running away with the money of Meme tokens. A large amount of data is used as evidence. Its core conclusion is that a significant increase in the price of a Meme token is highly likely to be due to manipulation.
+
+- 3543873.3587612: Discusses the situation of sniping robots on ETH and BSC. How to snipe, the risks of sniping, the returns from sniping, security issues, and how to detect sniping robots.
+
+- 2206.08202v3: Focuses on the connection between sniping robots and RugPull.

examples/cal_curve_progress.rs

@@ -1,7 +1,7 @@
 use alloy::{primitives::address, providers::ProviderBuilder};
-use grouper::pvp::abi::Fourmeme::FourmemeInstance;
-use grouper::pvp::interface::oracle::IOracle;
-use grouper::pvp::trade::oracle::Oracle;
+use grouper::abi::Fourmeme::FourmemeInstance;
+use grouper::interface::oracle::IOracle;
+use grouper::trade::oracle::Oracle;
 use std::{env, sync::Arc};
 
 #[tokio::main]

research/models.md

@@ -0,0 +1,10 @@
+## Models
+
+![fourmeme-models](./assets/fourmeme-models.png)
+
+- Model A: It's all over.
+- Model B: It first sells off to drive down the price, but not too much below the opening price, and then pulls the market back up.
+- Model C: Gradually increase the price, suddenly rugpull
+- Model D: Rapid surge, then rugpull
+- Model E: The price barely changed after the migration, then it was pumped up, and finally, a rugpull occurred.
+- Model F: A surge in price, a wave of selling, a single explosive price hike, and finally a rugpull.