MaverickV2VotingEscrowLens

Inherits: IMaverickV2VotingEscrowLens

Provides view functions for voting escrow information.

Functions

claimInformation

This function retrieves paginated claim information for a specific account and claim index range within a provided Maverick V2 Voting Escrow (veToken) contract.

function claimInformation(IMaverickV2VotingEscrow ve, address account, uint256 startIndex, uint256 endIndex)
    public
    view
    returns (IMaverickV2VotingEscrow.ClaimInformation[] memory returnElements);

Parameters

NameTypeDescription

ve

IMaverickV2VotingEscrow

The address of the IMaverickV2VotingEscrow contract for which to retrieve claim information.

account

address

The address of the account for which to retrieve claim information.

startIndex

uint256

The starting index for the desired range of claims.

endIndex

uint256

The ending index for the desired range of claims.

Returns

NameTypeDescription

returnElements

IMaverickV2VotingEscrow.ClaimInformation[]

An array of IMaverickV2VotingEscrow.ClaimInformation structs containing details about claimable rewards for the specified account within the index range.

syncInformation

This function retrieves paginated information on the lockup synchronization status for legacy ve mav.

function syncInformation(IMaverickV2VotingEscrowWSync ve, address staker, uint256 startIndex, uint256 endIndex)
    public
    view
    returns (IMaverickV2VotingEscrow.Lockup[] memory legacyLockups, uint256[] memory syncedBalances);

Parameters

NameTypeDescription

ve

IMaverickV2VotingEscrowWSync

The address of the ve contract for which to retrieve sync information.

staker

address

The address of the user for whom to retrieve sync information.

startIndex

uint256

The starting index for the desired range of legacy lockups.

endIndex

uint256

The ending index for the desired range of legacy lockups.

Returns

NameTypeDescription

legacyLockups

IMaverickV2VotingEscrow.Lockup[]

An array of IMaverickV2VotingEscrow.Lockup structs containing details about the user's legacy lockups within the index range.

syncedBalances

uint256[]

An array of uint256 values representing the synced balances corresponding to the legacy lockups.

getLockups

This function retrieves paginated lockup information for a specific account and lockup index range within a provided Maverick V2 Voting Escrow (veToken) contract.

function getLockups(IMaverickV2VotingEscrow ve, address staker, uint256 startIndex, uint256 endIndex)
    public
    view
    returns (IMaverickV2VotingEscrow.Lockup[] memory returnElements);

Parameters

NameTypeDescription

ve

IMaverickV2VotingEscrow

The address of the IMaverickV2VotingEscrow contract for which to retrieve lockup information.

staker

address

The address of the account for which to retrieve lockup information.

startIndex

uint256

The starting index for the desired range of lockups.

endIndex

uint256

The ending index for the desired range of lockups.

Returns

NameTypeDescription

returnElements

IMaverickV2VotingEscrow.Lockup[]

An array of IMaverickV2VotingEscrow.Lockup structs containing details about the lockups within the specified index range for the account.

Last updated