General Docs Technical Docs Source Code
Marketing Site
Get Early Access

TokenTimelock

Git Source

Inherits: Patchable, StateAware, VotesDelegator, AdminControlled, MezzERC721Upgradeable, ITokenTimelock

Author: Daniel Yamagata & Naveen Ailawadi

This contract is used to vest a company's shares for a period of time. It is used by a company's Common Shares and Preferred Shares. The voting power of vesting shares can be delegated and used in governance

*Invariants:

  • _erc20Vesting[token] is always greater than or equal to _erc20Released[token]

  • _vestingScheduleByTokenId[tokenId].amount is always greater than or equal to _erc20ReleasedByTokenId[tokenId][shares]. This is inclusive of when the token's data is deleted upon vesting completion or when the vesting is canceled*

State Variables

TokenTimelockStorageLocation

bytes32 private constant TokenTimelockStorageLocation =
    0x35f985dfceb352faec794b4221331a49707dbeacf0ce328e288c0a3b67d6cb00;

Functions

_getTokenTimelockStorage

function _getTokenTimelockStorage() internal pure returns (TokenTimelockStorage storage $);

constructor

constructor(address _mezzHub, address _mezzMigrator) StateAware(_mezzHub) Patchable(_mezzMigrator);

receive

The Token Timelock should not receive the native token used to pay for gas All native tokens transferred to this contract will be locked forever and effectively burned

receive() external payable;

init

Initializes the token timelock contract

function init(address initTreasury) external virtual initializer;

Parameters

NameTypeDescription

initTreasury

address

The address of the treasury contract

__TokenTimelock_Init

function __TokenTimelock_Init(address initTreasury) internal virtual onlyInitializing;

treasury

Returns the address of the treasury, whose signers are the company's board of directors

function treasury() public view override(BoardControlled, VotesDelegator, IBoardControlled) returns (ITreasury);

vestShares

Vest shares for a recipient according to a vesting schedule. Vesting is cancellable by the board or a set of admins determined by the board depending on if it is obligatory

'data.shares' must be tracked by the treasury, otherwise the function call will revert. This function uses an ERC721 safe transfer, which is susceptible to reentrancy. It follows the CEI pattern accordingly. There is no validation of 'data.startDate' being in the past. It is the responsibility of the caller to ensure its validity. If the start date is in the past farther than 'data.duration', the shares will be instantly vested. The max start date is two years into the future, at which point the shares will begin to vest

function vestShares(DataTypes.VestingData calldata data) external virtual returns (uint256);

Parameters

NameTypeDescription

data

DataTypes.VestingData

The vesting data as a DataTypes.VestingData struct

Returns

NameTypeDescription

<none>

uint256

The token ID for the vesting shares

release

Releases vested tokens to the owner of an ERC721. Can be called by anyone

This function is not access controlled. Any account can release vested shares for any token ID Vested shares are transferred to the owner of the token

function release(uint256 tokenId) external virtual onlyTokenOwner(tokenId) returns (uint256);

Parameters

NameTypeDescription

tokenId

uint256

The ID of the token to release vested shares for

Returns

NameTypeDescription

<none>

uint256

The amount of shares that were released

cancelVestingAtTimepoint

Cache and Validate

This function is primarily used by the Payroll Manager when an employee resigns at a timepoint

function cancelVestingAtTimepoint(uint256 tokenId, uint256 timepoint) external virtual returns (uint256);

Returns

NameTypeDescription

<none>

uint256

The amount of canceled shares

cancelVesting

Cancels the vesting for a given token. Releases any vested shares and burns the remaining amount allocated to the token.

This function will revert if the caller is not the token owner nor an admin. If the caller is an admin, this function will revert if the token is obligatory

function cancelVesting(uint256 tokenId) external virtual returns (uint256, uint256);

Parameters

NameTypeDescription

tokenId

uint256

The ID of the token to cancel the vesting for

Returns

NameTypeDescription

<none>

uint256

Returns two arguments. The first is the amount of shares that were released. The second is the amount of shares that were cancelled and burned

<none>

uint256

_cancelVesting

function _cancelVesting(uint256 tokenId) internal virtual returns (uint256, uint256);

_handleCanceledShares

If the owner is the payroll manager, transfer the vesting shares back to the treasury Otherwise, burn the shares. This is done to prevent the treasury from having to re-authorize and re-issue shares that were allocated to employees but subsequently canceled

function _handleCanceledShares(uint256 tokenId, address shares, uint256 amountCanceled) internal;

extendVestingDuration

Extends the vesting duration for the given 'tokenId'. Only callable by the token owner

This function will revert if the token does not exist

function extendVestingDuration(uint256 tokenId, uint256 durationExtension)
    external
    virtual
    onlyTokenOwner(tokenId)
    returns (uint32);

Parameters

NameTypeDescription

tokenId

uint256

The ID of the token to extend the vesting duration for

durationExtension

uint256

