# @pooltogether/pooltogether-contracts
> PoolManager Prize Linked Savings Account Pool Smart Contracts
Latest version **3.4.5** (published 2021-08-24) · GPL-3.0 license · 0 weekly downloads
## Install
```sh
npm install @pooltogether/pooltogether-contracts
pnpm add @pooltogether/pooltogether-contracts
yarn add @pooltogether/pooltogether-contracts
bun add @pooltogether/pooltogether-contracts
```
## Health
**Score 15/100 (F)** — status: abandoned.
Positive: no vulnerabilities.
Warnings: low downloads; no types; no esm support; large bundle.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 3.4.5 |
| Published | 2021-08-24 |
| First published | 2020-01-29 |
| Weekly downloads | 0 |
| License | GPL-3.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 6 |
| Unpacked size | 56.7 MB |
| Known vulnerabilities | 0 (+4 in 1 direct dependencies) |
| Install scripts | no |
| Maintainers | asselstine, chuckbergeron, dylandesrosier, aodhgan, pierrick, kamesdev |
## Links
- npm: https://www.npmjs.com/package/@pooltogether/pooltogether-contracts
- npm.io page: https://npm.io/package/@pooltogether/pooltogether-contracts
## Dependencies (6)
- [@pooltogether/fixed-point](https://npm.io/package/@pooltogether/fixed-point.md) 1.0.0-beta.2
- [sortition-sum-tree-factory](https://npm.io/package/sortition-sum-tree-factory.md) 0.1.0
- [@openzeppelin/contracts-upgradeable](https://npm.io/package/@openzeppelin/contracts-upgradeable.md) 3.4.0
- [@pooltogether/uniform-random-number](https://npm.io/package/@pooltogether/uniform-random-number.md) 1.0.0-beta.1
- [@pooltogether/yield-source-interface](https://npm.io/package/@pooltogether/yield-source-interface.md) ^1.0.1
- [@pooltogether/pooltogether-rng-contracts](https://npm.io/package/@pooltogether/pooltogether-rng-contracts.md) 1.0.0
## Recent versions
- 3.4.5 (latest) — 2021-08-24
- 3.4.1-alpha.6 (alpha) — 2021-07-15
- 3.2.0-beta.4 (beta) — 2021-02-15
- 3.4.4 — 2021-07-19
- 3.4.3 — 2021-07-17
- 3.4.1-alpha.5 — 2021-06-29
- 3.4.1-alpha.4 — 2021-06-29
- 3.4.1-alpha.3 — 2021-06-29
- 3.4.1-alpha.2 — 2021-06-28
- 3.4.1-alpha.1 — 2021-06-28
- 3.4.2 — 2021-06-28
- 3.3.12 — 2021-06-28
- 3.4.1 — 2021-06-28
- 3.3.11 — 2021-06-25
- 3.4.0 — 2021-06-25
- … 79 more at https://npm.io/package/@pooltogether/pooltogether-contracts/versions
## 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://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.
---
_Source: https://npm.io/package/@pooltogether/pooltogether-contracts · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._