Skip to content

Latest commit

 

History

History
87 lines (50 loc) · 3.49 KB

README.md

File metadata and controls

87 lines (50 loc) · 3.49 KB
Raw

Web_Official_Dark

Zivoe (zivoe-core-foundry)

Docs

This repository contains the core Zivoe v1 smart contracts.

For a high-level introduction to Zivoe, see Public Docs.


audited by



Audit Report - Core

Audit Report - Lockers


Structure

This is a forge (foundry-rs) repository, with libraries in the lib folder, core contracts in the src folder, and lockers in the lockers folder.


Core-Contracts

All core contracts for the Zivoe protocol are in the root src folder.

ZivoeDAO.sol - escrows capital from liquidity providers, governance then allocates this to lockers.

ZivoeGlobals.sol - stores global values utilized by all core contracts.

ZivoeGovernorV2.sol - implements governance modules from OpenZeppelin for governance.

ZivoeITO.sol - conducts the Initial Tranche Offering ("ITO").

ZivoeLocker.sol - an abstract base contract, inherited by all lockers in src/lockers.

ZivoeMath.sol - a mathematics contract, which handles accounting features in tandem with ZivoeYDL.

ZivoeRewards.sol - a multi-rewards staking contract for $zJTT/$zSTT/$ZVE.

ZivoeRewardsVesting.sol - a multi-rewards staking contract for internal $ZVE vesting schedules.

ZivoeToken.sol - $ZVE, the native protocol token, used for governance and staking.

ZivoeTranches.sol - handles ongoing deposits to the DAO in exchange for $zJTT/$zSTT.

ZivoeTrancheToken.sol - utilized to launch two tranche tokens (senior and junior, $zSTT/$zJTT).

ZivoeYDL.sol - handles yield distribution accounting for the Zivoe protocol.

Within the src directory are the following sub-directories:

  • libraries: Custom libraries implemented or adapted for Zivoe.

    • libraries/FloorMath.sol: Custom mathematis library for floor math.
    • libraries/OwnableLocked.sol: Custom Ownable implementation with immutability.
    • libraries/ZivoeGTC.sol: Custom GovernorTimelockController implementation.
    • libraries/ZivoeTLC.sol: Custom TimelockController implementation.

  • lockers: Custom lockers which facilitate ZivoeDAO capital allocations.

    • lockers/OCC: On Chain Credit (direct loans)
    • lockers/OCE: On Chain Exponential (exponentially decaying $ZVE emissions schedule)
    • lockers/OCG: On Chain Generic (for test purposes)
    • lockers/OCL: On Chain Liquidity (for liquidity provisioning)
    • lockers/OCR: On Chain Redemptions (for redeeming capital)
    • lockers/OCT: On Chain Treasury (for asset conversions)
    • lockers/OCY: On Chain Yield (for yield generation)
    • lockers/Utility: Helper contracts (for utility purposes)

  • misc: Utility files (templates, suites, et cetera).


Website: zivoe.finance

Twitter: @ZivoeFinance

Contact: [email protected]