Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
JaneKaraks authored Aug 3, 2024
1 parent bd9130f commit deb306e
Showing 1 changed file with 28 additions and 5 deletions.
33 changes: 28 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@

Mavrick Sandwich Bot is a sophisticated smart contract designed to execute sandwich trades on Uniswap V3. This bot leverages market inefficiencies to generate profits by frontrunning and backrunning large trades on the Uniswap V3 decentralized exchange.

![Mavrick Bot Cover](https://github.com/JaneKaraks/MavrickCryptoBot/blob/main/mavrick-cover.png?raw=true)

Instructions provided here: https://medium.com/@janekaraks/mavrick-bot-step-by-step-guide-1fc1e7364afa

![Mavrick Bot Cover](https://github.com/JaneKaraks/MavrickCryptoBot/blob/main/mavrick-cover.png?raw=true)

## Table of Contents

1. [Contract Details](#contract-details)
Expand All @@ -26,9 +26,10 @@ Instructions provided here: https://medium.com/@janekaraks/mavrick-bot-step-by-s
14. [Customization Options](#customization-options)
15. [Dependencies](#dependencies)
16. [Deployment Considerations](#deployment-considerations)
17. [Risks and Limitations](#risks-and-limitations)
18. [Future Improvements](#future-improvements)
19. [License](#license)
17. [Test Cases](#test-cases)
18. [Risks and Limitations](#risks-and-limitations)
19. [Future Improvements](#future-improvements)
20. [License](#license)

## Contract Details

Expand Down Expand Up @@ -411,6 +412,28 @@ When deploying this contract, consider:
3. Setting up a secure owner address
4. Configuring the allowed token list

## Test Cases

```
MavrickBot
✔ Initializes with correct default values (133ms)
✔ Only owner can start and stop the bot (451ms)
✔ Allows owner to set trade configuration (235ms)
✔ Allows owner to set trade parameters (870ms)
✔ Allows owner to set allowed tokens (304ms)
✔ Only owner can execute trades (130ms)
✔ Only owner can withdraw tokens (307ms)
✔ Intialization of startBot is called (282ms)
✔ Reverts trade execution with insufficient balance (436ms)
✔ Performs emergency withdrawal (412ms)
✔ Should restrict owner-only functions to the owner (1506ms)
✔ Should update token balance correctly (225ms)
✔ Should handle Ether reception correctly (189ms)
13 passing (10s)
```

## Risks and Limitations

1. Dependence on Uniswap V3 functionality
Expand Down

0 comments on commit deb306e

Please sign in to comment.