Skip to content

Latest commit

 

History

History
91 lines (57 loc) · 3.46 KB

setup.md

File metadata and controls

91 lines (57 loc) · 3.46 KB

a.DI. Setup instructions


General setup

This project uses Foundry and partially Node/npm, so having them installed is a pre-requirement of the setup.

To install run:

npm i // Install package dependencies
forge install // Install dependency libraries

Env Configuration

In order to run tests, a .env needs to be configured.

An .env.example in included in the repository, that can be used as template to fill all the required fields

cp .env.example .env

Tests

The simplest ways of running test is with the following

forge test

Being Foundry based, any other granular way of executing isolated tests applies to this project.


Scripts

The deployment scripts can be found HERE. They inherit from the contract BaseScripts to register and use the deployed addresses between them, and coordinate a full network deployment.

The scripts consist of:

  • Adapters: Folder containing all the bridge adapter contracts deployment scripts
  • CCC: Folder containing the necessary scripts to deploy and configure the CrossChainControllers.
  • Contract extensions: Folder with contracts that have been extended for testnet deployments. These contracts override the parent contract with specific configurations

Makefile

We have created a Makefile with the necessary commands to trigger the different deployment scripts.

To trigger a full deployment this command should be called:

make deploy-full # Deployment for all the configured networks.

with the environment variable flags:

  • PROD: if true, the deployment will happen on mainnet networks. If not it will deploy on test networks
  • LEDGER: if true, the deployment will use a (connected) Ledger. If not, it will use the private key specified in the local environment.

A gas multiplier option has been added to the ethereum network (and testnets) to ensure proper deployment.

To add / remove a network from deployment it must be updated in the command.

The commands use the network names specified to search for the contracts on the deployment scripts (if no name for contracts to execute are specified): $(call deploy_fn,InitialDeployments,ethereum avalanche polygon optimism arbitrum metis) This takes the network name, it capitalizes the name, and searches for the contract on the specified directory (it adds _testnet to the contract names to be able to differenciate between a prod and test deployment).

If the script contract has a different naming (than a network name: Ethereum) it can also be specified in the command like so: $(call deploy_fn,SomeDir/SomeFile,ethereum,ContractToCall)


Addresses

The addresses obtained from triggering the deployment scripts can be found here


Payload Scripts

Included HERE are scripts with governance payload templates that modify key parameters in a.DI. Each individual file can be duplicated and modified to achieve the desired parameter configuration. These are meant to be used as templates for creating new AIPs.

Furthermore, there is a pre-made payload, the SolveEmergencyPayloadPrePopulated. This payload implements the necessary logic to entirely close off a chain in emergency mode via solveEmergency(). Normal functionality could later be restored by triggering another emergency and solving it with the desired parameters.