FeeDistributor

Overview

The FeeDistributor.vy contract allows users to claim APW locking rewards.

FeeDistributor Methods

claim

Claim fees for _addr.

def claim(_addr: address = msg.sender) -> uint256

Input Parameter	Type	Description
_addr	address	The user address to claim for.

Return Parameter	Type	Description
amount	uint256	The amount claimed.

Each call to claim look at a maximum of 50 user veAPW points. For accounts with many veAPW related actions, this function may need to be called more than once to claim all available fees. In the Claimed event that fires, if claim_epoch is less than max_epoch, the account may claim again.

claim_many

Make multiple fee claims in a single call.

def claim_many(_receivers: address[20]) -> bool

Input Parameter	Type	Description
_receivers	address[20]	List of addresses to claim for. Claiming terminates at the first ZERO_ADDRESS.

Return Parameter	Type	Description
success	bool	True if execution succeeded.

Used to claim for many accounts at once, or to make multiple claims for the same address when that address has significant veAPW history.

checkpoint_token

Updates the token checkpoint.

def checkpoint_token()

Calculates the total number of tokens to be distributed in a given week. During setup for the initial distribution this function is only callable by the contract owner. Beyond initial distro, it can be enabled for anyone to call.

checkpoint_total_supply

Update the veAPW total supply checkpoint.

def checkpoint_total_supply()

The checkpoint is also updated by the first claimant each new epoch week. This function may be called independently of a claim, to reduce claiming gas costs.

View Methods

ve_for_at

Get the veAPW balance for _user at _timestamp

def ve_for_at(_user: address, _timestamp: uint256) -> uint256

Input Parameter	Type	Description
_user	address	The address to query balance for.
_timestamp	uint256	The epoch time to query balance at.

Return Parameter	Type	Description
balance	uint256	The veAPW balance.