Skip to content

Latest commit

 

History

History
57 lines (48 loc) · 1.96 KB

README.md

File metadata and controls

57 lines (48 loc) · 1.96 KB
Raw

uniswap-sushiswap-arbitrage

Smart contract for performing arbitrage between Uniswap and Sushiswap

Features:

The smart contract SimpleArbitrage alows a user to deposit WETH and make an arbitrage between the 2 exchanges and ensures that the operation is always profitable by checking that the price difference is always higher than the payed fees

Usage:

Installation & Setup:

  1. Installing Brownie: Brownie is a python framework for smart contracts development,testing and deployments. It's quit like HardHat but it uses python for writing test and deployements scripts instead of javascript. Here is a simple way to install brownie.

     pip install --user pipx
 pipx ensurepath
 # restart your terminal
 pipx install eth-brownie

    Or if you can't get pipx to work, via pip (it's recommended to use pipx)

    pip install eth-brownie

    Install ganache-cli:

     npm install -g ganache-cli

  2. Clone the repo:

    git clone https://github.com/kaymen99/uniswap-sushiswap-arbitrage.git
cd uniswap-sushiswap-arbitrage

  3. Set your environment variables:

    To be able to deploy to real testnets you need to add your PRIVATE_KEY (You can find your PRIVATE_KEY from your ethereum wallet like metamask) and the infura project Id (just create an infura account it's free) to the .env file:

    PRIVATE_KEY=<PRIVATE_KEY>
WEB3_INFURA_PROJECT_ID=<< YOUR INFURA PROJECT ID >>

How to run:

To start an arbitrage on the mainnet fork (for testing purposes only, you can also use the kovan testnet) you just need to run the command :

brownie run scripts/arbitrage.py --network=mainnet-fork

Testing:

The tests for the smart contract can be found in the tests folder

You can run all the tests by :

brownie test

Or you can test each function individualy:

brownie test -k <function name>