Keep Benefits
Accrue Random Beacon earnings more efficiently!
keep-benefits is a contract for claiming earnings for operators of the keep network random beacon. Specifically, this contract is used as the beneficiary address (which is set when delegating KEEP tokens).
In the current implementation of the Keep Random Beacon, operator income must be claimed with a transaction per beacon group.
Unfortunately, the earnings for participating in an individual random beacon group are rather small (on the order of ~0.02 eth). This means that the transaction fees associated with claiming each random beacon reward burn a substantial portion of each reward!
The purpose of the keep-benefits contract is to claim these earnings in bulk in a single transaction, saving you the overhead (and inconvenience) of claiming each reward individually with a distinct transaction.
The BulkClaimer contract is deployed to the following networks:
- mainnet: https://etherscan.io/address/0xe35aab9f8d5bdf50c005743362768dd9cc883634
- ropsten: https://ropsten.etherscan.io/address/0xBb19d16E1Ac4127D84E2F95fE7Dc7411C05b7d77
Claiming earnings via GUI
The current ipfs hash for the frontend is QmWVvCy4PDMPV1MaXS4ES1S49XFSsgZ3XrA1uyqmrVuHWR
You can access it at the following gateways:
- https://ipfs.io/ipfs/QmWVvCy4PDMPV1MaXS4ES1S49XFSsgZ3XrA1uyqmrVuHWR/
- https://gateway.ipfs.io/ipfs/QmWVvCy4PDMPV1MaXS4ES1S49XFSsgZ3XrA1uyqmrVuHWR/
- https://cloudflare-ipfs.com/ipfs/QmWVvCy4PDMPV1MaXS4ES1S49XFSsgZ3XrA1uyqmrVuHWR/
You can also run the GUI locally with yarn:
cd frontend/keep-benefits
yarn
yarn start
Claiming earnings via CLI
NOTE: This is not guarenteed to work the first time, test first with ropsten!
# use your operator address here
export OPERATOR='0x...'
# set an http rpc eth endpoint
export HTTP_RPC_URL='https://mainnet.infura.io/v3/...'
fab list_unclaimed_beacon_earnings:$OPERATOR
# this can be any account with sufficient eth balance
# to perform the transaction
export PRIVATE_KEY='...'
fab claim_beacon_rewards:$OPERATOR
Gas Usage
keep-benefits is more efficient than claiming earnings for four or more beacon groups.
| Number of Beacon Groups | Keep BulkClaimer Contract Gas Usage | Individual Transaction Gas Usage |
|---|---|---|
| 4 | 1217869 | 1283984 |
| 3 | 919991 | 962988 |
| 2 | 622113 | 641992 |
| 1 | 410270 | 320996 |
Frontend Development
see: frontend/keep-benefits/README.md
Contract Development
keep-benefits is developed using the brownie framework
Deploying the BulkClaimer contract
Initially, you will need to deploy the contract. The account that deploys the contract will be the owner, however it is possible to transfer the ownership of the contract to a different address in the future (see openzeppelin docs).
pip install -r requirements.txt
cd keep-benefits
export WEB3_INFURA_PROJECT_ID='...'
export PRIVATE_KEY='...'
# required to verify contract source code
export ETHERSCAN_TOKEN='...'
# use --network mainnet for mainnet deploy
# NOTE: delete build/ directory after each deployment!
# (cause etherscan contract verification to fail)
brownie run deployment --network ropsten
Testing
cd keep-benefits
brownie test