Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/pooltogether/v5-liquidator

Last synced: about 2 months ago
JSON representation

Host: GitHub
URL: https://github.com/pooltogether/v5-liquidator
Owner: pooltogether
License: gpl-3.0
Created: 2023-01-10T15:08:00.000Z (almost 2 years ago)
Default Branch: main
Last Pushed: 2023-06-20T23:52:49.000Z (over 1 year ago)
Last Synced: 2024-04-23T21:42:43.151Z (9 months ago)
Language: Solidity
Size: 157 KB
Stars: 9
Watchers: 3
Forks: 2
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

        


  

    

  






# PoolTogether - Liquidator Contracts

> TODO: Coveralls tag, coverage

[![built-with openzeppelin](https://img.shields.io/badge/built%20with-OpenZeppelin-3677FF)](https://docs.openzeppelin.com/)

[![GPLv3 license](https://img.shields.io/badge/License-GPLv3-blue.svg)](http://perso.crans.org/besson/LICENSE.html)

Have questions or want the latest news?


Join the PoolTogether Discord or follow us on Twitter:

[![Discord](https://badgen.net/badge/icon/discord?icon=discord&label)](https://pooltogether.com/discord)

[![Twitter](https://badgen.net/badge/icon/twitter?icon=twitter&label)](https://twitter.com/PoolTogether_)

**Documentation**


https://v4.docs.pooltogether.com

**Deployments**


- [Ethereum](https://v4.docs.pooltogether.com/protocol/deployments/mainnet#mainnet)

- [Polygon](https://v4.docs.pooltogether.com/protocol/deployments/mainnet#polygon)

- [Avalanche](https://v4.docs.pooltogether.com/protocol/deployments/mainnet#avalanche)

- [Optimism](https://v4.docs.pooltogether.com/protocol/deployments/mainnet/#optimism)

## Getting Started

The repo can be cloned from Github for contributions.

```sh

git clone https://github.com/pooltogether/liquidator

```

### Installation

To install with [**Foundry**](https://github.com/gakonst/foundry):

```sh

forge install pooltogether/liquidator

```

### Testing

To run tests:

```sh

forge test

```

To run a specific test contract:

```sh

forge test --mc 

```

To run coverage:

```sh

forge coverage

```

### Deployment

> TODO:

### Notes

`uint112` - Uniswap V2 limits to this as a safe maximum. For an 18 decimal token, this is more than a million billion tokens (1e15)