Timed
Volt Protocol
an abstract contract for timed events
Methods
duration
function duration() external view returns (uint256)
the duration of the timed period
Returns
Name | Type | Description |
---|---|---|
_0 | uint256 | undefined |
isTimeEnded
function isTimeEnded() external view returns (bool)
return true if time period has ended
Returns
Name | Type | Description |
---|---|---|
_0 | bool | undefined |
isTimeStarted
function isTimeStarted() external view returns (bool)
Returns
Name | Type | Description |
---|---|---|
_0 | bool | undefined |
remainingTime
function remainingTime() external view returns (uint256)
number of seconds remaining until time is up
Returns
Name | Type | Description |
---|---|---|
_0 | uint256 | remaining |
startTime
function startTime() external view returns (uint256)
the start timestamp of the timed period
Returns
Name | Type | Description |
---|---|---|
_0 | uint256 | undefined |
timeSinceStart
function timeSinceStart() external view returns (uint256)
number of seconds since contract was initialized
will be less than or equal to duration
Returns
Name | Type | Description |
---|---|---|
_0 | uint256 | timestamp |
Events
DurationUpdate
event DurationUpdate(uint256 oldDuration, uint256 newDuration)
Parameters
Name | Type | Description |
---|---|---|
oldDuration | uint256 | undefined |
newDuration | uint256 | undefined |
TimerReset
event TimerReset(uint256 startTime)
Parameters
Name | Type | Description |
---|---|---|
startTime | uint256 | undefined |