IMinterV0

Git Source

Inherits: EInvalidAddress, EInvalidAmount

Title: IMinterV0

Interface for the MinterV0 contract

Defines structs, enums, events, errors, and public functions for apxUSD minting

Functions

hashOrder

Returns the EIP-712 typed hash for an order

function hashOrder(Order calldata order) external view returns (bytes32);

Parameters

Returns

validateOrder

Validates an order without executing it (reverts if invalid)

function validateOrder(Order calldata order, bytes calldata signature) external view;

Parameters

requestMint

Requests a mint by validating the order and scheduling with AccessManager

function requestMint(Order calldata order, bytes calldata signature) external returns (bytes32 operationId);

Parameters

Returns

executeMint

Executes a scheduled mint operation via AccessManager

function executeMint(bytes32 operationId) external;

Parameters

cancelMint

Cancels a scheduled mint operation

function cancelMint(bytes32 operationId) external;

Parameters

setMaxMintAmount

Updates the maximum mint amount

function setMaxMintAmount(uint208 newMaxMintAmount) external;

Parameters

setRateLimit

Updates the rate limit configuration

function setRateLimit(uint256 newAmount, uint48 newPeriod) external;

Parameters

cleanMintHistory

Manually cleans up to n expired mint records from the history queue

function cleanMintHistory(uint32 n) external returns (uint32 cleaned);

Parameters

Returns

nonce

Returns the current nonce for a beneficiary

function nonce(address beneficiary) external view returns (uint48);

Parameters

Returns

pendingOrder

Returns the details of a pending order

function pendingOrder(bytes32 operationId) external view returns (Order memory);

Parameters

Returns

mintStatus

Returns the status of a mint operation

function mintStatus(bytes32 operationId) external view returns (MintStatus);

Parameters

Returns

rateLimit

Returns the current rate limit configuration

function rateLimit() external view returns (uint256 amount, uint48 period);

Returns

maxMintAmount

Returns the current max mint amount

function maxMintAmount() external view returns (uint208);

Returns

rateLimitMinted

Returns the total amount minted in the current rate limit period

function rateLimitMinted() external view returns (uint256);

Returns

rateLimitAvailable

Returns the amount available to mint without exceeding the rate limit

function rateLimitAvailable() external view returns (uint256);

Returns

Events

MintRequested

Emitted when a mint is requested

event MintRequested(
    bytes32 indexed operationId,
    address indexed beneficiary,
    uint208 amount,
    uint48 nonce,
    uint48 notBefore,
    uint48 notAfter
);

MintExecuted

Emitted when a mint is executed

event MintExecuted(bytes32 indexed operationId, address indexed beneficiary);

MintCancelled

Emitted when a mint is cancelled

event MintCancelled(bytes32 indexed operationId, address indexed beneficiary, address indexed cancelledBy);

MaxMintAmountUpdated

Emitted when max mint amount is updated

event MaxMintAmountUpdated(uint256 oldMax, uint256 newMax);

RateLimitUpdated

Emitted when rate limit is updated

event RateLimitUpdated(uint256 oldAmount, uint48 oldPeriod, uint256 newAmount, uint48 newPeriod);

Errors

InvalidSignature

Error thrown when signature is invalid

TODO: Update to clarify usage (signer != beneficiary)

error InvalidSignature();

InvalidNonce

Error thrown when nonce is invalid

error InvalidNonce(uint48 expected, uint48 provided);

OrderInvalidTimeWindow

Error thrown when order time window is invalid (notAfter < notBefore)

error OrderInvalidTimeWindow();

OrderNotYetValid

Error thrown when current time is before notBefore

error OrderNotYetValid();

OrderExpired

Error thrown when current time is after notAfter

error OrderExpired();

MintAmountTooLarge

Error thrown when mint amount exceeds maximum

error MintAmountTooLarge(uint208 amount, uint208 maxAmount);

OrderNotFound

Error thrown when operation has no stored order

error OrderNotFound();

RateLimitExceeded

Error thrown when mint would exceed period rate limit

error RateLimitExceeded(uint208 requestedAmount, uint256 availableCapacity);

Structs

Order

Struct representing a mint order

Packed into 2 storage slots for gas efficiency

struct Order {
    address beneficiary; // 160 bits - slot 0
    uint48 notBefore; // 48 bits  - slot 0
    uint48 notAfter; // 48 bits  - slot 0
    // ============================================= slot boundary
    uint48 nonce; // 48 bits  - slot 1
    uint208 amount; // 208 bits - slot 1
}

MintRecord

Struct to track mint timestamps and amounts for rate limiting

struct MintRecord {
    uint48 timestamp;
    uint208 amount; // Packed to fit in single slot with timestamp
}

Enums

MintStatus

Enum representing the status of a mint operation

enum MintStatus {
    NotFound, // Order not in storage (never existed, or was executed/cancelled)
    Scheduled, // Order pending, before notBefore time or AccessManager delay not passed
    Ready, // Order pending and ready to execute (delay passed, within time window)
    Expired // Order pending, after notAfter (expired)
}