The amount of time to extend the vesting duration by

Returns

NameTypeDescription

<none>

uint32

The new vesting duration

extendVestingAmount

Increases the vesting amount for 'tokenId' by 'equityExtension'

This function is not access controlled. It is callable by anyone This function will revert if the token does not exist

function extendVestingAmount(uint256 tokenId, uint256 equityExtension) external virtual returns (uint256);

Parameters

NameTypeDescription

tokenId

uint256

The ID of the token to increase the vesting amount for

equityExtension

uint256

The amount to increase the vesting amount by

Returns

NameTypeDescription

<none>

uint256

The new vesting amount

updateDelegate

Updates the delegate of 'delegator' from 'fromDelegate' to 'toDelegate'. Only callable by the Delegate Registry

function updateDelegate(address delegator, address fromDelegate, address toDelegate)
    external
    virtual
    override(VotesDelegator, IVotesDelegator)
    onlyDelegateRegistry;

isObligatory

Returns whether or not a given token is obligatory

function isObligatory(uint256 tokenId) public view returns (bool);

Parameters

NameTypeDescription

tokenId

uint256

The ID of the token

Returns

NameTypeDescription

<none>

bool

Whether or not the token is obligatory

wasCanceled

Returns true if the token was canceled, false otherwise

function wasCanceled(uint256 tokenId) public view returns (bool);

hasCompleted

Returns true if the token has completed its vesting, false otherwise

function hasCompleted(uint256 tokenId) public view returns (bool);

exists

Returns true if the token exists, false otherwise

function exists(uint256 tokenId) public view returns (bool);

getVestingSchedule

Returns the vesting schedule for the given token

function getVestingSchedule(uint256 tokenId) public view returns (DataTypes.VestingSchedule memory);

Parameters

NameTypeDescription

tokenId

uint256

The ID of the token

Returns

NameTypeDescription

<none>

DataTypes.VestingSchedule

The vesting schedule as a DataTypes.VestingSchedule struct

getRemainingVestingAmount

Returns the remaining vesting amount for the given token

The remaining vesting amount refers to the difference between the shares attributed to the vesting schedule and how much has been released

function getRemainingVestingAmount(uint256 tokenId) public view returns (uint256);

getVestingEndDate

Returns the Unix-timestamp in seconds at which the vesting schedule will complete

function getVestingEndDate(uint256 tokenId) public view returns (uint256);

released

Returns the amount of shares that have been released for a given token

function released(uint256 tokenId) public view returns (uint256);

Parameters

NameTypeDescription

tokenId

uint256

The ID of the token

Returns

NameTypeDescription

<none>

uint256

The amount of shares that have been released for the token

releasable

Returns the amount of shares that are releasable for a given token. 'Releasable' refers to the amount of shares that have vested and have not yet been released

function releasable(uint256 tokenId) public view returns (uint256);

Parameters

NameTypeDescription

tokenId

uint256

The ID of the token

Returns

NameTypeDescription

<none>

uint256

The amount of shares that are releasable for the token

getVotesByShareClass

Returns the current number of voting units for 'account' based on 'shares'

The return value does not adjust for the voting weight of 'shares'

function getVotesByShareClass(address account, address shares) public view virtual returns (uint256);

getPastVotesByShareClass

Returns the voting units for 'account' based on 'shares' at the given 'timepoint'

The return value does not adjust for the voting weight of 'shares'. This function will revert if 'timepoint' is in the present or the future

function getPastVotesByShareClass(address account, address shares, uint256 timepoint)
    public
    view
    virtual
    returns (uint256);

getERC20VestingByAccount

Returns the current amount of 'shares' that are vesting for 'account'

function getERC20VestingByAccount(address account, address shares) public view returns (uint256);

getCumulativeERC20Vesting

Returns the cumlative amount of shares that are vesting or have been vested in the token timelock

function getCumulativeERC20Vesting(address shares) public view returns (uint256);

Parameters

NameTypeDescription

shares

address

The address of the shares contract

Returns

NameTypeDescription

<none>

uint256

The amount of shares that are vesting or have been vested in the token timelock

getCumulativeERC20Released

Returns the cumlative amount of shares that have been released from the token timelock

function getCumulativeERC20Released(address shares) public view returns (uint256);

Parameters

NameTypeDescription

shares

address

The address of the shares contract

Returns

NameTypeDescription

<none>

uint256

The amount of shares that have been released from the token timelock

name

Returns the name of the token timelock

function name() public view virtual override(ERC721Upgradeable, ITokenTimelock) returns (string memory);

symbol

Returns the symbol of the token timelock

function symbol() public view virtual override(ERC721Upgradeable, ITokenTimelock) returns (string memory);

coreId

Returns the coreId of the implementation as a bytes32

The core ID is the keccak256 hash of the contract name followed by a version under the following syntax: "mezzanine.coreId.ContractName.vX" For example, the core ID of the 2nd version of the Treasury would be the following: keccak256(abi.encodePacked("mezzanine.coreId.Treasury.v2"))

