# @pooltogether/owner-manager-contracts

> PoolTogether Owner Manager Contracts

Latest version **1.1.0** (published 2021-09-20) · MIT license · 0 weekly downloads

## Install

```sh
npm install @pooltogether/owner-manager-contracts
pnpm add @pooltogether/owner-manager-contracts
yarn add @pooltogether/owner-manager-contracts
bun add @pooltogether/owner-manager-contracts
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2021-09-20 |
| First published | 2021-08-31 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 509.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | asselstine, chuckbergeron, dylandesrosier, aodhgan, pierrick, kamesdev |

## Links

- npm: https://www.npmjs.com/package/@pooltogether/owner-manager-contracts
- npm.io page: https://npm.io/package/@pooltogether/owner-manager-contracts

## Recent versions

- 1.1.0 (latest) — 2021-09-20
- 1.0.0 — 2021-09-20
- 1.0.0-beta.2 — 2021-09-14
- 1.0.0-beta.1 — 2021-09-09
- 0.0.1-beta.3 — 2021-08-31
- 0.0.1-beta.2 — 2021-08-31
- 0.0.1-beta.1 — 2021-08-31

## README

# PoolTogether Owner Manager Contracts
[![Coverage Status](https://coveralls.io/repos/github/pooltogether/owner-manager-contracts/badge.svg?branch=master)](https://coveralls.io/github/pooltogether/owner-manager-contracts?branch=master)

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

Abstract ownable contract with additional manager role

Contract module based on Ownable which provides a basic access control mechanism, where
there is an account (a draw manager for example) that can be granted exclusive access to
specific functions.

The manager account needs to be set using {setManager}.
 
This module is used through inheritance. It will make available the modifier
`onlyManager`, which can be applied to your functions to restrict their use to the manager.


## Usage
This repo is setup to compile (`nvm use && yarn compile`) and successfully pass tests (`yarn test`)


# Installation
Install the repo and dependencies by running:
`yarn`

## Deployment
These contracts can be deployed to a network by running:
`yarn deploy <networkName>`

## Verification
These contracts can be verified on Etherscan, or an Etherscan clone, for example (Polygonscan) by running:
`yarn etherscan-verify <ethereum network name>` or `yarn etherscan-verify-polygon matic`


# Testing
Run the unit tests locally with:
`yarn test`

## Coverage
Generate the test coverage report with:
`yarn coverage`

---
_Source: https://npm.io/package/@pooltogether/owner-manager-contracts · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._