MarketFreezeGuardian_v1

Holds the emergency freeze state of one market. Source: src/core/modules/freeze/MarketFreezeGuardian_v1.sol. Interfaces: IMarketFreezeGuardian_v1.

Functions

approveReopen

function approveReopen(
    address market_,
    uint64 expectedEpoch_
) external returns (bytes32 operationHash_);

Approves reopening the market after the delay. Parameters

Name	Type	Description
`market_`	`address`	The market the approval applies to.
`expectedEpoch_`	`uint64`	The current freeze epoch, read before signing.

Returns

Name	Type	Description
`operationHash_`	`bytes32`	The hash that identifies the approval.

IMarketFreezeGuardian_v1.sol#L247

cancelReopen

function cancelReopen(bytes32 operationHash_) external;

Cancels the pending approval. Parameters

Name	Type	Description
`operationHash_`	`bytes32`	The hash of the pending approval.

IMarketFreezeGuardian_v1.sol#L254

executeReopen

function executeReopen(bytes32 operationHash_) external;

Reopens the market inside the execution window. Parameters

Name	Type	Description
`operationHash_`	`bytes32`	The hash of the pending approval.

IMarketFreezeGuardian_v1.sol#L259

freeze

function freeze(address market_, uint64 expectedEpoch_) external;

Freezes the market. Clears any pending approval. Parameters

Name	Type	Description
`market_`	`address`	The market to freeze. Must be this guardian’s market.
`expectedEpoch_`	`uint64`	The current freeze epoch, read before signing.

IMarketFreezeGuardian_v1.sol#L232

View functions

approvalSafe

function approvalSafe() external view returns (address approvalSafe_);

Returns the approval Safe. It may approve, cancel, and execute a reopen. Returns

Name	Type	Description
`approvalSafe_`	`address`	The approval Safe address.

IMarketFreezeGuardian_v1.sol#L191

emergencySafe

function emergencySafe() external view returns (address emergencySafe_);

Returns the emergency Safe. It may freeze the market only. Returns

Name	Type	Description
`emergencySafe_`	`address`	The emergency Safe address.

IMarketFreezeGuardian_v1.sol#L186

freezeEpoch

function freezeEpoch() external view returns (uint64 epoch_);

Returns the current freeze epoch. Returns

Name	Type	Description
`epoch_`	`uint64`	The current freeze epoch.

IMarketFreezeGuardian_v1.sol#L203

isFrozen

function isFrozen() external view returns (bool frozen_);

Returns whether the market is frozen. Returns

Name	Type	Description
`frozen_`	`bool`	True while the market is frozen.

IMarketFreezeGuardian_v1.sol#L199

pendingReopen

function pendingReopen() external view returns (PendingReopen memory pendingReopen_);

Returns the pending reopen, if any. Returns

Name	Type	Description
`pendingReopen_`	`PendingReopen`	The pending reopen record.

IMarketFreezeGuardian_v1.sol#L211

referenceCurve

function referenceCurve() external view returns (address referenceCurve_);

Returns the market this guardian serves. Returns

Name	Type	Description
`referenceCurve_`	`address`	The ReferenceCurve address of the market.

IMarketFreezeGuardian_v1.sol#L195

reopenStatus

function reopenStatus() external view returns (ReopenStatus status_);

Returns the state of the stored reopen approval at the current block time. Returns

Name	Type	Description
`status_`	`ReopenStatus`	None, Waiting, Eligible, or Expired.

IMarketFreezeGuardian_v1.sol#L219

Events

MarketFreezeRearmed

event MarketFreezeRearmed(address indexed market_, uint64 epoch_);

A freeze was called while the market was already frozen. The epoch advanced and any pending approval was cleared. Parameters

Name	Type	Description
`market_`	`address indexed`	The frozen market.
`epoch_`	`uint64`	The new freeze epoch.

IMarketFreezeGuardian_v1.sol#L153

MarketFrozen

event MarketFrozen(address indexed market_, uint64 epoch_);

The market was frozen from the open state. Parameters

Name	Type	Description
`market_`	`address indexed`	The frozen market.
`epoch_`	`uint64`	The new freeze epoch.

IMarketFreezeGuardian_v1.sol#L147

MarketReopened

event MarketReopened(bytes32 indexed operationHash_, uint64 epoch_);

The market was reopened. Parameters

Name	Type	Description
`operationHash_`	`bytes32 indexed`	The hash of the executed approval.
`epoch_`	`uint64`	The freeze epoch that was closed.

