claim

Automatic claims

If you would like to automatically claim rewards when a new rewards round is initiated, follow these instructions to run claim.js.

This script can run on a recurring basis via cron and takes in two command line arguments: spOwnerWallet and privateKey.

spOwnerWallet - The wallet address used to register the nodes

privateKey - Not the private key of the spOwnerWallet. Should be a throwaway wallet used exclusively to claim with just enough ETH to make claims, no more than 1 ETH at any given time with an alert to top up.

Claiming rewards is permissionless. Any wallet can make a claim on behalf of any node operator and their delegators and the rewards will be distributed to the node operator and the delegators inside the staking system and not to the wallet performing the claim. In order to access the claim, the node operator or delegator would have to request to undelegate.

cd utilities
npm install

node claim/claim.js claim-rewards <spOwnerWallet> <privateKey> --eth-rpc-endpoint=<your-eth-rpc-endpoint>

# Then you can run the following command to setup a cron job. (Be sure to replace the full path to `claim.js`)
(crontab -l 2>/dev/null; echo "0 */6 * * * node full/path/to/claim.js claim-rewards <spOwnerWallet> <privateKey> --eth-rpc-endpoint=<your-eth-rpc-endpoint>") | crontab -

Be sure to replace full/path/to/claim.js with the actual path on your local machine.

Usage: claim [options] [command]

Options:
  -h, --help                                            display help for command

Commands:
  initiate-round [options] <privateKey>                 Initiates new round for claiming rewards
  claim-rewards [options] <spOwnerWallet> <privateKey>  Claim rewards for given spOwnerWallet
  help [command]                                        display help for command

Initiate a reward round

May be performed every epoch (once every N blocks determined by the governance system). At launch, set to 7 days. Each node operator may claim once per round.

Usage: claim initiate-round [options] <privateKey>

Initiates new round for claiming rewards

Options:
  --eth-registry-address <ethRegistryAddress>  Registry contract address (default: "0xd976d3b4f4e22a238c1A736b6612D22f17b6f64C")
  --eth-token-address <ethTokenAddress>        Token contract address (default: "0x18aAA7115705e8be94bfFEBDE57Af9BFc265B998")
  --eth-rpc-endpoint <ethRpcEndpoint>          Eth web3 rpc url to use
  --gas <gas>                                  ammount of gas to use (default: 100000)
  --gas-price <gasPrice>                       gas price in gwei
  -h, --help                                   display help for command

Claim rewards

Claim rewards for given spOwnerWallet.

Usage: claim claim-rewards [options] <spOwnerWallet> <privateKey>

Options:
  --eth-registry-address <ethRegistryAddress>  Registry contract address (default: "0xd976d3b4f4e22a238c1A736b6612D22f17b6f64C")
  --eth-token-address <ethTokenAddress>        Token contract address (default: "0x18aAA7115705e8be94bfFEBDE57Af9BFc265B998")
  --eth-rpc-endpoint <ethRpcEndpoint>          Eth web3 rpc url to use
  --solana-rpc-endpoint <solanaRpcEndpoint>    Solana rpc url to use
  --gas <gas>                                  ammount of gas to use (default: 1000000)
  --gas-price <gasPrice>                       gas price in gwei
  -h, --help                                   display help for command