OCT_Convert.sol

OCT -> On-Chain Treasury

Introduction

This contract converts zJTT to zSTT, and allows zSTT withdrawals.

State Variables

Type	Name	Description
address	GBL	The ZivoeGlobals contract.
mapping(address => bool)	isDepositor	Whitelist for converters, managed by keepers.

Sections

Read Functions

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

• canPushMulti() - Permission for owner to call pushToLockerMulti(). See ZivoeLocker.sol

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

• canPullMulti() - Permission for owner to call pullFromLockerMulti(). See ZivoeLocker.sol

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

• canPullPartialMulti() - Permission for owner to call pullFromLockerMultiPartial(). See ZivoeLocker.sol

Write Functions

• updateWhitelist - Updates whitelist.
• convertTranche - Converts zJTT to zSTT.
• withdrawTranche - Converts zSTT to stablecoins.

Events

• TrancheConverted
• TrancheWithdrawn

Read Functions

canPush()

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

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

canPushMulti()

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

 function canPushMulti() 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; }

canPullMulti()

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

 function canPullMulti() 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; }

canPullPartialMulti()

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

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

Write Functions

updateWhitelist()

Updates whitelist.

function updateWhitelist(
    address user, 
    bool status
) external;

Type	Name	Description
address	user	The address to add/remove from whitelist.
bool	status	The new status of user (true = accepted, false = rejected).

convertTranche()

Converts zJTT to zSTT.

function convertTranche(
    uint amount, 
    address stablecoin
) external nonReentrant;

Type	Name	Description
uint	amount	The amount of stablecoin to use for conversion.
address	stablecoin	The stablecoin to use for conversion (will be transferred here from ZivoeDAO)

Emits the TrancheConverted event

withdrawTranche()

Converts zSTT to stablecoins.

function withdrawTranche(
    uint amount, 
    address stablecoin
) external nonReentrant;

Type	Name	Description
uint	amount	The amount of stablecoin to use for conversion.
address	stablecoin	The stablecoin to use for conversion (will be transferred here from ZivoeDAO)

Emits the TrancheWithdrawn event

Events

TrancheConverted()

Emitted during convertTranche

event TrancheConverted(
    address stablecoin,
    address caller,
    uint amount
);

Type	Indexed	Name	Description
address	False	stablecoin	The stablecoin converted.
address	False	caller	The caller of the function.
uint256	False	amount	The amount being converted.

TrancheWithdrawn()

Emitted during withdrawTranche

event TrancheWithdrawn(
    address stablecoin,
    address caller,
    uint amount
);

Type	Indexed	Name	Description
address	False	stablecoin	The stablecoin withdrawn.
address	False	caller	The caller of the function.
uint256	False	amount	The amount being withdrawn.