Angle is a decentralized stablecoin protocol, ruled by the veANGLE token and natively deployed on multiple EVM compatible chains (including Ethereum, Polygon, Optimism, Arbitrum, ...).
This repository contains the smart contracts for the cross-chain governance system for Angle Protocol relying on LayerZero message passing infrastructure.
It also comes with some utils and scripts to facilitate the creation and execution of proposals on top of the deployed system.
- Complete
test/Proposal.sol - You can simulate the proposal's execution by running
forge test -vvvv --match-contract Simulate - Eventually add tests to
test/Simulate.t.sol
Angle onchain governance works as follows:
- veANGLE holders vote on Ethereum on an OpenZeppelin
Governorimplementation calledAngleGovernorwith a predetermined quorum, voting delay and proposal threshold. - On every chain where the protocol is deployed, there is a
Timelockcontract which is admin of all the protocol contracts (Borrowing module, Transmuter, direct deposit modules, ...) of its chain. - While only onchain votes can lead to payloads being included in the
Timelockcontract of a chain before execution, Angle 4/6 Governance multisig (deployed on all chains as well) has a veto power on the payloads in Timelock contracts, and can cancel rogue governance votes. - For successful votes on non-Ethereum proposals, payloads to execute are bridged to the chain of interest using LayerZero message passing technology before being sent to the
Timelockcontract of their chain.
Precisely speaking, once a vote succeeds (majority of positive votes + quorum), the flow is the following:
- If the vote concerns an Ethereum action:
- The payload to execute is sent to the Ethereum
Timelockcontract. The Ethereum Timelock contract only accepts payload from theAngleGovernorcontract - After the timelock period ends, if the payload is not veto-ed by Angle Governance multisig on Ethereum, it can be executed on Ethereum.
- The payload to execute is sent to the Ethereum
- If the vote concerns an action on another chain:
- The payload to execute is sent to a
ProposalSendercontract on Ethereum which is a simple LayerZero message passing contract owned by theAngleGovernorcontract. - This payload is to be received on the destination chain by a
ProposalReceivercontract which role is to then send the payload to the Timelock contract of this chain.Timelockcontracts of non-Ethereum chains only accept payloads from their respectiveProposalReceivercontract.
- The payload to execute is sent to a
It's worth noting that, setup like this, the Angle Governance system can be abstracted among a decision module (AngleGovernor contract) and an execution module. Both are modular, and so any could be changed at any time in the future.
- The
AngleGovernorimplementation relies on several OpenZeppelin extensions as well as on the auditedGovernorCountingFractionalextension by ScopeLift. - The
ProposalReceiverandProposalSendercontracts are forks from LayerZero Labs implementation. Find their audits here.
For contracts deployed for the Angle Protocol, a bug bounty is open on Immunefi and Hats Finance. The rewards and scope of the Angle Immunefi are defined here.
All Angle governance deployment addresses can be found in the developers documentation here.
This repository is built on Foundry.
If you don't have Foundry:
curl -L https://foundry.paradigm.xyz | bash
source /root/.zshrc
# or, if you're under bash: source /root/.bashrc
foundryupTo install the standard library:
forge install foundry-rs/forge-stdTo update libraries:
forge updateYou can install all dependencies by running
yarn
forge iIn order to interact with non local networks, you must create an .env that has:
- a
MNEMONICfor each of the chain you - a network key
- an
ETHERSCAN_API_KEY
For additional keys, you can check the .env.example file.
- Always keep your confidential information safe
- This repository uses
ffiin its test suite. Beware as a malicious actor forking this repo may execute malicious commands on your machine
Compilation of production contracts is done using the via-ir pipeline.
However, tests do not compile with via-ir, and to run coverage the optimizer needs to be off. Therefore for development and test purposes you can compile without optimizer.
yarn compile # without compiling tests files
yarn compile:dev # with test files compilingHere are examples of how to run the test suite:
yarn test
yarn test --watch # To watch changing files
yarn test --match-path test/Test.t.sol
yarn test --match-test "testAbc*"
yarn test --fork-url <RPC_URL>You can also list tests:
yarn test --list
yarn test --list --json --match-test "testXXX*"We recommend the use of this vscode extension.
yarn coverageYou'll need to install lcov brew install lcov to visualize the coverage report.
yarn gasIf you're interested in contributing, please see our contributions guidelines.
For any question or feedback you can send an email to [email protected]. Don't hesitate to reach out on Twitter🐦 as well.
This repository is released under the MIT License.