https://github.com/pooltogether/pooltogether-pods-upkeep

Upkeep integration with PoolTogether pods
https://github.com/pooltogether/pooltogether-pods-upkeep

Last synced: about 2 months ago
JSON representation

Upkeep integration with PoolTogether pods

• Host: GitHub
• URL: https://github.com/pooltogether/pooltogether-pods-upkeep
• Owner: pooltogether
• Created: 2021-04-16T22:14:36.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2021-06-24T23:36:29.000Z (over 3 years ago)
• Last Synced: 2024-04-23T21:42:38.548Z (9 months ago)
• Language: JavaScript
• Size: 629 KB
• Stars: 2
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# pooltogether-pods-upkeep

[![Coverage Status](https://coveralls.io/repos/github/pooltogether/pooltogether-pods-upkeep/badge.svg?branch=master)](https://coveralls.io/github/pooltogether/pooltogether-pods-upkeep?branch=master)

![Tests](https://github.com/pooltogether/pooltogether-pods-upkeep/actions/workflows/main.yml/badge.svg)

PoolTogether Operations contracts is PoolTogether's integration with ChainLinks Upkeep system for pods.

## How it works

The goal of this system is to automate calling the `batch` function of the PoolTogether governance owned prize pool pods.

A registry of these prize pools exists (as an Ownable MappedSinglyLinkedList) and logic is run to see if the batch function requires running. This is determined by

a time period (in blocks): `upkeepBlockInterval`

The upkeepers performing the upkeep are compensated in LINK so the PrizeStrategyUpkeep contact needs to maintain a healthy balance of LINK. 

# Installation

Install the repo and dependencies by running:

`yarn`

## Deployment

These contracts can be deployed to a network by running:

`yarn deploy `

# Testing

Run the unit tests locally with:

`yarn test`

## Coverage

Generate the test coverage report with:

`yarn coverage`