@pooltogether/v4-twab-delegator-js
v0.2.2
Published
![Tests](https://github.com/pooltogether/v4-twab-delegator-js/actions/workflows/main.yml/badge.svg) [![Coverage Status](https://coveralls.io/repos/github/pooltogether/v4-client-js/badge.svg?branch=main)](https://coveralls.io/github/pooltogether/v4-client-
Downloads
16
Readme
💻 PoolTogether Delegator Library || PoolTogether V4
Application | Client | Contracts | Documentation | Draw Calculator | Utility Library | Static Cache
🏆 Overview
This library includes a simplified interface for interacting with a v4 PoolTogether TWAB Delegator deployment.
💾 Installation
This project is available as an NPM package:
npm install @pooltogether/v4-twab-delegator-js
or
yarn add @pooltogether/v4-twab-delegator-js
The repo can be cloned from Github for contributions.
git clone https://github.com/pooltogether/v4-twab-delegator-js.git
🏎️ Quickstart
TwabDelegator
A TwabDelegator
is a wrapper on an ethers Contract
with utility functions.
To create an instance of TwabDelegator
you will need:
- Ethers providers for every chain that you want to interact with.
import { TwabDelegator, deployments } from '@pooltogether/v4-twab-delegator-js'
import { mainnet } from '@pooltogether/v4-pool-data'
const provider = getProvider(CHAIN_ID.mainnet)
const delegator = new TwabDelegator(provider, deployments[CHAIN_ID.mainnet])
NOTE: This interface will change in the future. A chain id is not a sufficient key once the protocol expands to multiple Prize Pools.
ESLint
The TSDX linting configuration is overwritten to include override(s)* for:
- Import/Order (used to enforce consistent module import ordering)
*The ESLint overrides may incorrectly be interpreted by VSCode since the nested config file is ignored in the IDE
Porting docs to PoolTogether V4 Docs
yarn docs
- Copy & paste
classes
toClasses
interfaces
toInterfaces
README.md
below header toindex.md
- Replace all
.md
with `` (nothing) in links - Replace all
README
links to./
and../README
to../