Alluvial Finance Inc.
TLC (v1)
The TLC token has a max supply of 1,000,000,000 and 18 decimal places.Upon deployment, all minted tokens are send to account provided at construction, in charge of creating the vesting schedulesThe contract is based on ERC20Votes by OpenZeppelin. Users need to delegate their voting power to someone or themselves to be able to vote.The contract contains vesting logics allowing vested users to still be able to delegate their voting power while their tokens are held in an escrow
Description of the clock
_0
string
undefined
See {IERC20Permit-DOMAIN_SEPARATOR}.
_0
bytes32
undefined
See {IERC20-allowance}.
owner
address
undefined
spender
address
undefined
_0
uint256
undefined
See {IERC20-approve}. NOTE: If amount is the maximum uint256, the allowance is not updated on transferFrom. This is semantically equivalent to an infinite approval. Requirements: - spender cannot be the zero address.
spender
address
undefined
amount
uint256
undefined
_0
bool
undefined
See {IERC20-balanceOf}.
account
address
undefined
_0
uint256
undefined
Get the pos-th checkpoint for account.
account
address
undefined
pos
uint32
undefined
_0
ERC20VotesUpgradeable.Checkpoint
undefined
Clock used for flagging checkpoints. Can be overridden to implement timestamp based checkpoints (and voting).
_0
uint48
undefined
Computes the releasable amount of tokens for a vesting schedule.
_index
uint256
index of the vesting schedule
_0
uint256
amount of releasable tokens
Computes the vested amount of tokens for a vesting schedule.
_index
uint256
index of the vesting schedule
_0
uint256
amount of vested tokens
Creates a new vesting scheduleThere may delay between the time a user should start vesting tokens and the time the vesting schedule is actually created on the contract.Typically a user joins the Liquid Collective but some weeks pass before the user gets all legal agreements in place and signed for thetoken grant emission to happen. In this case, the vesting schedule created for the token grant would start on the join date which is in the past.
As vesting schedules can be created in the past, this means that you should be careful when creating a vesting schedule and what duration parametersyou use as this contract would allow creating a vesting schedule in the past and even a vesting schedule that has already ended.
_start
uint64
start time of the vesting
_cliffDuration
uint32
duration to vesting cliff (in seconds)
_duration
uint32
total vesting schedule duration after which all tokens are vested (in seconds)
_periodDuration
uint32
duration of a period after which new tokens unlock (in seconds)
_lockDuration
uint32
duration during which tokens are locked (in seconds)
_revocable
bool
whether the vesting schedule is revocable or not
_amount
uint256
amount of token attributed by the vesting schedule
_beneficiary
address
address of the beneficiary of the tokens
_delegatee
address
address to delegate escrow voting power to
_ignoreGlobalUnlockSchedule
bool
whether the vesting schedule should ignore the global lock
_0
uint256
index of the created vesting schedule
Returns the number of decimals used to get its user representation. For example, if decimals equals 2, a balance of 505 tokens should be displayed to a user as 5.05 (505 / 10 ** 2). Tokens usually opt for a value of 18, imitating the relationship between Ether and Wei. This is the default value returned by this function, unless it's overridden. NOTE: This information is only used for display purposes: it in no way affects any of the arithmetic of the contract, including {IERC20-balanceOf} and {IERC20-transfer}.
_0
uint8
undefined
Atomically decreases the allowance granted to spender by the caller. This is an alternative to {approve} that can be used as a mitigation for problems described in {IERC20-approve}. Emits an {Approval} event indicating the updated allowance. Requirements: - spender cannot be the zero address. - spender must have allowance for the caller of at least subtractedValue.
spender
address
undefined
subtractedValue
uint256
undefined
_0
bool
undefined
Delegate votes from the sender to delegatee.
delegatee
address
undefined
Delegates votes from signer to delegatee
delegatee
address
undefined
nonce
uint256
undefined
expiry
uint256
undefined
v
uint8
undefined
r
bytes32
undefined
s
bytes32
undefined
Delegate vesting escrowed tokens
_index
uint256
index of the vesting schedule
_delegatee
address
address to delegate the token to
_0
bool
True on success
Get the address account is currently delegating to.
account
address
undefined
_0
address
undefined
See {EIP-5267}. Available since v4.9.
fields
bytes1
undefined
name
string
undefined
version
string
undefined
chainId
uint256
undefined
verifyingContract
address
undefined
salt
bytes32
undefined
extensions
uint256[]
undefined
Retrieve the totalSupply at the end of timepoint. Note, this value is the sum of all balances. It is NOT the sum of all the delegated votes! Requirements: - timepoint must be in the past
timepoint
uint256
undefined
_0
uint256
undefined
Retrieve the number of votes for account at the end of timepoint. Requirements: - timepoint must be in the past
account
address
undefined
timepoint
uint256
undefined
_0
uint256
undefined
Get vesting schedule
The vesting schedule structure represents a static configuration used to compute the desiredvesting details of a beneficiary at all times. The values won't change even after tokens are released.The only dynamic field of the structure is end, and is updated whenever a vesting schedule is revoked
_index
uint256
Index of the vesting schedule
_0
VestingSchedulesV2.VestingSchedule
undefined
Get count of vesting schedules
_0
uint256
count of vesting schedules
Gets the current votes balance for account
account
address
undefined
_0
uint256
undefined
Atomically increases the allowance granted to spender by the caller. This is an alternative to {approve} that can be used as a mitigation for problems described in {IERC20-approve}. Emits an {Approval} event indicating the updated allowance. Requirements: - spender cannot be the zero address.
spender
address
undefined
addedValue
uint256
undefined
_0
bool
undefined
Initializes the TLC Token
_account
address
The initial account to grant all the minted tokens
Get vesting global unlock schedule activation status for a vesting schedule
_index
uint256
Index of the vesting schedule
_0
bool
true if the vesting schedule should ignore the global unlock schedule
Migrates the vesting schedule state structures
Returns the name of the token.
_0
string
undefined
See {IERC20Permit-nonces}.
owner
address
undefined
_0
uint256
undefined
Get number of checkpoints for account.
account
address
undefined
_0
uint32
undefined
See {IERC20Permit-permit}.
owner
address
undefined
spender
address
undefined
value
uint256
undefined
deadline
uint256
undefined
v
uint8
undefined
r
bytes32
undefined
s
bytes32
undefined
Release vesting scheduleWhen tokens are released from the escrow, the delegated address of the escrow will see its voting power decrease.The beneficiary has to make sure its delegation parameters are set properly to be able to use/delegate the voting power of its balance.
_index
uint256
Index of the vesting schedule to release
_0
uint256
released amount
Revoke vesting schedule
_index
uint256
Index of the vesting schedule to revoke
_end
uint64
End date for the schedule
_0
uint256
amount returned to the vesting schedule creator
Returns the symbol of the token, usually a shorter version of the name.
_0
string
undefined
See {IERC20-totalSupply}.
_0
uint256
undefined
See {IERC20-transfer}. Requirements: - to cannot be the zero address. - the caller must have a balance of at least amount.
to
address
undefined
amount
uint256
undefined
_0
bool
undefined
See {IERC20-transferFrom}. Emits an {Approval} event indicating the updated allowance. This is not required by the EIP. See the note at the beginning of {ERC20}. NOTE: Does not update the allowance if the current allowance is the maximum uint256. Requirements: - from and to cannot be the zero address. - from must have a balance of at least amount. - the caller must have allowance for from's tokens of at least amount.
from
address
undefined
to
address
undefined
amount
uint256
undefined
_0
bool
undefined
Get the address of the escrow for a vesting schedule
_index
uint256
Index of the vesting schedule
_0
address
address of the escrow
Emitted when the allowance of a spender for an owner is set by a call to {approve}. value is the new allowance.
owner indexed
address
undefined
spender indexed
address
undefined
value
uint256
undefined
A new vesting schedule has been created
index
uint256
Vesting schedule index
creator indexed
address
Creator of the vesting schedule
beneficiary indexed
address
Vesting beneficiary address
amount
uint256
Vesting schedule amount
Emitted when an account changes their delegate.
delegator indexed
address
undefined
fromDelegate indexed
address
undefined
toDelegate indexed
address
undefined
Emitted when a token transfer or delegate change results in changes to a delegate's number of votes.
delegate indexed
address
undefined
previousBalance
uint256
undefined
newBalance
uint256
undefined
Vesting escrow has been delegated
index
uint256
Vesting schedule index
oldDelegatee indexed
address
old delegatee
newDelegatee indexed
address
new delegatee
beneficiary indexed
address
vesting schedule beneficiary
MAY be emitted to signal that the domain could have changed.
Triggered when the contract has been initialized or reinitialized.
version
uint8
undefined
Vesting schedule has been released
index
uint256
Vesting schedule index
releasedAmount
uint256
Amount of tokens released to the beneficiary
Vesting schedule has been revoked
index
uint256
Vesting schedule index
returnedAmount
uint256
Amount of tokens returned to the creator
newEnd
uint256
New end timestamp after revoke action
Emitted when value tokens are moved from one account (from) to another (to). Note that value may be zero.
from indexed
address
undefined
to indexed
address
undefined
value
uint256
undefined
Underflow in global unlock logic (should never happen)
Attempt to revoke a vesting schedule with an invalid end parameter
Invalid parameter for a vesting schedule
msg
string
undefined
The address is zero
The operator is unauthorized for the caller
caller
address
Address performing the call
Vesting schedule creator has unsufficient balance to create vesting schedule
The vesting schedule is locked
The VestingSchedule was not found
index
uint256
vesting schedule index
The vesting schedule is not revocable
Attempt to revoke a schedule in the past
No token to release