https://github.com/generationsoftware/pt-v5-flash-liquidator
PoolTogether V5 Flash Liquidator contracts
https://github.com/generationsoftware/pt-v5-flash-liquidator
pooltogether solidity
Last synced: 8 months ago
JSON representation
PoolTogether V5 Flash Liquidator contracts
- Host: GitHub
- URL: https://github.com/generationsoftware/pt-v5-flash-liquidator
- Owner: GenerationSoftware
- Created: 2023-10-24T15:55:39.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-29T16:32:33.000Z (over 1 year ago)
- Last Synced: 2025-03-02T05:22:23.374Z (12 months ago)
- Topics: pooltogether, solidity
- Language: Solidity
- Homepage:
- Size: 77.1 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Flash Liquidators
## Uniswap V3 Flash Liquidator
`UniswapFlashLiquidation`: A Uniswap V3 swap to flash liquidate yield on PoolTogether V5.
`UniswapV2WethPairFlashLiquidator`: Instantly dump yield from Prize Vaults whose assets are Uniswap LP pairs.
## Deployments
### Optimism
- `UniswapFlashLiquidation`: [`0x5927b63e88764d6250b7801ebfdeb7b6c1ac35d0`](https://optimistic.etherscan.io/address/0x5927b63e88764d6250b7801ebfdeb7b6c1ac35d0)
- `UniswapV2WethPairFlashLiquidator`: [`0xB56D699B27ca6ee4a76e68e585999E552105C10f`](https://optimistic.etherscan.io/address/0xB56D699B27ca6ee4a76e68e585999E552105C10f)
### Base
- `UniswapFlashLiquidation`: [`0xe2368DF1f78Bc5B714b7f502DE8e2B545c6Fe7EC`](https://basescan.org/address/0xe2368df1f78bc5b714b7f502de8e2b545c6fe7ec)
- `UniswapV2WethPairFlashLiquidator`: [`0x0d51a33975024e8afc55fde9f6b070c10aa71dd9`](https://basescan.org/address/0x0d51a33975024e8afc55fde9f6b070c10aa71dd9)
### Ethereum
- `UniswapFlashLiquidation`: [`0xf22Df1EB029126aDd8fB9B273Ff8c8ced8413d04`](https://etherscan.io/address/0xf22Df1EB029126aDd8fB9B273Ff8c8ced8413d04)
- `UniswapV2WethPairFlashLiquidator`: [`0xb539ef91E7A26BDDF7cD56F9a5CAFDAf48434aC9`](https://etherscan.io/address/0xb539ef91E7A26BDDF7cD56F9a5CAFDAf48434aC9)
## How to Liquidate
1. run `npm i` and `forge build`
2. set your environment vars in `.envrc`
3. run `direnv allow`
4. run `npm run liquidate:pusdce` or `npm run liquidate:pweth`
## Getting started
The easiest way to get started is by clicking the [Use this template](https://github.com/pooltogether/foundry-template/generate) button at the top right of this page.
If you prefer to go the CLI way:
```
forge init my-project --template https://github.com/pooltogether/foundry-template
```
## Development
### Installation
You may have to install the following tools to use this repository:
- [Foundry](https://github.com/foundry-rs/foundry) to compile and test contracts
- [direnv](https://direnv.net/) to handle environment variables
- [lcov](https://github.com/linux-test-project/lcov) to generate the code coverage report
Install dependencies:
```
npm i
```
### Env
Copy `.envrc.example` and write down the env variables needed to run this project.
```
cp .envrc.example .envrc
```
Once your env variables are setup, load them with:
```
direnv allow
```
### Compile
Run the following command to compile the contracts:
```
npm run compile
```
### Coverage
Forge is used for coverage, run it with:
```
npm run coverage
```
You can then consult the report by opening `coverage/index.html`:
```
open coverage/index.html
```
### Code quality
[Husky](https://typicode.github.io/husky/#/) is used to run [lint-staged](https://github.com/okonet/lint-staged) and tests when committing.
[Prettier](https://prettier.io) is used to format TypeScript and Solidity code. Use it by running:
```
npm run format
```
[Solhint](https://protofire.github.io/solhint/) is used to lint Solidity files. Run it with:
```
npm run hint
```
### CI
A default Github Actions workflow is setup to execute on push and pull request.
It will build the contracts and run the test coverage.
You can modify it here: [.github/workflows/coverage.yml](.github/workflows/coverage.yml)
For the coverage to work, you will need to setup the `MAINNET_RPC_URL` repository secret in the settings of your Github repository.