LinearTokenTimelock

Events

BeneficiaryUpdate

event BeneficiaryUpdate(address)

Params

Param	Type	Notes
_beneficiary indexed	address

DurationUpdate

event DurationUpdate(uint256,uint256)

Params

Param	Type	Notes
oldDuration	uint256
newDuration	uint256

PendingBeneficiaryUpdate

event PendingBeneficiaryUpdate(address)

Params

Param	Type	Notes
_pendingBeneficiary indexed	address

Release

event Release(address,address,uint256)

Params

Param	Type	Notes
_beneficiary indexed	address
_recipient indexed	address
_amount	uint256

TimerReset

event TimerReset(uint256)

Params

Param	Type	Notes
startTime	uint256

Methods

acceptBeneficiary

function acceptBeneficiary() nonpayable

pending beneficiary accepts new beneficiary

alreadyReleasedAmount

function alreadyReleasedAmount() view returns(uint256)

amount of tokens released to beneficiary

Returns

Param	Type	Notes
	uint256

availableForRelease

function availableForRelease() view returns(uint256)

amount of held tokens unlocked and available for release

Returns

Param	Type	Notes
	uint256

beneficiary

function beneficiary() view returns(address)

beneficiary of tokens after they are released

Returns

Param	Type	Notes
	address

clawback

function clawback() nonpayable

clawbackAdmin

function clawbackAdmin() view returns(address)

Returns

Param	Type	Notes
	address

cliffSeconds

function cliffSeconds() view returns(uint256)

number of seconds before releasing is allowed

Returns

Param	Type	Notes
	uint256

duration

function duration() view returns(uint256)

the duration of the timed period

Returns

Param	Type	Notes
	uint256

initialBalance

function initialBalance() view returns(uint256)

initial balance of lockedToken

Returns

Param	Type	Notes
	uint256

isTimeEnded

function isTimeEnded() view returns(bool)

return true if time period has ended

Returns

Param	Type	Notes
	bool

isTimeStarted

function isTimeStarted() view returns(bool)

Returns

Param	Type	Notes
	bool

lockedToken

function lockedToken() view returns(address)

ERC20 basic token contract being held in timelock

Returns

Param	Type	Notes
	address

passedCliff

function passedCliff() view returns(bool)

Returns

Param	Type	Notes
	bool

pendingBeneficiary

function pendingBeneficiary() view returns(address)

pending beneficiary appointed by current beneficiary

Returns

Param	Type	Notes
	address

release

function release(address,uint256) nonpayable

releases amount unlocked tokens to address to

Params

Param	Type	Notes
to	address
amount	uint256

releaseMax

function releaseMax(address) nonpayable

releases maximum unlocked tokens to address to

Params

Param	Type	Notes
to	address

remainingTime

function remainingTime() view returns(uint256)

number of seconds remaining until time is up

Returns

Param	Type	Notes
	uint256

setPendingBeneficiary

function setPendingBeneficiary(address) nonpayable

current beneficiary can appoint new beneficiary, which must be accepted

Params

Param	Type	Notes
_pendingBeneficiary	address

startTime

function startTime() view returns(uint256)

the start timestamp of the timed period

Returns

Param	Type	Notes
	uint256

timeSinceStart

function timeSinceStart() view returns(uint256)

number of seconds since contract was initialized

will be less than or equal to duration

Returns

Param	Type	Notes
	uint256

totalToken

function totalToken() view returns(uint256)

the total amount of tokens held by timelock

Returns

Param	Type	Notes
	uint256