IDistributionVault

Git Source

Inherits: IERC6372, IStatefulERC712

Author: M^0 Labs

Functions

claim

Allows a caller to claim token distribution between inclusive epochs startEpoch and endEpoch.

function claim(address token, uint256 startEpoch, uint256 endEpoch, address destination)
    external
    returns (uint256 claimed);

Parameters

Returns

claimBySig

Allows a signer to claim token distribution between inclusive epochs startEpoch and endEpoch.

function claimBySig(
    address account,
    address token,
    uint256 startEpoch,
    uint256 endEpoch,
    address destination,
    uint256 deadline,
    uint8 v,
    bytes32 r,
    bytes32 s
) external returns (uint256 claimed);

Parameters

Returns

claimBySig

Allows a signer to claim token distribution between inclusive epochs startEpoch and endEpoch.

function claimBySig(
    address account,
    address token,
    uint256 startEpoch,
    uint256 endEpoch,
    address destination,
    uint256 deadline,
    bytes memory signature
) external returns (uint256 claimed);

Parameters

Returns

distribute

Distributes the unaccounted balance of token.

function distribute(address token) external returns (uint256);

Parameters

Returns

CLAIM_TYPEHASH

Returns the EIP712 typehash used in the encoding of the digest for the claimBySig function.

function CLAIM_TYPEHASH() external view returns (bytes32);

distributionOfAt

Returns the total amount of token eligible for distribution to holder at the end of epoch epoch.

function distributionOfAt(address token, uint256 epoch) external view returns (uint256);

Parameters

Returns

getClaimable

Returns the amount of token account can claim between inclusive epochs startEpoch and endEpoch.

function getClaimable(address token, address account, uint256 startEpoch, uint256 endEpoch)
    external
    view
    returns (uint256);

Parameters

Returns

getClaimDigest

Returns the digest to be signed, via EIP-712, given an internal digest (i.e. hash struct).

function getClaimDigest(
    address account,
    address token,
    uint256 startEpoch,
    uint256 endEpoch,
    address destination,
    uint256 nonce,
    uint256 deadline
) external view returns (bytes32);

Parameters

Returns

getDistributable

Returns the additional balance of token_ that is not yet distributed.

function getDistributable(address token) external view returns (uint256);

Parameters

Returns

hasClaimed

Returns whether account has already claimed their token distribution for epoch.

function hasClaimed(address token, uint256 epoch, address account) external view returns (bool);

Parameters

Returns

name

Returns the name of the contract.

function name() external view returns (string memory);

zeroToken

Returns the address of the Zero Token holders must have in order to be eligible for distributions.

function zeroToken() external view returns (address);

Events

Claim

Emitted when account claims token distribution between inclusive epochs startEpoch and endEpoch.

event Claim(address indexed token, address indexed account, uint256 startEpoch, uint256 endEpoch, uint256 amount);

Parameters

Distribution

Emitted when token is distributed pro rata to all holders at epoch epoch.

event Distribution(address indexed token, uint256 indexed epoch, uint256 amount);

Parameters

Errors

InvalidDestinationAddress

Revert message when the destination address is address(0).

error InvalidDestinationAddress();

InvalidZeroTokenAddress

Revert message when the Zero Token address set at deployment is address(0).

error InvalidZeroTokenAddress();

NotPastTimepoint

Revert message when a query for past values is for a timepoint greater or equal to the current clock.

error NotPastTimepoint(uint256 timepoint, uint256 clock);

Parameters

StartEpochAfterEndEpoch

Revert message when the start epoch is greater than the end epoch.

error StartEpochAfterEndEpoch(uint256 startEpoch, uint256 endEpoch);

TransferFailed

Revert message when a token transfer, from this contract, fails.

error TransferFailed();