library

@pooltogether/v5-autotasks-library

PoolTogether hyperstructure (v5) supporting functions for the bots.

Install

yarn add @pooltogether/v5-autotasks-library

or

npm install @pooltogether/v5-autotasks-library

Usage

You can use this library in your own code, for instance if you would rather not use OpenZeppelin Defender for your automated/cron-based bots. Here's an example:

import { downloadContractsBlob } from "@pooltogether/v5-utils-js";
import { getClaimerProfitablePrizeTxs } from "@pooltogether/v5-autotasks-library";

interface Params {
  contracts: ContractsBlob;
  readProvider: Provider;
  config: GetClaimerProfitablePrizeTxsParams;
}

async function main() {
  const contracts = await downloadContractsBlob(chainId);
  const params: Params = { contracts, readProvider, config };
  const populatedTxs = getClaimerProfitablePrizeTxs(params);
}

main();

Where readProvider is any ethers Provider, and params is of the GetClaimerProfitablePrizeTxsParams type. You can then pass the list of populated transactions populatedTxs to whichever relayer/write provider you would like to send transactions with.