Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
1 change: 1 addition & 0 deletions LICENSE
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ Copyright (C) 2020 Maker Ecosystem Growth Holdings, INC.
Copyright (C) 2020 Reflexer Labs, INC.
Copyright (C) 2015-2020 DappHub, LLC
Copyright (C) 2023 Reflexer Labs, INC.
Copyright (C) 2023-2025 Azos Labs

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
Expand Down
1 change: 1 addition & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ Copyright (C) 2020 Maker Ecosystem Growth Holdings, INC.
Copyright (C) 2020 Reflexer Labs, INC.
Copyright (C) 2015-2020 DappHub, LLC
Copyright (C) 2023 Reflexer Labs, INC.
Copyright (C) 2023-2025 Azos Labs

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# HAI
# Azos

This repository contains the core smart contract code for HAI, a GEB fork. GEB is the abbreviation of [Gödel, Escher and Bach](https://en.wikipedia.org/wiki/G%C3%B6del,_Escher,_Bach) as well as the name of an [Egyptian god](https://en.wikipedia.org/wiki/Geb).
This repository contains the core smart contract code for Azos, a GEB fork. GEB is the abbreviation of [Gödel, Escher and Bach](https://en.wikipedia.org/wiki/G%C3%B6del,_Escher,_Bach) as well as the name of an [Egyptian god](https://en.wikipedia.org/wiki/Geb).
4 changes: 2 additions & 2 deletions docs/book.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[book]
src = "src"
title = "HAI docs"
title = "Azos docs"
description = ''
language = 'en'

Expand All @@ -9,7 +9,7 @@ no-section-label = true
theme = 'src/theme'
additional-css = ['src/theme/css/fonts.css', 'src/theme/css/colors.css', 'src/theme/css/base.css']
additional-js = ['src/theme/js/theme.js', 'src/theme/js/base.js', 'src/theme/js/solidity.min.js']
git-repository-url = "https://github.com/hai-on-op/hai/"
git-repository-url = "https://github.com/azosFinance/hai-core/"
git-repository-icon = 'fa-github'
mathjax-support = true

Expand Down
34 changes: 17 additions & 17 deletions docs/src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@
# Documentation

- [❱ Getting Started](detailed/intro/README.md)
- [Introduction to HAI](detailed/intro/hai.md)
- [HAI Protocol 101](detailed/intro/protocol.md)
- [Introduction to Azos](detailed/intro/azos.md)
- [Azos Protocol 101](detailed/intro/protocol.md)
- [❱ Core Modules](detailed/modules/README.md)
- [SAFE Engine](detailed/modules/safe_engine.md)
- [Accounting Engine](detailed/modules/acc_engine.md)
Expand Down Expand Up @@ -36,9 +36,9 @@
- [Authorizable Child](detailed/utils/factory/authorizable_child.md)
- [Disableable Child](detailed/utils/factory/disableable_child.md)
- [❱ Proxy Utils](detailed/proxies/README.md)
- [HAI Proxy](detailed/proxies/hai_proxy.md)
- [Proxy Factory](detailed/proxies/hai_proxy_factory.md)
- [SAFE Manager](detailed/proxies/hai_safe_manager.md)
- [Azos Proxy](detailed/proxies/azos_proxy)
- [Proxy Factory](detailed/proxies/azos_proxy_factory.md)
- [SAFE Manager](detailed/proxies/azos_safe_manager.md)
- [❱ Actions](detailed/proxies/actions/README.md)
- [Basic Actions](detailed/proxies/actions/basic_actions.md)
- [Rewarded Actions](detailed/proxies/actions/rewarded_actions.md)
Expand Down Expand Up @@ -71,8 +71,8 @@
- [HardcodedOracle](src/contracts/for-test/HardcodedOracle.sol/contract.HardcodedOracle.md)
- [MintableERC20](src/contracts/for-test/MintableERC20.sol/contract.MintableERC20.md)
- [❱ governance](src/contracts/governance/README.md)
- [HaiDelegatee](src/contracts/governance/HaiDelegatee.sol/contract.HaiDelegatee.md)
- [HaiGovernor](src/contracts/governance/HaiGovernor.sol/contract.HaiGovernor.md)
- [AzosDelegatee](src/contracts/governance/AzosDelegatee.sol/contract.AzosDelegatee.md)
- [AzosGovernor](src/contracts/governance/AzosGovernor.sol/contract.AzosGovernor.md)
- [❱ jobs](src/contracts/jobs/README.md)
- [AccountingJob](src/contracts/jobs/AccountingJob.sol/contract.AccountingJob.md)
- [Job](src/contracts/jobs/Job.sol/abstract.Job.md)
Expand All @@ -94,9 +94,9 @@
- [PostSettlementSurplusBidActions](src/contracts/proxies/actions/PostSettlementSurplusBidActions.sol/contract.PostSettlementSurplusBidActions.md)
- [RewardedActions](src/contracts/proxies/actions/RewardedActions.sol/contract.RewardedActions.md)
- [SurplusBidActions](src/contracts/proxies/actions/SurplusBidActions.sol/contract.SurplusBidActions.md)
- [HaiProxy](src/contracts/proxies/HaiProxy.sol/contract.HaiProxy.md)
- [HaiProxyFactory](src/contracts/proxies/HaiProxyFactory.sol/contract.HaiProxyFactory.md)
- [HaiSafeManager](src/contracts/proxies/HaiSafeManager.sol/contract.HaiSafeManager.md)
- [AzosProxy](src/contracts/proxies/AzosProxy.sol/contract.AzosProxy.md)
- [AzosProxyFactory](src/contracts/proxies/AzosProxyFactory.sol/contract.AzosProxyFactory.md)
- [AzosSafeManager](src/contracts/proxies/AzosSafeManager.sol/contract.AzosSafeManager.md)
- [SAFEHandler](src/contracts/proxies/SAFEHandler.sol/contract.SAFEHandler.md)
- [❱ settlement](src/contracts/settlement/README.md)
- [GlobalSettlement](src/contracts/settlement/GlobalSettlement.sol/contract.GlobalSettlement.md)
Expand All @@ -112,7 +112,7 @@
- [CoinJoin](src/contracts/utils/CoinJoin.sol/contract.CoinJoin.md)
- [CollateralJoin](src/contracts/utils/CollateralJoin.sol/contract.CollateralJoin.md)
- [Disableable](src/contracts/utils/Disableable.sol/abstract.Disableable.md)
- [HaiOwnable2Step](src/contracts/utils/HaiOwnable2Step.sol/abstract.HaiOwnable2Step.md)
- [AzosOwnable2Step](src/contracts/utils/AzosOwnable2Step.sol/abstract.AzosOwnable2Step.md)
- [Modifiable](src/contracts/utils/Modifiable.sol/abstract.Modifiable.md)
- [ModifiablePerCollateral](src/contracts/utils/ModifiablePerCollateral.sol/abstract.ModifiablePerCollateral.md)
- [AccountingEngine](src/contracts/AccountingEngine.sol/contract.AccountingEngine.md)
Expand Down Expand Up @@ -152,8 +152,8 @@
- [IUniV3RelayerChild](src/interfaces/factories/IUniV3RelayerChild.sol/interface.IUniV3RelayerChild.md)
- [IUniV3RelayerFactory](src/interfaces/factories/IUniV3RelayerFactory.sol/interface.IUniV3RelayerFactory.md)
- [❱ governance](src/interfaces/governance/README.md)
- [IHaiDelegatee](src/interfaces/governance/IHaiDelegatee.sol/interface.IHaiDelegatee.md)
- [IHaiGovernor](src/interfaces/governance/IHaiGovernor.sol/interface.IHaiGovernor.md)
- [IAzosDelegatee](src/interfaces/governance/IAzosDelegatee.sol/interface.IAzosDelegatee.md)
- [IAzosGovernor](src/interfaces/governance/IAzosGovernor.sol/interface.IAzosGovernor.md)
- [❱ jobs](src/interfaces/jobs/README.md)
- [IAccountingJob](src/interfaces/jobs/IAccountingJob.sol/interface.IAccountingJob.md)
- [IJob](src/interfaces/jobs/IJob.sol/interface.IJob.md)
Expand All @@ -176,9 +176,9 @@
- [IGlobalSettlementActions](src/interfaces/proxies/actions/IGlobalSettlementActions.sol/interface.IGlobalSettlementActions.md)
- [IRewardedActions](src/interfaces/proxies/actions/IRewardedActions.sol/interface.IRewardedActions.md)
- [ISurplusBidActions](src/interfaces/proxies/actions/ISurplusBidActions.sol/interface.ISurplusBidActions.md)
- [IHaiProxy](src/interfaces/proxies/IHaiProxy.sol/interface.IHaiProxy.md)
- [IHaiProxyFactory](src/interfaces/proxies/IHaiProxyFactory.sol/interface.IHaiProxyFactory.md)
- [IHaiSafeManager](src/interfaces/proxies/IHaiSafeManager.sol/interface.IHaiSafeManager.md)
- [IAzosProxy](src/interfaces/proxies/IAzosProxy.sol/interface.IAzosProxy.md)
- [IAzosProxyFactory](src/interfaces/proxies/IAzosProxyFactory.sol/interface.IAzosProxyFactory.md)
- [IAzosSafeManager](src/interfaces/proxies/IAzosSafeManager.sol/interface.IAzosSafeManager.md)
- [❱ settlement](src/interfaces/settlement/README.md)
- [IGlobalSettlement](src/interfaces/settlement/IGlobalSettlement.sol/interface.IGlobalSettlement.md)
- [IPostSettlementSurplusAuctionHouse](src/interfaces/settlement/IPostSettlementSurplusAuctionHouse.sol/interface.IPostSettlementSurplusAuctionHouse.md)
Expand All @@ -193,7 +193,7 @@
- [ICoinJoin](src/interfaces/utils/ICoinJoin.sol/interface.ICoinJoin.md)
- [ICollateralJoin](src/interfaces/utils/ICollateralJoin.sol/interface.ICollateralJoin.md)
- [IDisableable](src/interfaces/utils/IDisableable.sol/interface.IDisableable.md)
- [IHaiOwnable2Step](src/interfaces/utils/IHaiOwnable2Step.sol/interface.IHaiOwnable2Step.md)
- [IAzosOwnable2Step](src/interfaces/utils/IAzosOwnable2Step.sol/interface.IAzosOwnable2Step.md)
- [IModifiable](src/interfaces/utils/IModifiable.sol/interface.IModifiable.md)
- [IModifiablePerCollateral](src/interfaces/utils/IModifiablePerCollateral.sol/interface.IModifiablePerCollateral.md)
- [IAccountingEngine](src/interfaces/IAccountingEngine.sol/interface.IAccountingEngine.md)
Expand Down
2 changes: 1 addition & 1 deletion docs/src/detailed/auctions/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Introduction

Auction Houses are core smart contracts in the HAI Protocol that manage debt, surplus, and collateral through automated auctions. Whether you're an active participant or simply interested in HAI's stability mechanisms, understanding these components is crucial.
Auction Houses are core smart contracts in the Azos Protocol that manage debt, surplus, and collateral through automated auctions. Whether you're an active participant or simply interested in Azos's stability mechanisms, understanding these components is crucial.

### Types of Auction Houses

Expand Down
2 changes: 1 addition & 1 deletion docs/src/detailed/auctions/cah.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ See [CollateralAuctionHouse.sol](/src/contracts/CollateralAuctionHouse.sol/contr

## 1. Introduction

The Collateral Auction House plays a crucial role in maintaining the stability of the HAI Protocol by handling the auction of collateral seized from undercollateralized SAFEs. The primary objective is to convert this confiscated collateral into system coins, which are then forwarded to the Accounting Engine for debt destruction.
The Collateral Auction House plays a crucial role in maintaining the stability of the Azos Protocol by handling the auction of collateral seized from undercollateralized SAFEs. The primary objective is to convert this confiscated collateral into system coins, which are then forwarded to the Accounting Engine for debt destruction.

The Collateral Auction House utilizes an increasing discount model. This encourages early bidding by incrementally increasing the discount applied to the collateral over time. The rationale behind this is to expedite the auction process and ensure that debts are covered as swiftly as possible.

Expand Down
2 changes: 1 addition & 1 deletion docs/src/detailed/intro/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# ❱ Getting Started

Welcome to the "Getting Started" guide for the HAI Protocol. If you're new to the system or looking for a concise introduction, you've come to the right place. This section is designed to provide you with a straightforward overview of the essential concepts and steps needed to interact with the HAI ecosystem. Whether you're planning to mint stablecoins, or understand the intricacies of our smart contracts, this guide will equip you with the basic knowledge to take your first steps. Let's dive in!
Welcome to the "Getting Started" guide for the Azos Protocol. If you're new to the system or looking for a concise introduction, you've come to the right place. This section is designed to provide you with a straightforward overview of the essential concepts and steps needed to interact with the Azos ecosystem. Whether you're planning to mint stablecoins, or understand the intricacies of our smart contracts, this guide will equip you with the basic knowledge to take your first steps. Let's dive in!
42 changes: 42 additions & 0 deletions docs/src/detailed/intro/azos.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# Introduction to Azos

## Introduction to Azos: A Framework for Stablecoin Systems

Azos serves as a framework for creating systems capable of issuing stablecoins. These stablecoins not only act as a reliable source of collateral for other DeFi protocols—when compared to assets like ETH or BTC—but also function as a store of value, complete with an integrated funding rate.

For a comprehensive understanding of the Azos framework, this documentation aims to detail each of its components. We strongly recommend reviewing Reflexer's original [whitepaper](https://github.com/reflexer-labs/whitepapers/blob/master/English/rai-english.pdf) as a precursor to this documentation.

### Core Differentiators of Azos from GEB

Azos is an enhanced fork of [GEB](https://github.com/reflexer-labs/geb), but it comes with several key distinctions:

- **Advanced System Parameter Controls**: Azos features refined mechanisms for managing system parameters, offering superior flexibility and control.
- **Enhanced Deployment and Upgradeability**: The framework allows for streamlined deployment and upgrades, simplifying system maintenance.
- **Robust Testing and Simulation Suite**: Azos includes an upgraded testing and simulation environment, aiding in the identification and mitigation of system risks.
- **Emphasis on Multi-Collateral Operations**: Azos is designed with a focus on handling multiple types of collateral, broadening its application scope.
- **Inclusion of Factories for Common Contract Types**: The framework comes with pre-built factories for commonly used contract types, reducing the operations needed for collateral setup.
- **Standardized Methods and Contract Utilities**: Azos standardizes the way contracts and methods are utilized, making it easier for developers to generate changes across the system.
- **Revamped Contract Interactions**: The framework restructures the way contracts communicate with each other, leading to more efficient and reliable operations.

By incorporating these features, Azos aims to provide a more advanced, reliable, and user-friendly stablecoin system.

### Chainlink Oracles

Azos uses the industry-standard decentralized oracle Chainlink as its primary oracle which provides highly secure and reliable, tamper-resistant data feeds.

Chainlink oracles are used across our Optimism instance:

| **Asset** |
| ---------- |
| WETH-USD |
| wstETH-USD |
| tBTC-USD |
| rETH-USD |
| OP-USD |
| SNX-USD |
| VELO-USD |
| LINK-USD |

### DIA Oracles

Azos uses DIA Oracles as one of its solutions for crypto assets pricing. DIA is a Modular Oracle that delivers frequently updated, reliable, and diverse data feeds in a few models. Azos utilizes Push model which ensures that data is pushed into on-chain storage via a relayer with set conditions. (heartbeat and deviation threshold)
42 changes: 0 additions & 42 deletions docs/src/detailed/intro/hai.md

This file was deleted.

12 changes: 6 additions & 6 deletions docs/src/detailed/intro/protocol.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# HAI Protocol 101
# Azos Protocol 101

## HAI Framework Mechanics
## Azos Framework Mechanics

### What is HAI?
### What is Azos?

- **Low-Cost**: The HAI protocol is deployed on the Optimism network, offering significantly low gas fees for transactions.
- **Low-Cost**: The Azos protocol is deployed on the Optimism network, offering significantly low gas fees for transactions.
- **Dollar-Denominated**: Both the system coin and the collaterals are denominated in US Dollar.
- **Collateral-Backed**: A diverse basket of collateral types backs the minting of the system coin.
- **Control-Pegged**: A PID controller dynamically adjusts the funding rate to balance value transfer between minters (debtors) and holders (creditors).
- **Settleable**: The system can undergo a Global Settlement, during which all debts are squared and HAI holders can redeem tokens for a share of the collateral pool, regardless of whether they have outstanding debts.
- **Settleable**: The system can undergo a Global Settlement, during which all debts are squared and Azos holders can redeem tokens for a share of the collateral pool, regardless of whether they have outstanding debts.

### Glossary

Expand All @@ -22,7 +22,7 @@

#### Tokens

- `systemCoin`: The ERC20 stablecoin issued by HAI.
- `systemCoin`: The ERC20 stablecoin issued by Azos.
- `protocolToken`: The ERC20 governance token, used for system parameter voting and participating in debt/surplus auctions.
- `collateral`: Any ERC20 token that serves as collateral, enhancing the corresponding `cType` balance.

Expand Down
Loading