PoolTogether TWAB Delegator

The PoolTogether V4 TWAB Delegator contract allows accounts to easily delegate their chance of winning to other accounts. See the PoolTogether V4 Docs for more details on chance and the TWAB.

There are three roles that relate to this contract:

• Delegators
• Delegatees
• Representatives

Delegators

Delegators are accounts that want to delegate their chance to win to another account. They do so using delegation "slots". Each delegation slot corresponds to a smart contract deployed as a minimal proxy. This contract holds the tickets and delegates the chance of the held tickets to the delegatee.

Delegatees

Delegatees are those who have tickets delegated to them. The delegatee gets a higher chance to win thanks to the delegation, but they don't have access to the underlying funds.

Representatives

Representatives are accounts that can manage delegations for a delegator. They can create and update the delegations, but cannot withdraw any funds. This enables smart contracts to manage delegations, or even a human representative.

User Flow

The main user flow is that a delegator delegates tickets to a delegatee. The flow proceeds like so:

1. Delegator creates a delegation for the given slot:

createDelegation(address delegatorAddress, uint256 slotIndex, address delegatee, uint256 lockDuration)

2. Delegator funds the delegation (transfers tickets into the delegation)

fundDelegation(address delegator, uint256 slotIndex, uint256 amount)

If a delegator wishes a representative to manage their delegations for them, then the delegator can stake on the contract instead. The representative can use the stake to create delegations, but cannot withdraw the stake.

The staking and rep flow looks like so:

1. Delegator stakes tickets into the contract:

stake(address to, uint256 amount)

2. Delegator adds a rep:

setRepresentative(address rep, bool isRep)

The representative would follow a similar flow to create a delegation, but would instead fund from the stake:

1. Delegator creates a delegation for the given slot:

createDelegation(address delegatorAddress, uint256 slotIndex, address delegatee, uint256 lockDuration)

2. Delegator funds the delegation (transfers tickets into the delegation)

fundDelegationFromStake(address delegator, uint256 slotIndex, uint256 amount)

Permit & Multicall

This contract implements the Multicall interface which allows EOAs to batch transactions together. It also implements a special permitAndMulticall function so that users can also approve the ticket contract before running transactions, allowing them to create a delegation in a single tx.

Development

1. Clone this repo: git clone git@github.com:pooltogether/pooltogether-contracts-template.git <DESTINATION REPO>
2. Create repo using Github GUI
3. Set remote repo (git remote add origin git@github.com:pooltogether/<NAME_OF_NEW_REPO>.git),
4. Checkout a new branch (git checkout -b name_of_new_branch)
5. Begin implementing as appropriate.
6. Update this README

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

Getting started

The easiest way to get started is by clicking the Use this template button at the top right of this page.

If you prefer to go the CLI way:

forge init my-project --template https://github.com/pooltogether/foundry-template

Development

Installation

You may have to install the following tools to use this repository:

• Foundry to compile and test contracts
• direnv to handle environment variables
• lcov to generate the code coverage report

Install dependencies:

npm i

Env

Copy .envrc.example and write down the env variables needed to run this project.

cp .envrc.example .envrc

Once your env variables are setup, load them with:

direnv allow

Compile

Run the following command to compile the contracts:

npm run compile

Coverage

Forge is used for coverage, run it with:

npm run coverage

You can then consult the report by opening coverage/index.html:

open coverage/index.html

Code quality

Husky is used to run lint-staged and tests when committing.

Prettier is used to format TypeScript and Solidity code. Use it by running:

npm run format

Solhint is used to lint Solidity files. Run it with:

npm run hint

CI

A default Github Actions workflow is setup to execute on push and pull request.

It will build the contracts and run the test coverage.

You can modify it here: .github/workflows/coverage.yml

For the coverage to work, you will need to setup the MAINNET_RPC_URL repository secret in the settings of your Github repository.