This repo contains all the smart contracts code that is used for the MAHA.xyz protocol. The MAHA protocol governs ZAI. A decentralized stablecoin that allows users to execute leverage on assets within the ethersphere.
To use the contracts in your solidity project or integrate with your frontend (using ethers v6), you can use the following npm package.
yarn add --dev @mahaxyz/contracts
or
npm install --save-dev @mahaxyz/contracts
There are two test suites that this repository uses.
- Foundry - Foundry is used to conduct various fuzzing and invariant tests.
- Certora - Certora is used to conduct all kinds of formal verification tests. This is more in-depth than the foundry tests but run a lot slower.
To compile and run the unit tests, simply run the following commands.
yarn
yarn compile
yarn test
Unit test coverages for foundry can be found here.
To deploy the contracts, we use hardat-deploy to deploy the various contracts. Deployments are saved in the deployments folder and synced with our npm repository. Open the deploy folder to view the scripts that can be executed.
The below command is an example of how to execute the deploy-zai.ts script.
npx hardhat deploy --tags ZAIStablecoin --network mainnet
The ZAI stablecoin is incredibly minimal. With the core modules written in less than 400 lines of code. At the crux of the stablecoin is the Peg-stability Module and the Direct Deposit Module. These module control the stability and the growth of ZAI.
The incentive model is designed in such a way that there's a postive feedback loop for the growth of ZAI based on how much borrowing demand and interest fees ZAI generates.
The following links give more information about the various components and go more in-depth.
- docs.maha.xyz - Contains a high level overview of the entire protocol including architecture documentation.
- wiki pages - The wiki pages contains the technical documentation for each contract and what they do.
- test folders - The unit tests for the protocol are also documented and can be browsed through for insights about how each test works.
For any questions or queries, feel free to reach out to us on Discord