This repository contains router contracts for the Angle Protocol. These contracts are designed to facilitate the composition of actions on top of Angle and other protocols in a single transaction.
There is one router contract per chain on which the protocol is natively deployed with a very similar implementation each time.
Across all chains, router contracts implementations rely on a mixer() function that can be called with a set of instructions, including the different actions it can perform and their parameters.
Instructions can range from transferring funds to another address, performing a swap on 1Inch, opening a perpetual, depositing in an ERC4626 contract, wrapping the native token of a chain (e.g ETH to wETH), ...
Some actions are possible on some chains but not on others, and we recommend to look at the implementation of the contract to view what kind of actions are supported.
The list of all potentially available actions is defined in the ActionType enum.
You can install all dependencies by running
yarn
forge iIn order to interact with non local networks, you must create an .env that has:
MNEMONIC- network key
ETHERSCAN_API_KEY
For additional keys, you can check the .env.example file.
Warning: always keep your confidential information safe.
Contracts in this repo rely on Hardhat tests. You can run tests as follows:
yarn hardhat:test ./test/hardhat/router/baseRouter.test.tsYou can also check the coverage of the tests with:
yarn hardhat:coverageyarn hardhat:coverageyarn deploy mainnetMake sure to change the tag corresponding to the file you're deploying, and to adapt the CoreBorrow, Treasury and ProxyAdmin to your use case.
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 updateDon't hesitate to reach out on Twitter 🐦