ZivoeTranches.sol

Introduction

This contract will facilitate ongoing liquidity provision to Zivoe tranches - Junior, Senior.

This contract will be permissioned by $zJTT and $zSTT to call mint().

This contract will support a whitelist for stablecoins to provide as liquidity.

State Variables

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

• isJuniorOpen() - Checks if stablecoins deposits into the Junior Tranche are open.

• rewardZVEJuniorDeposit() - Returns the total rewards in $ZVE for a certain junior tranche deposit amount.

• rewardZVESeniorDeposit() - Returns the total rewards in $ZVE for a certain senior tranche deposit amount.

Write Functions

• pushToLocker() - This pulls capital from the DAO, does any necessary pre-conversions, and escrows ZVE for incentives.

• depositJunior() - Deposit stablecoins into the junior tranche. Mints Zivoe Junior Tranche ($zJTT) tokens in 1:1 ratio.

• depositSenior() - Deposit stablecoins into the senior tranche. Mints Zivoe Senior Tranche ($zSTT) tokens in 1:1 ratio.

• switchPause() - Pauses or unpauses the contract, enabling or disabling depositJunior() and depositSenior().

• updateLowerRatioIncentiveBIPS() - Updates the lower ratio between tranches for minting incentivization model.

• updateMaxTrancheRatio() - Updates the maximum size of junior tranche, relative to senior tranche.

• updateMaxZVEPerJTTMint() - Updates the maximum $ZVE minted per stablecoin deposited to ZivoeTranches.

• updateMinZVEPerJTTMint() - Updates the minimum $ZVE minted per stablecoin deposited to ZivoeTranches.

• updateUpperRatioIncentiveBIPS() - Updates the upper ratio between tranches for minting incentivization model.

• unlock() - Unlocks this contract for distributions, sets some initial variables.

Events

• JuniorDeposit()

• SeniorDeposit()

• UpdatedLowerRatioIncentiveBIPS()

• UpdatedMaxTrancheRatioBIPS()

• UpdatedMaxZVEPerJTTMint()

• UpdatedMinZVEPerJTTMint()

• UpdatedUpperRatioIncentiveBIPS()

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; }

isJuniorOpen()

Checks if stablecoins deposits into the Junior Tranche are open.

function isJuniorOpen(
    uint256 amount,
    address asset
) public view returns (bool open);

Returns

rewardZVEJuniorDeposit()

Returns the total rewards in $ZVE for a certain junior tranche deposit amount.

function rewardZVEJuniorDeposit(
    uint256 deposit
) public view returns (uint256 reward);

Returns

rewardZVESeniorDeposit()

Returns the total rewards in $ZVE for a certain senior tranche deposit amount.

function rewardZVESeniorDeposit(
    uint256 deposit
) public view returns (uint256 reward);

Returns

Write Functions

pushToLocker()

This pulls capital from the DAO, does any necessary pre-conversions, and escrows ZVE for incentives.

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

depositBoth()

Deposit stablecoins to both tranches simultaneously

function depositBoth(
    uint256 amountSenior, 
    address assetSenior, 
    uint256 amountJunior, 
    address assetJunior
) external;

depositBothInverse()

Deposit stablecoins to both tranches simultaneously, inverse order

function depositBothInverse(
    uint256 amountSenior, 
    address assetSenior, 
    uint256 amountJunior, 
    address assetJunior
) external;

depositJunior()

Deposit stablecoins into the junior tranche. Mints Zivoe Junior Tranche ($zJTT) tokens in 1:1 ratio.

function depositJunior(
    uint256 amount, 
    address asset
) external notPaused nonReentrant;

Emits the JuniorDeposit() event

depositSenior()

Deposit stablecoins into the senior tranche. Mints Zivoe Senior Tranche ($zSTT) tokens in 1:1 ratio.

function depositSenior(
    uint256 amount, 
    address asset
) external notPaused nonReentrant;

Emits the SeniorDeposit() event

switchPause()

Pauses or unpauses the contract, enabling or disabling depositJunior() and depositSenior().

function switchPause() external;

updateLowerRatioIncentiveBIPS()

Updates the lower ratio between tranches for minting incentivization model.

function updateLowerRatioIncentiveBIPS(
    uint256 _lowerRatioIncentiveBIPS
) external onlyGovernance;

Emits the UpdatedLowerRatioIncentiveBIPS() event

updateMaxTrancheRatio()

Updates the maximum size of junior tranche, relative to senior tranche.

function updateMaxTrancheRatio(uint256 ratio) external onlyGovernance;

Emits the UpdatedMaxTrancheRatioBIPS() event

updateMaxZVEPerJTTMint()

Updates the maximum $ZVE minted per stablecoin deposited to ZivoeTranches.

function updateMaxZVEPerJTTMint(uint256 max) external onlyGovernance;

Emits the UpdatedMaxZVEPerJTTMint()

updateMinZVEPerJTTMint()

Updates the minimum $ZVE minted per stablecoin deposited to ZivoeTranches.

function updateMinZVEPerJTTMint(uint256 min) external onlyGovernance;

Emits the UpdatedMinZVEPerJTTMint() event

updateUpperRatioIncentiveBIPS()

Updates the upper ratio between tranches for minting incentivization model.

function updateUpperRatioIncentiveBIPS(
    uint256 _upperRatioIncentiveBIPS
) external onlyGovernance;

Emits the UpdatedUpperRatioIncentiveBIPS() event

unlock()

Unlocks this contract for distributions, sets some initial variables.

function unlock() external;

Events

JuniorDeposit()

Emitted during depositJunior()

event JuniorDeposit(
    address indexed account, 
    address indexed asset, 
    uint256 amount, 
    uint256 incentives
);

SeniorDeposit()

Emitted during depositSenior()

event SeniorDeposit(
    address indexed account, 
    address indexed asset, 
    uint256 amount, 
    uint256 incentives
);

UpdatedLowerRatioIncentiveBIPS()

Emitted during updateLowerRatioIncentiveBIPS()

event UpdatedLowerRatioIncentiveBIPS(uint256 oldValue, uint256 newValue);

UpdatedMaxTrancheRatioBIPS()

Emitted during updateMaxTrancheRatio()

event UpdatedMaxTrancheRatioBIPS(uint256 oldValue, uint256 newValue);

UpdatedMaxZVEPerJTTMint()

Emitted during updateMaxZVEPerJTTMint()

event UpdatedMaxZVEPerJTTMint(uint256 oldValue, uint256 newValue);

UpdatedMinZVEPerJTTMint()

Emitted during updateMinZVEPerJTTMint()

event UpdatedMinZVEPerJTTMint(uint256 oldValue, uint256 newValue);

UpdatedUpperRatioIncentiveBIPS()

Emitted during updateUpperRatioIncentiveBIPS()

event UpdatedUpperRatioIncentiveBIPS(uint256 oldValue, uint256 newValue);