VEGOVERNANCE API

Sets the curve contract that calculates the voting power

Sets the voter contract that tracks votes

Sets the exit queue contract that manages withdrawal eligibility

Sets the clock contract that manages epoch and voting periods

Sets the NFT contract that is the lock

By default this can only be set once due to the high risk of changing the lock and having the ability to steal user funds.

Fetch all NFTs owned by an address by leveraging the ERC721Enumerable interface

Currently unsupported

Currently unsupported

We cannot do historic voting power at this time because we don’t current track histories of token transfers.

Checks if the NFT is currently voting. We require the user to reset their votes if so.

Deposit _value tokens for msg.sender

Creates a lock on behalf of someone else. Restricted by default.

Deposit _value tokens for _to starting at next deposit interval

Resets the votes and begins the withdrawal process for a given tokenId

Convenience function, the user must have authorized this contract to act on their behalf.

Enters a tokenId into the withdrawal queue by transferring to this contract and creating a ticket.

The user must not have active votes in the voter contract.

Withdraws tokens from the contract

withdraw excess tokens from the contract - possibly by accident

the sweeper can send NFTs mistakenly sent to the contract to a designated address

Cannot sweep NFTs that are in the exit queue for obvious reasons

Returns the address of the implementation contract in the [proxy storage slot](https://eips.ethereum.org/EIPS/eip-1967) slot the [UUPS proxy](https://eips.ethereum.org/EIPS/eip-1822) is pointing to.

Internal method authorizing the upgrade of the contract via the [upgradeability mechanism for UUPS proxies](https://docs.openzeppelin.com/contracts/4.x/api/proxy#UUPSUpgradeable) (see [ERC-1822](https://eips.ethereum.org/EIPS/eip-1822)).

Role required to manage the Escrow curve, this typically will be the DAO

Role required to pause the contract - can be given to emergency contracts

Role required to withdraw underlying tokens from the contract

Decimals of the voting power

Minimum deposit amount

Auto-incrementing ID for the most recently created lock, does not decrease on withdrawal

Total supply of underlying tokens deposited in the contract

Address of the underying ERC20 token.

Only tokens with 18 decimals and no transfer fees are supported

Address of the gauge voting contract.

We need to ensure votes are not left in this contract before allowing positing changes

Address of the voting Escrow Curve contract that will calculate the voting power

Address of the contract that manages exit queue logic for withdrawals

Address of the clock contract that manages epoch and voting periods

Address of the NFT contract that is the lock

The exit queue manager can set the cooldown period

The exit queue manager can set the fee percent

The exit queue manager can set the minimum lock time

Min 1 second to prevent single block deposit-withdrawal attacks

withdraw staked tokens sent as part of fee collection to the caller

The caller must be authorized to withdraw by the DAO

queue an exit for a given tokenId, granting the ticket to the passed holder

we don’t check that the ticket holder is the caller this is because the escrow contract is the only one that can queue an exit and we leave that logic to the escrow contract

Returns the next exit date for a ticket

The next exit date is the later of the cooldown expiry and the next checkpoint

Exits the queue for that tokenID.

The holder is not checked. This is left up to the escrow contract to manage.

Calculate the exit fee for a given tokenId

If the admin chages the cooldown, this will affect all ticket holders. We may not want this.

tokenId ⇒ Ticket

Returns the address of the implementation contract in the [proxy storage slot](https://eips.ethereum.org/EIPS/eip-1967) slot the [UUPS proxy](https://eips.ethereum.org/EIPS/eip-1822) is pointing to.

Internal method authorizing the upgrade of the contract via the [upgradeability mechanism for UUPS proxies](https://docs.openzeppelin.com/contracts/4.x/api/proxy#UUPSUpgradeable) (see [ERC-1822](https://eips.ethereum.org/EIPS/eip-1822)).

role required to manage the exit queue

role required to withdraw tokens from the escrow contract

the fee percent charged on withdrawals

address of the escrow contract

clock contract for epoch duration

time in seconds between exit and withdrawal

minimum time from the original lock date before one can enter the queue

tokenId ⇒ Ticket

In this case, the constant term is 1 so we just case the amount

The coefficients are returned in the order [constant, linear, quadratic]

The coefficients are returned in the order [constant, linear, quadratic] and are converted to regular 256-bit signed integers instead of their fixed-point representation

Returns the bias for the given time elapsed and amount, up to the maximum time

Returns whether the NFT is warm

Returns the TokenPoint at the passed interval

Binary search to get the token point interval for a token id at or prior to a given timestamp Once we have the point, we can apply the bias calculation to get the voting power.

If a token point does not exist prior to the timestamp, this will return 0.

Get the current voting power for _tokenId

Adheres to the ERC20 balanceOf interface for Aragon compatibility Fetches last token point prior to a certain timestamp, then walks forward to timestamp.

[NOT IMPLEMENTED] Calculate total voting power at some point in the past

This function will be implemented in a future version of the contract

A checkpoint can be called by the VotingEscrow contract to snapshot the user’s voting power

Record gper-user data to checkpoints. Used by VotingEscrow system.

Curve finance style but just for users at this stage

Returns the address of the implementation contract in the [proxy storage slot](https://eips.ethereum.org/EIPS/eip-1967) slot the [UUPS proxy](https://eips.ethereum.org/EIPS/eip-1822) is pointing to.

Internal method authorizing the upgrade of the contract via the [upgradeability mechanism for UUPS proxies](https://docs.openzeppelin.com/contracts/4.x/api/proxy#UUPSUpgradeable) (see [ERC-1822](https://eips.ethereum.org/EIPS/eip-1822)).

Administrator role for the contract

The VotingEscrow contract address

The Clock contract address

tokenId ⇒ point epoch: incremented on a per-tokenId basis

The warmup period for the curve

tokenId ⇒ tokenPointIntervals ⇒ TokenPoint The Array is fixed so we can write to it in the future This implementation means that very short intervals may be challenging

extrememly simple for loop. We don’t need reentrancy checks in this implementation because the plugin doesn’t do anything other than signal.

Called by users to vote for pools. Votes distributed proportionally based on weights.

Called by users to reset voting state. Required when withdrawing or transferring veNFT.

autogenerated epoch id based on elapsed time

whether voting is active in the current epoch

timestamp of the start of the next epoch

timestamp of the start of the next voting period

timestamp of the end of the current voting period

Can be called to check if a token is currently voting

The Gauge admin can can create and manage voting gauges for token holders

Address of the voting escrow contract that will track voting power

Clock contract for epoch duration

The total votes that have accumulated in this contract

enumerable list of all gauges that can be voted on

address ⇒ gauge data

gauge ⇒ total votes (global)

tokenId ⇒ tokenVoteData

Deploys the setup by binding the implementation contracts required during installation.

Returns the plugin implementation address.

The implementation can be instantiated via the new keyword, cloned via the minimal clones pattern (see [ERC-1167](https://eips.ethereum.org/EIPS/eip-1167)), or proxied via the UUPS pattern (see [ERC-1822](https://eips.ethereum.org/EIPS/eip-1822)).

Prepares the installation of a plugin.

You need to set the helpers on the plugin as a post install action.

Prepares the uninstallation of a plugin.

Returns the permissions required for the plugin install and uninstall.

Simple utility for external applications create the encoded setup data.

The identifier of the EXECUTE_PERMISSION permission.

Thrown if passed helpers array is of wrong length.

implementation of the gaugevoting plugin

implementation of the escrow voting curve

implementation of the exit queue

implementation of the escrow locker

implementation of the clock

implementation of the escrow NFT

Transfers disabled by default, only whitelisted addresses can receive transfers

Enable transfers to any address without whitelisting

Override the transfer to check if the recipient is whitelisted This avoids needing to check for mint/burn but is less idomatic than beforeTokenTransfer

Minting and burning functions that can only be called by the escrow contract

Safe mint ensures contract addresses are ERC721 Receiver contracts

Minting and burning functions that can only be called by the escrow contract

Returns the address of the implementation contract in the [proxy storage slot](https://eips.ethereum.org/EIPS/eip-1967) slot the [UUPS proxy](https://eips.ethereum.org/EIPS/eip-1822) is pointing to.

Internal method authorizing the upgrade of the contract via the [upgradeability mechanism for UUPS proxies](https://docs.openzeppelin.com/contracts/4.x/api/proxy#UUPSUpgradeable) (see [ERC-1822](https://eips.ethereum.org/EIPS/eip-1822)).

enables transfers without whitelisting

role to upgrade this contract

Address of the escrow contract that holds underyling assets

Whitelisted contracts that are allowed to transfer

Number of seconds until the start of the next epoch (relative)

If exactly at the start of the epoch, returns 0

Timestamp of the start of the next epoch (absolute)

Number of seconds until voting starts.

If voting is active, returns 0.

Timestamp of the start of the next voting period (absolute)

Number of seconds until the end of the current voting period (relative)

If we are outside the voting period, returns 0

Timestamp of the end of the current voting period (absolute)

Number of seconds until the next checkpoint interval (relative)

If exactly at the start of the checkpoint interval, returns 0

Timestamp of the next deposit interval (absolute)

Epoch encompasses a voting and non-voting period

Checkpoint interval is the time between each voting checkpoint

Voting duration is the time during which votes can be cast

Opens and closes the voting window slightly early to avoid timing attacks