Skip to content

Commit ec9de12

Browse files
committed
feat: Added scripts readme
1 parent 02ea183 commit ec9de12

File tree

1 file changed

+44
-0
lines changed

1 file changed

+44
-0
lines changed

scripts/README.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# Aave Delivery Infrastructure Scripts
2+
3+
In this folder, you can find the base scripts necessary for aDI deployment (used in [adi-deploy](https://github.com/aave-dao/adi-deploy)).
4+
In this folder, there are no direct deployment scripts.
5+
6+
The scripts are divided as:
7+
8+
- [Access Control](./README.md#access-control)
9+
- [Adapters](./README.md#adapters)
10+
- [CCC](./README.md#ccc)
11+
- [Emergency](./README.md#emergency)
12+
13+
Most of the scripts depend on [BaseScript](./BaseScript.sol) and Create2 from [solidity-utils](https://github.com/bgd-labs/solidity-utils).
14+
On `BaseScript` we can find the method to deploy using Create2 and the method to predict the address when using Create2. These two methods form the base to use when deploying all contracts.
15+
16+
## Access Control
17+
18+
- [Deploy_Granular_CCC_Guardian.s.sol](./access_control/Deploy_Granular_CCC_Guardian.sol)
19+
20+
On this script we have the base code to deploy the GranularGuardian. For this it will need the:
21+
- Default admin: should be executor lvl 1
22+
- Retry Guardian: should be BGD Guardian, or guardian that will be able to call the aDI retry methods.
23+
- Solve Emergency Guardian: should be the Aave Governance Guardian, which will be allowed (when signaled by emergency oracle) to solve emergencies on aDI.
24+
25+
## Adapters
26+
27+
- [Adapters](./Adapters)
28+
29+
On this folder we will find one deployment script for every network / adapter pair for native adapters (L2) and the adapters that support multiple networks (ex: CCIP, LZ, etc).
30+
These set default gas limit (amount of gas that needs to be paid for message passing on destination network), and expect the destination network CCC. This is enforced by making all adapter deployment scripts inherit from [BaseAdapterScript](./Adapters/BaseAdapterScript.sol).
31+
32+
Depending on the adapter it will also expect the bridge provider router address (address that will communicate with the adapters (initiates the passing of the message to / from other networks)), and some specific bridge provider addresses / configurations.
33+
34+
## CCC
35+
36+
- [DeployCrossChainController.sol](./CCC/DeployCrossChainController.sol)
37+
38+
This script has the logic to deploy both CCC implementation versions, depending on if the CL_EMERGENCY_ORACLE is set.
39+
40+
## Emergency
41+
42+
- [Deploy_EmergencyRegistry.sol](./emergency/Deploy_EmergencyRegistry.sol)
43+
44+
This is the script to deploy the emergency registry (responsible to trigger emergency oracle updates on specified networks). It expects the owner address, which is the one allowed to set emergencies (Should be executor lvl 1).

0 commit comments

Comments
 (0)