function coreId() public pure virtual override(Credentialed, ICredentialed) returns (bytes32);

version

Returns the version of the implementation as a uint256

function version() public pure virtual override(Credentialed, ICredentialed) returns (uint256);

_release

Releases the '_releasableAmount' of vested shares to the owner of the token 'Releasable' refers to the amount vested minus the amount already released

function _release(uint256 tokenId, address shares, uint256 _releasableAmount) internal;

Parameters

NameTypeDescription

tokenId

uint256

The token ID to release tokens for

shares

address

The address of the shares that are being released and correspond to the given token

_releasableAmount

uint256

The amount of tokens that are releasable

_releasable

Returns the amount of tokens that are 'releasable' for a given token 'Releasable' refers to the amount vested minus the amount already released

function _releasable(uint256 tokenId) internal view virtual returns (uint256);

Parameters

NameTypeDescription

tokenId

uint256

The token ID

Returns

NameTypeDescription

<none>

uint256

The amount of tokens that are releasable

_vestedAmount

Calculates the vested amount of shares for a given vesting schedule. Does not check the released amount of shares Precision loss is possible, but extremely unlikely since shares will always have 18 decimals

function _vestedAmount(DataTypes.VestingSchedule memory vestingScheduleCache) internal view virtual returns (uint256);

Parameters

NameTypeDescription

vestingScheduleCache

DataTypes.VestingSchedule

The vesting schedule to calculate the vested amount for

Returns

NameTypeDescription

<none>

uint256

The vested amount of shares

_burnTokenAndDeleteData

Burn a token with 'tokenId' and deletes it corresponding data in storage

function _burnTokenAndDeleteData(uint256 tokenId, address _shares) internal;

Parameters

NameTypeDescription

tokenId

uint256

The ID of the token to burn

_shares

address

The address of the shares that correspond to the given token

_validateCallerIsOwnerOrAdminAndNonObligatory

*Reverts if:

  • The caller is not the token owner or an admin

  • If the caller is an admin and the token is obligatory*

function _validateCallerIsOwnerOrAdminAndNonObligatory(uint256 tokenId) internal view virtual;

_checkInvariants

Asserts that the invariants hold true. Panics otherwise

function _checkInvariants(uint256 tokenId) internal view virtual;

Parameters

NameTypeDescription

tokenId

uint256

The token ID to check the invariants for

_update

Overridden updated from '_ERC721Upgradeable' such that the voting units of a delegate is updated on token transfer, including burning

function _update(address to, uint256 tokenId, address auth) internal virtual override returns (address);

Returns

NameTypeDescription

<none>

address

The owner of 'tokenId'

_transferVotingUnits

Transfers the voting units of 'shares' from the delegatee of 'from' to the delegatee of 'to'

function _transferVotingUnits(address from, address to, address shares, uint256 amount) internal virtual;

_moveDelegateVotes

Moves delegated votes of 'shares' from one delegate to another

function _moveDelegateVotes(address from, address to, address shares, uint256 amount) internal virtual;

_push

function _push(Checkpoints.Trace208 storage store, function(uint208, uint208) view returns (uint208) op, uint208 delta)
    internal
    returns (uint208, uint208);

_add

function _add(uint208 a, uint208 b) internal pure returns (uint208);

_subtract

function _subtract(uint208 a, uint208 b) internal pure returns (uint208);

supportsInterface

ERC165 support

function supportsInterface(bytes4 interfaceId)
    public
    view
    virtual
    override(ERC721Upgradeable, MezzUUPSUpgradeable, IERC165)
    returns (bool);

upgradeToNewerVersion

Upgrades 'this' to a newer version via the Mezz Migrator. Only callable by the Treasury, whose signers are the board of directors

Will revert if the protocol state is 'Paused' or 'Frozen'

function upgradeToNewerVersion(uint256 newVersion, bytes memory data) public virtual onlyProxy onlyBoard;

Parameters

NameTypeDescription

newVersion

uint256

The new version to upgrade to

data

bytes

The data to be passed to the new implementation, which likely should be a reinitializer function if used

_authorizePatch

Access control for 'resetToPatchedLatestVersion()'

function _authorizePatch(bytes memory) internal view virtual override;

Structs

TokenTimelockStorage

struct TokenTimelockStorage {
    mapping(address => uint256) _erc20Vesting;
    mapping(address => uint256) _erc20Released;
    mapping(uint256 => DataTypes.VestingSchedule) _vestingScheduleByTokenId;
    mapping(uint256 tokenId => mapping(address erc20 => uint256)) _erc20ReleasedByTokenId;
    mapping(address account => mapping(address erc20 => uint256)) _erc20VestingByAccount;
    mapping(address delegatee => mapping(address shares => Checkpoints.Trace208)) _delegateCheckpointsByShares;
}
PreviousDelegateRegistryNextPayrollManager

Last updated