IMarketFreezeGuardian_v1.sol#L179

ReopenApproved

event ReopenApproved(
    bytes32 indexed operationHash_,
    uint64 epoch_,
    uint64 executeAfter_,
    uint64 expiresAt_
);

A reopen was approved. Parameters

Name	Type	Description
`operationHash_`	`bytes32 indexed`	The hash that identifies the approval.
`epoch_`	`uint64`	The freeze epoch of the approval.
`executeAfter_`	`uint64`	The first executable timestamp.
`expiresAt_`	`uint64`	The first timestamp after the window.

IMarketFreezeGuardian_v1.sol#L160

ReopenCancelled

event ReopenCancelled(bytes32 indexed operationHash_);

A pending approval was cancelled by the approval Safe. Parameters

Name	Type	Description
`operationHash_`	`bytes32 indexed`	The hash of the cancelled approval.

IMarketFreezeGuardian_v1.sol#L169

ReopenInvalidated

event ReopenInvalidated(bytes32 indexed operationHash_);

A pending approval was cleared by a freeze or by a new approval after expiry. Parameters

Name	Type	Description
`operationHash_`	`bytes32 indexed`	The hash of the cleared approval.

IMarketFreezeGuardian_v1.sol#L174

Errors

MarketFreezeGuardian__EpochMismatch

error MarketFreezeGuardian__EpochMismatch(uint64 expected_, uint64 given_);

The call names a freeze epoch other than the current epoch. Parameters

Name	Type	Description
`expected_`	`uint64`	The current freeze epoch.
`given_`	`uint64`	The epoch named by the caller.

IMarketFreezeGuardian_v1.sol#L110

MarketFreezeGuardian__InvalidConfiguration

error MarketFreezeGuardian__InvalidConfiguration();

A constructor argument is zero, has no code, or the two Safes are equal. IMarketFreezeGuardian_v1.sol#L95

MarketFreezeGuardian__MarketMismatch

error MarketFreezeGuardian__MarketMismatch(address expected_, address given_);

The call names a market other than this guardian’s market. Parameters

Name	Type	Description
`expected_`	`address`	The market of this guardian.
`given_`	`address`	The market named by the caller.

IMarketFreezeGuardian_v1.sol#L100

MarketFreezeGuardian__NoPendingReopen

error MarketFreezeGuardian__NoPendingReopen();

No approval is pending. IMarketFreezeGuardian_v1.sol#L116

MarketFreezeGuardian__NotFrozen

error MarketFreezeGuardian__NotFrozen();

The market is open, so the operation needs a frozen market. IMarketFreezeGuardian_v1.sol#L113

MarketFreezeGuardian__OperationHashMismatch

error MarketFreezeGuardian__OperationHashMismatch(bytes32 expected_, bytes32 given_);

The operation hash does not match the pending approval. Parameters

Name	Type	Description
`expected_`	`bytes32`	The hash of the pending approval.
`given_`	`bytes32`	The hash supplied by the caller.

IMarketFreezeGuardian_v1.sol#L121

MarketFreezeGuardian__ReopenAlreadyPending

error MarketFreezeGuardian__ReopenAlreadyPending(bytes32 operationHash_, uint expiresAt_);

A live approval is pending. Cancel it, or wait for it to expire, before approving again. Parameters

Name	Type	Description
`operationHash_`	`bytes32`	The hash of the pending approval.
`expiresAt_`	`uint`	The first timestamp after its window.

IMarketFreezeGuardian_v1.sol#L137

MarketFreezeGuardian__ReopenExpired

error MarketFreezeGuardian__ReopenExpired(uint expiresAt_);

The execution window has closed. Parameters

Name	Type	Description
`expiresAt_`	`uint`	The first timestamp after the window.

IMarketFreezeGuardian_v1.sol#L131

MarketFreezeGuardian__ReopenTooEarly

error MarketFreezeGuardian__ReopenTooEarly(uint executeAfter_);

The execution delay has not passed. Parameters

Name	Type	Description
`executeAfter_`	`uint`	The first executable timestamp.

IMarketFreezeGuardian_v1.sol#L127

MarketFreezeGuardian__Unauthorized

error MarketFreezeGuardian__Unauthorized(address caller_);

The caller is not the Safe that may call the function. Parameters

Name	Type	Description
`caller_`	`address`	The rejected caller.

IMarketFreezeGuardian_v1.sol#L91

Overview

How it works

Deployments

Reference