OlympusMinter
Inherits: MINTRv1
Wrapper for minting and burning functions of OHM token.
Functions
constructor
constructor(Kernel kernel_, address ohm_) Module(kernel_);
Parameters
| Name | Type | Description |
|---|---|---|
| kernel_ | Kernel | |
| ohm_ | address |
KEYCODE
5 byte identifier for a module.
function KEYCODE() public pure override returns (Keycode);
Returns
| Name | Type | Description |
|---|---|---|
| <none> | Keycode |
VERSION
Returns which semantic version of a module is being implemented.
function VERSION() external pure override returns (uint8 major, uint8 minor);
Returns
| Name | Type | Description |
|---|---|---|
| major | uint8 | - Major version upgrade indicates breaking change to the interface. |
| minor | uint8 | - Minor version change retains backward-compatible interface. |
mintOhm
Mint OHM to an address.
function mintOhm(address to_, uint256 amount_) external override permissioned onlyWhileActive;
Parameters
| Name | Type | Description |
|---|---|---|
| to_ | address | |
| amount_ | uint256 |
burnOhm
Burn OHM from an address. Must have approval.
function burnOhm(
address from_,
uint256 amount_
) external override permissioned onlyWhileActive;
Parameters
| Name | Type | Description |
|---|---|---|
| from_ | address | |
| amount_ | uint256 |
increaseMintApproval
Increase approval for specific withdrawer addresses
Policies must explicity request how much they want approved before withdrawing.
function increaseMintApproval(address policy_, uint256 amount_) external override permissioned;
Parameters
| Name | Type | Description |
|---|---|---|
| policy_ | address | |
| amount_ | uint256 |
decreaseMintApproval
Decrease approval for specific withdrawer addresses
function decreaseMintApproval(address policy_, uint256 amount_) external override permissioned;
Parameters
| Name | Type | Description |
|---|---|---|
| policy_ | address | |
| amount_ | uint256 |
deactivate
Emergency shutdown of minting and burning.
function deactivate() external override permissioned;
activate
Re-activate minting and burning after shutdown.
function activate() external override permissioned;