FlareDaemon#
Source | Inherits from GovernedAtGenesis, AddressUpdatable
Flare Daemon contract.
This contract exists to coordinate regular daemon-like polling of contracts
that are registered to receive said polling. The trigger method is called by the
validator right at the end of block state transition.
Events#
ContractDaemonizeErrored#
event ContractDaemonizeErrored(
address theContract,
uint256 atBlock,
string theMessage,
uint256 gasConsumed
)
ContractDaemonized#
event ContractDaemonized(
address theContract,
uint256 gasConsumed
)
ContractHeldOff#
event ContractHeldOff(
address theContract,
uint256 blockHoldoffsRemaining
)
ContractsSkippedOutOfGas#
event ContractsSkippedOutOfGas(
uint256 numberOfSkippedConstracts
)
GovernanceCallTimelocked#
event GovernanceCallTimelocked(
bytes4 selector,
uint256 allowedAfterTimestamp,
bytes encodedCall
)
Emitted when a new governance call has been recorded and is now waiting for the time lock to expire.
GovernanceInitialised#
event GovernanceInitialised(
address initialGovernance
)
Emitted when the governance address is initialized.
This address will be used until production mode is entered (see GovernedProductionModeEntered).
At that point the governance address is taken from GovernanceSettings.
GovernedProductionModeEntered#
event GovernedProductionModeEntered(
address governanceSettings
)
Emitted when governance is enabled and the governance address cannot be changed anymore
(only through a network fork).
InflationSet#
event InflationSet(
contract IInflationGenesis theNewContract,
contract IInflationGenesis theOldContract
)
MintingRequestReceived#
event MintingRequestReceived(
uint256 amountWei
)
MintingRequestTriggered#
event MintingRequestTriggered(
uint256 amountWei
)
MintingWithdrawn#
event MintingWithdrawn(
uint256 amountWei
)
RegistrationUpdated#
event RegistrationUpdated(
contract IFlareDaemonize theContract,
bool add
)
SelfDestructReceived#
event SelfDestructReceived(
uint256 amountWei
)
TimelockedGovernanceCallCanceled#
event TimelockedGovernanceCallCanceled(
bytes4 selector,
uint256 timestamp
)
Emitted when a timelocked governance call is canceled before execution.
TimelockedGovernanceCallExecuted#
event TimelockedGovernanceCallExecuted(
bytes4 selector,
uint256 timestamp
)
Emitted when a timelocked governance call is executed.
Functions#
cancelGovernanceCall#
function cancelGovernanceCall(
bytes4 _selector
) external;
Cancel a timelocked governance call before it has been executed.
Only governance can call this method.
| Parameters | Type | Description |
|---|---|---|
_selector |
bytes4 |
The method selector. |
constructor#
constructor(
) public;
This constructor should contain no code as this contract is pre-loaded into the genesis block.
The super constructor is called for testing convenience.
executeGovernanceCall#
function executeGovernanceCall(
bytes4 _selector
) external;
Execute the timelocked governance calls once the timelock period expires.
Only executor can call this method.
| Parameters | Type | Description |
|---|---|---|
_selector |
bytes4 |
The method selector (only one timelocked call per method is stored). |
getAddressUpdater#
function getAddressUpdater(
) public view returns (
address _addressUpdater);
Returns the configured address updater.
| Returns | Type | Description |
|---|---|---|
_addressUpdater |
address |
The AddresUpdater contract that can update our contract address list, as a response to a governance call. |
getDaemonizedContractsData#
function getDaemonizedContractsData(
) external view returns (
contract IFlareDaemonize[] _daemonizeContracts,
uint256[] _gasLimits,
uint256[] _blockHoldoffsRemaining);
getNextMintRequestAllowedTs#
function getNextMintRequestAllowedTs(
) external view returns (
uint256);
governance#
function governance(
) public view returns (
address);
Returns the current effective governance address.
initialise#
function initialise(
address _governance
) public pure;
Disallow initialise to be called.
| Parameters | Type | Description |
|---|---|---|
_governance |
address |
The governance address for initial claiming. |
initialiseFixedAddress#
function initialiseFixedAddress(
) public returns (
address);
Set the governance address to a hard-coded known address.
This should be done at contract deployment time.
| Returns | Type | Description |
|---|---|---|
| [0] | address |
The governance address. |
registerToDaemonize#
function registerToDaemonize(
struct FlareDaemon.Registration[] _registrations
) external;
Register contracts to be polled by the daemon process.
A gas limit of zero will set no limit for the contract but the validator has an overall
limit for the trigger method.
If any registrations already exist, they will be unregistered.
Contracts will be daemonized in the order in which presented via the _registrations array.
| Parameters | Type | Description |
|---|---|---|
_registrations |
struct FlareDaemon.Registration[] |
An array of Registration structures of IFlareDaemonize contracts to daemonize and gas limits for each contract. |
requestMinting#
function requestMinting(
uint256 _amountWei
) external;
Queue up a minting request to send to the validator at next trigger.
| Parameters | Type | Description |
|---|---|---|
_amountWei |
uint256 |
The amount to mint. |
setAddressUpdater#
function setAddressUpdater(
address _addressUpdater
) external;
Sets the address udpater contract.
| Parameters | Type | Description |
|---|---|---|
_addressUpdater |
address |
The address updater contract. |
setBlockHoldoff#
function setBlockHoldoff(
uint256 _blockHoldoff
) external;
Set number of blocks that must elapse before a daemonized contract exceeding gas limit can have its daemonize() method called again.
| Parameters | Type | Description |
|---|---|---|
_blockHoldoff |
uint256 |
The number of blocks to holdoff. |
setMaxMintingRequest#
function setMaxMintingRequest(
uint256 _maxMintingRequestWei
) external;
Set limit on how much can be minted per request. this number can't be udated too often
| Parameters | Type | Description |
|---|---|---|
_maxMintingRequestWei |
uint256 |
The request maximum in wei. |
showDaemonizedErrors#
function showDaemonizedErrors(
uint256 startIndex,
uint256 numErrorTypesToShow
) public view returns (
uint256[] _lastErrorBlock,
uint256[] _numErrors,
string[] _errorString,
address[] _erroringContract,
uint256 _totalDaemonizedErrors);
showLastDaemonizedError#
function showLastDaemonizedError(
) external view returns (
uint256[] _lastErrorBlock,
uint256[] _numErrors,
string[] _errorString,
address[] _erroringContract,
uint256 _totalDaemonizedErrors);
switchToProductionMode#
function switchToProductionMode(
) external;
Enter the production mode after all the initial governance settings have been set.
This enables timelocks and the governance can be obtained afterward by calling
governanceSettings.getGovernanceAddress().
Emits GovernedProductionModeEntered.
updateContractAddresses#
function updateContractAddresses(
bytes32[] _contractNameHashes,
address[] _contractAddresses
) external;
External method called from AddressUpdater only.
Modifiers#
inflationSet#
modifier inflationSet()
As there is not a constructor, this modifier exists to make sure the inflation
contract is set for methods that require it.
onlyAddressUpdater#
modifier onlyAddressUpdater()
Only the AdressUpdater contract can call this method.
Its address is set at construction time but it can also update itself.
onlyInflation#
modifier onlyInflation( address _inflation)
Access control to protect methods to allow only minters to call select methods (like transferring balance out).
onlySystemTrigger#
modifier onlySystemTrigger()
Access control to protect trigger method.
Please note that the sender address is the same as deployed FlareDaemon address in this case.
Structures#
DaemonizedError#
struct DaemonizedError {
uint192 lastErrorBlock;
uint64 numErrors;
address fromContract;
uint64 errorTypeIndex;
string errorMessage;
}
LastErrorData#
struct LastErrorData {
uint192 totalDaemonizedErrors;
uint64 lastErrorTypeIndex;
}
Registration#
struct Registration {
contract IFlareDaemonize daemonizedContract;
uint256 gasLimit;
}
Variables#
governanceSettings#
contract IGovernanceSettings governanceSettings
Governance Settings.
lastUpdateMaxMintRequestTs#
uint256 lastUpdateMaxMintRequestTs
productionMode#
bool productionMode
When true, governance is enabled and cannot be disabled. See switchToProductionMode.
timelockedCalls#
mapping(bytes4 => struct GovernedBase.TimelockedCall) timelockedCalls
List of pending timelocked governance calls.