Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pooltogether/swappable-yield-source
Wraps any PoolTogether Yield Source and adds the ability to swap between any PoolTogether Yield Source
https://github.com/pooltogether/swappable-yield-source
Last synced: about 2 months ago
JSON representation
Wraps any PoolTogether Yield Source and adds the ability to swap between any PoolTogether Yield Source
- Host: GitHub
- URL: https://github.com/pooltogether/swappable-yield-source
- Owner: pooltogether
- Created: 2021-06-08T14:56:13.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2021-08-31T23:59:26.000Z (over 3 years ago)
- Last Synced: 2024-04-23T21:42:41.207Z (9 months ago)
- Language: TypeScript
- Size: 1.44 MB
- Stars: 4
- Watchers: 3
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# PoolTogether Swappable Yield Source
[](https://github.com/pooltogether/swappable-yield-source/actions/workflows/fork.yml)
[](https://github.com/pooltogether/swappable-yield-source/actions/workflows/coveralls.yml)
[](https://coveralls.io/github/pooltogether/swappable-yield-source?branch=main)
[](https://docs.openzeppelin.com/)
Wraps any [PoolTogether Yield Source](https://docs.pooltogether.com/protocol/yield-sources) and adds the ability to swap between any PoolTogether Yield Source.
# Usage
## Deployment
Follow [Installation](#installation) instructions.
The Swappable Yield Source needs to be initialized with a PoolTogether Yield Source.
Yield Source addresses are available in `Constants.ts`.
To initialize the Swappable Yield Source with the Yield Source you want to use, you need to modify the following line in `deploy/deploy.ts`:
https://github.com/pooltogether/swappable-yield-source/blob/71b6810f821ff8eadc2b11238524054c3f5b836f/deploy/deploy.ts#L104
To deploy, run:
`yarn deploy `
## Development
Clone this repository and enter the directory.
### Installation
Install dependencies:
```
yarn
```
This project uses [Yarn 2](https://yarnpkg.com), dependencies should get installed pretty quickly.
### Env
We use [direnv](https://direnv.net) to manage environment variables. You'll likely need to install it.
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
```
### Test
We use the [Hardhat](https://hardhat.org) ecosystem to test and deploy our contracts.
First, you will need to deploy contracts in local.
Start the hardhat node by running: `yarn start-fork`
Then to deploy contracts locally, run: `yarn deploy-fork`
To run unit tests:
```
yarn test
```
To run [solhint](https://protofire.github.io/solhint/) and tests:
```
yarn verify
```
To run coverage:
```
yarn coverage
```
### Mainnet fork
Before deploying, you can make sure your implementation works by deploying a Yield Source Prize Pool and swapping the Yield Source on a fork of Mainnet.
Start Mainnet fork in a terminal window with the command:
```
yarn start-fork
```
In another window, start the scripts to deploy and create a Aave Yield Source Prize Pool, deposit Dai into it, swap to another Yield Source, award the prize and withdraw.
```
yarn run-fork
```
You can also run these commands concurrently with:
```
yarn mainnet-fork
```
### Deploy
Deployment script can be found in `deploy/deploy.ts`. To deploy, simply run:
```
yarn deploy
```
Once deployment is done, you can verify your contracts on [Etherscan](https://etherscan.io) by typing:
```
yarn etherscan-verify
```
### Code quality
[Prettier](https://prettier.io) is used to format TypeScript code. Use it by running:
```
yarn format
```
[Solhint](https://protofire.github.io/solhint/) is used to lint Solidity files. Run it with:
```
yarn hint
```
[TypeChain](https://github.com/ethereum-ts/Typechain) is used to generates types for scripts and tests. Generate types by running:
```
yarn typechain
```