OlympusInstructions
Inherits: INSTRv1
Caches and executes batched instructions for protocol upgrades in the Kernel.
Functions
constructor
constructor(Kernel kernel_) Module(kernel_);
Parameters
| Name | Type | Description |
|---|---|---|
| kernel_ | Kernel |
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() public 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. |
getInstructions
View function for retrieving a list of Instructions in an outside contract.
function getInstructions(
uint256 instructionsId_
) public view override returns (Instruction[] memory);
Parameters
| Name | Type | Description |
|---|---|---|
| instructionsId_ | uint256 |
Returns
| Name | Type | Description |
|---|---|---|
| <none> | Instruction[] |
store
Store a list of Instructions to be executed in the future.
function store(
Instruction[] calldata instructions_
) external override permissioned returns (uint256);
Parameters
| Name | Type | Description |
|---|---|---|
| instructions_ | Instruction[] |
Returns
| Name | Type | Description |
|---|---|---|
| <none> | uint256 |