Skip to content

dev-local.md

Latest commit

 

History

History
191 lines (142 loc) · 5.49 KB

dev-local.md

File metadata and controls

191 lines (142 loc) · 5.49 KB

Local development

WARNING: this doc is outdated after Lido V2 upgrade

Networks are defined in hardhat.config.js file. To select the target network for deployment, set NETWORK_NAME environment variable to a network name defined in that file. All examples below assume localhost is the target network.

Network state file

Deployment scripts read their config from and store their results to a file called deployed-{network_name}.json, located in the repo root. This file has the following structure and should always be committed:

{
  "networkId": 31337,
  "owner": "0x5626f3Cf58741768f2B5F09beF0bA50489E17f74",
  ...etc
}

When a script sees that some contract address is already defined in the network state file, it won't re-deploy the same contract. This means that all deployment scripts are idempotent, you can call the same script twice and the second call will be a nop.

You may want to specify some of the configuration options in networks.<netId> prior to running deployment to avoid those values being set to default values:

  • owner The address that everything will be deployed from.
  • ensAddress The address of a ENS instance.
  • depositContractAddress The address of the Beacon chain deposit contract (it will deployed otherwise).
  • daoInitialSettings Initial settings of the DAO; see below.

You may specify any number of additional keys inside any network state, they will be left intact by deployment scripts.

DAO initial settings

Initial DAO settings can be specified prior to deployment for the specific network in networks.<netId>.daoInitialSettings field inside deployed.json file.

Aragon voting app source code

An example of deployed.json file prepared for a testnet deployment:

{
  "networks": {
    "5": {
      "networkName": "goerli",
      "depositContractAddress": "0x07b39f4fde4a38bace212b546dac87c58dfe3fdc",
      "owner": "0x3463dD800410965fdBeC2958085b1467CBd4aA31",
      "daoInitialSettings": {
        "holders": [
          "0x9be0D8ef365A7217c2313c3f33a71D5CeBea2686",
          "0x7B1F4c068b3E89Cc586c2f3656Bd95f56CA5B10A",
          "0x6244D856606c874DEAC61a61bd07698d47a6F6F2"
        ],
        "stakes": [
          "100000000000000000000",
          "100000000000000000000",
          "100000000000000000000"
        ],
        "tokenName": "Lido DAO Testnet Token",
        "tokenSymbol": "LDO",
        "voteDuration": 86400,
        "votingSupportRequired": "500000000000000000",
        "votingMinAcceptanceQuorum": "300000000000000000",
        "beaconSpec": {
          "epochsPerFrame": 225,
          "slotsPerEpoch": 32,
          "secondsPerSlot": 12,
          "genesisTime": 1605700807
        }
      }
    }
  }
}

How to build local dev environment

To run dev env we need:

  • install dependencies
  • install and start IPFS daemon
  • start hardhat node
  • deploy contracts to local hardhat node
  • start lido apps on local port
  • start aragon client

Step 1: install yarn dependencies

yarn

Step 2: install IPFS daemon

See ipfs install instructions here

For example install via Homebrew

brew install ipfs --cask

and start in different terminal

ipfs daemon

IPFS is needed to upload an Aragon Apps like (Finance, Voting, etc...) and Lido apps (Lido, LegacyOracle,NOS)

Step 3: start hardhat node in different terminal

npx hardhat node

This command starts a local eth node with 20 unlocked accounts

Step 4: set NETWORK_NAME env

export NETWORK_NAME=localhost

Step 5: deploy Aragon environment and core apps

On this step we can deploy all required contracts and upload all required apps to IPFS with next command

yarn deploy:all

This is required for test/dev networks that don't have Aragon environment deployed.

But you can execute deploy scripts step by step:

# compile contracts at contracts/ folder
yarn compile

# ENS, APMRegistryFactory, DAOFactory, APMRegistry for aragonpm.eth, etc.
NETWORK_NAME=localhost yarn deploy:aragon-env

# Core Aragon apps: voting, vault, etc.
NETWORK_NAME=localhost yarn deploy:aragon-std-apps

# Deploy Lido APM registry and DAO template
NETWORK_NAME=localhost yarn deploy:apm-and-template

# Build and deploy Lido applications: Lido, Lido Oracle, Node Operator Registry apps
NETWORK_NAME=localhost yarn deploy:apps

# Deploy the DAO
#
# This step deploys DepositContract as well, if depositContractAddress is not specified
# in deployed.json
NETWORK_NAME=localhost yarn deploy:dao

Step 7. Start Lido apps

yarn lido:apps

Step 8. Start Aragon client

NETWORK_NAME=localhost yarn aragon:start

In this step we are replacing the links to the app from the IPFS with a local port, set env ARAGON_APP_LOCATOR=0x8a7b...c6:http://localhost:3010 and start aragon client on http://localhost:3000