OCR_Modular.sol

Introduction

OCR stands for "On-Chain Redemption".

This locker is responsible for handling redemptions of tranche tokens to stablecoins.

State Variables

Request

This struct stores information for redemptions requests.

Sections

Read Functions

• canPush() - Permission for owner to call pushToLocker(). See ZivoeLocker.sol

• canPull() - Permission for owner to call pullFromLocker(). See ZivoeLocker.sol

• canPullPartial() - Permission for owner to call pullFromLockerPartial(). See ZivoeLocker.sol

Write Functions

• pushToLocker() - This pulls capital from the DAO.

• pullFromLocker() - Migrates entire ERC20 balance from locker to owner().

• pullFromLockerPartial() - Migrates specific amount of ERC20 from locker to owner().

• createRequest() - Creates a redemptions request.

• destroyRequest() - Destroys a redemption request.

• processRequest() - Processes a redemption request.

• tickEpoch() - This function will start a new epoch.

• updateRedemptionsFeeBIPS() - Updates the state variable "redemptionFeeBips".

Events

• EpochTicked()

• RequestCreated()

• RequestDestroyed()

• RequestProcessed()

• UpdatedRedemptionsFeeBIPS()

Read Functions

canPush()

Permission for owner to call pushToLocker(). See ZivoeLocker.sol

 function canPush() public override pure returns (bool) { return true; }

canPull()

Permission for owner to call pullFromLocker(). See ZivoeLocker.sol

function canPull() public override pure returns (bool) { return true; }

canPullPartial()

Permission for owner to call pullFromLockerPartial(). See ZivoeLocker.sol

function canPullPartial() public override pure returns (bool) { return true; }

Write Functions

pushToLocker()

This pulls capital from the DAO.

function pushToLocker(
    address asset, 
    uint256 amount, 
    bytes calldata data
) external override _tickEpoch onlyOwner nonReentrant;

pullFromLocker()

Migrates entire ERC20 balance from locker to owner().

function pullFromLocker(address asset, bytes calldata data) external;

pullFromLockerPartial()

Migrates specific amount of ERC20 from locker to owner().

function pullFromLockerPartial(
    address asset, 
    uint256 amount, 
    bytes calldata data
) external;

createRequest()

Creates a redemptions request.

function createRequest(
    uint256 amount, 
    bool seniorElseJunior
) external _tickEpoch nonReentrant;

Emits the RequestCreated() event

destroyRequest()

Destroys a redemption request.

function destroyRequest(uint256 id) external _tickEpoch nonReentrant;

Emits the RequestDestroyed() event

processRequest()

Processes a redemption request.

function processRequest(uint256 id) external _tickEpoch nonReentrant;

Emits the RequestProcessed() event

tickEpoch()

This function will start a new epoch.

function tickEpoch() public;

Emits the EpochTicked() event

updateRedemptionsFeeBIPS()

Updates the state variable "redemptionFeeBips".

function updateRedemptionsFeeBIPS(
    uint256 _redemptionsFeeBIPS
) external _tickEpoch;

Emits the UpdatedRedemptionsFeeBIPS() event

Events

EpochTicked()

Emitted during tickEpoch()

event EpochTicked(
    uint256 epoch, 
    uint256 redemptionsAllowedJunior, 
    uint256 redemptionsAllowedSenior,
    uint256 epochDiscountJunior, 
    uint256 epochDiscountSenior
);

RequestCreated()

Emitted during createRequest()

event RequestCreated(
    uint256 indexed id, 
    address indexed account, 
    uint256 amount, 
    bool indexed seniorElseJunior
);

RequestDestroyed()

Emitted during destroyRequest()

event RequestDestroyed(
    uint256 indexed id, 
    address indexed account, 
    uint256 amount, 
    bool indexed seniorElseJunior
);

RequestProcessed()

Emitted during processRequest()

event RequestProcessed(
    uint256 indexed id, 
    address indexed account, 
    uint256 burnAmount, 
    uint256 redeemAmount, 
    bool indexed seniorElseJunior
);

UpdatedRedemptionsFeeBIPS()

Emitted during #updateredemptionsfee

event UpdatedOCTYDL(address indexed newOCT, address indexed oldOCT);