Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pooltogether/pooltogether-pool-contracts
PoolTogether prize-linked savings game Solidity smart contracts.
https://github.com/pooltogether/pooltogether-pool-contracts
Last synced: about 1 month ago
JSON representation
PoolTogether prize-linked savings game Solidity smart contracts.
- Host: GitHub
- URL: https://github.com/pooltogether/pooltogether-pool-contracts
- Owner: pooltogether
- License: gpl-3.0
- Created: 2019-03-06T17:34:43.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2023-11-10T17:56:29.000Z (about 1 year ago)
- Last Synced: 2024-04-23T21:42:38.509Z (8 months ago)
- Language: JavaScript
- Homepage: https://pooltogether.com
- Size: 9.36 MB
- Stars: 362
- Watchers: 16
- Forks: 169
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-dao - PoolTogether Prize Savings Protocol
README
# PoolTogether Prize Savings Protocol
[](https://circleci.com/gh/pooltogether/pooltogether-pool-contracts) [](https://coveralls.io/github/pooltogether/pooltogether-pool-contracts?branch=master) [](https://docs.openzeppelin.com/)
The [PoolTogether](https://www.pooltogether.com/) Prize Savings Protocol Ethereum smart contracts.
For an overview of the concepts and API please see the [documentation](https://v3.docs.pooltogether.com/)
# Setup
This project is available as an NPM package:
```bash
$ yarn add @pooltogether/pooltogether-contracts
```
# Usage
## Artifacts
There are deployment artifacts available in the `deployments/` directory. For example, to pull in the PoolWithMultipleWinnersBuilder artifact:
```javascript
const PoolWithMultipleWinnersBuilder = require('@pooltogether/pooltogether-contracts/deployments/rinkeby/PoolWithMultipleWinnersBuilder.json')
const {
abi,
address,
receipt
} = PoolWithMultipleWinnersBuilder
```
## ABIs
Application Binary Interfaces for all PoolTogether contracts and related contracts are available in the `abis/` directory.
For example, to pull in the PrizePool ABI:
```javascript
const PrizePool = require('@pooltogether/pooltogether-contracts/abis/PrizePool.json')
```
# Development
First clone this repository and enter the directory.
Install dependencies:
```
$ yarn
```
We use [direnv](https://direnv.net/) to manage environment variables. You'll likely need to install it.
# Testing
We use [Hardhat](https://hardhat.dev) and [hardhat-deploy](https://github.com/wighawag/hardhat-deploy)
To run unit & integration tests:
```sh
$ yarn test
```
To run coverage:
```sh
$ yarn coverage
```
To run fuzz tests:
```sh
$ yarn echidna
```
# Fork Testing
Ensure your environment variables are set up. Make sure your Alchemy URL is set. Now start a local fork:
```sh
$ yarn start-fork
```
Setup account impersonation and transfer eth:
```sh
$ ./scripts/setup.sh
```
# Deployment
## Deploy Locally
Start a local node and deploy the top-level contracts:
```bash
$ yarn start
```
NOTE: When you run this command it will reset the local blockchain.
## Connect Locally
Start up a [Hardhat Console](https://hardhat.dev/guides/hardhat-console.html):
```bash
$ hardhat console --network localhost
```
Now you can load up the deployed contracts using [hardhat-deploy](https://github.com/wighawag/hardhat-deploy):
```javascript
> await deployments.all()
```
If you want to send transactions, you can get the signers like so:
```javascript
> let signers = await ethers.getSigners()
```
Let's mint some Dai for ourselves:
```javascript
> let dai = await ethers.getContractAt('ERC20Mintable', (await deployments.get('Dai')).address, signers[0])
> await dai.mint(signers[0]._address, ethers.utils.parseEther('10000'))
> ethers.utils.formatEther(await dai.balanceOf(signers[0]._address))
```
## Deploy to Live Networks
Copy over .envrc.example to .envrc
```
$ cp .envrc.example .envrc
```
Make sure to update the enviroment variables with suitable values.
Now enable the env vars using [direnv](https://direnv.net/docs/installation.html)
```
$ direnv allow
```
Now deploy to a network like so:
```
$ yarn deploy rinkeby
```
It will update the `deployments/` dir.