Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/makerdao/dss-deploy-scripts

Last synced: 2 months ago
JSON representation

Host: GitHub
URL: https://github.com/makerdao/dss-deploy-scripts
Owner: makerdao
License: agpl-3.0
Created: 2019-01-09T14:12:39.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2023-05-11T23:48:55.000Z (about 1 year ago)
Last Synced: 2024-01-21T07:36:56.437Z (5 months ago)
Language: Shell
Size: 679 KB
Stars: 48
Watchers: 27
Forks: 64
Open Issues: 7
Metadata Files:
- Readme: README.md
- License: LICENSE

Lists

awesome-smart-contract-development - DSS Deploy Scripts
awesome-dapptools - DSS Deploy Scripts

README

# DSS deployment scripts

![Build Status](https://github.com/makerdao/dss-deploy-scripts/actions/workflows/.github/workflows/tests.yaml/badge.svg?branch=master)

A set of scripts that deploy [dss](http://github.com/makerdao/dss) to an
Ethereum chain of your choosing.

## Description

This repo is composed of two steps:

* Bash [scripts](/scripts) to modify the state of the base system

At the end of the first step, the addresses of deployed contracts are written to
an `out/addresses.json` file. The scripts read those addresses and use `seth`
and `dapp` to modify the deployment, using the values in `out/config.json`.

## Installing

The only way to install everything necessary to deploy is Nix. Run

```shell
nix-shell --pure
```

to drop into a Bash shell with all dependency installed.

### Ethereum node

You'll also need an Ethereum RPC node to connect to. Depending on your usecase, this
could be a local node (e.g. `dapp testnet`) or a remote one.

## Configuration

There are 2 main pieces of configuration necessary for a deployment:

* Ethereum account configuration
* Chain configuration

#### Account configuration

`seth` relies on the presence of environment variables to know which Ethereum account to
use, which RPC server to talk to, etc.

If you're using `nix-shell`, these variables are set automatically for you in
[shell.nix](./shell.nix).

But you can also configure the below variables manually:

- `ETH_FROM`: address of deployment account
- `ETH_PASSWORD`: path of account password file
- `ETH_KEYSTORE`: keystore path
- `ETH_RPC_URL`: URL of the RPC node

### Chain configuration

Some networks have a default config file at `config/.json`, which will be used if non custom config values are set.
A config file can be passed via param with flag `-f` allowing to execute the script in any network (e.g. `dss-deploy testchain -f `).
As other option, custom config values can be loaded as an environment variable called `DDS_CONFIG_VALUES`.
File passed by parameter overwrites the environment variable.

Below is the expected structure of such a config file:

```json
{
"description": "",
"omniaFromAddr": "

",
"omniaAmount": "",
"pauseDelay": "",
"vat_line": "",
"vow_wait": "",
"vow_sump": "",
"vow_dump": "",
"vow_bump": "",
"vow_hump": "",
"cat_box": "",
"dog_hole": "",
"jug_base": "",
"pot_dsr": "",
"cure_wait": "",
"end_wait": "",
"esm_pit": "",
"esm_min": "",
"flap_beg": "",
"flap_ttl": "",
"flap_tau": "",
"flop_beg": "",
"flop_pad": "",
"flop_ttl": "",
"flop_tau": "",
"flap_lid": "",
"flash_max": "",
"import": {
"gov": " note: make sure to mint enough tokens for launch",
"authority": " note: make sure to launch MCD_ADMIN",
"proxyRegistry": "",
"faucet": ""
},
"tokens": {
"": {
"import": {
"gem": "",
"pip": ""
},
"gemDeploy": { // Only used if there is not a gem imported
"src": "",
"params": [],
"faucetSupply": "",
"faucetAmount": ""
},
"joinDeploy": { // Mandatory always
"src": "",
"extraParams": []
},
"pipDeploy": { // Only used if there is not a pip imported
"osmDelay": "",
"type": "",
"price": "",
"signers": [

]
},
"ilks": {
"A": {
"mat": "",
"line": " 0)>",
"autoLine": "",
"autoLineGap": "",
"autoLineTtl": "",
"dust": ""
"duty": "",
"flipDeploy": {
"chop": "",
"dunk": "",
"beg": "",
"ttl": "",
"tau": ""
},
"clipDeploy": { // Will be used only if there isn't a flipDeploy
"chop": "",
"hole": "",
"chip": "",
"tip": "",
"buf": "",
"tail": "",
"cusp": "",
"calc": {
"type": "LinearDecrease/StairstepExponentialDecrease/ExponentialDecrease",
"tau": "",
"step": "",
"cut": ""
},
"cm_tolerance": ""
}
}
}
}
}
}
```
NOTE: Make sure to mint enough (threshold is 80,000 MKR) tokens for launch if you are providing it in `config.gov`:
```
sethSend "$MCD_GOV" 'mint(address,uint256)' "$ETH_FROM" "$(seth --to-uint256 "$(seth --to-wei 1000000 ETH)")"
```
NOTE: Make sure to `launch` MCD_ADMIN if you are providing it in `config.authority`.
```
# lock enough MKR (80,000 MKR threshold)
sethSend "$MCD_GOV" "approve(address,uint256)" "$MCD_ADM" "$(seth --to-uint256 "$(seth --to-wei 80000 ETH)")"
sethSend "$MCD_ADM" "lock(uint256)" "$(seth --to-uint256 "$(seth --to-wei 80000 ETH)")"
sethSend "$MCD_ADM" "vote(address[])" "[0x0000000000000000000000000000000000000000]"
sethSend "$MCD_ADM" "launch()"
```

## Default config files

Currently, there are default config files for 3 networks:

- a local testchain (e.g. `dapp testnet`)
- Goerli
- Mainnet

### Deploy on local testchain with default config file

`dss-deploy testchain`

It is possible to pass a value to define a testing scenario via `-c` flag (e.g. `dss-deploy testchain -c crash-bite`)

The only case currently available is:

- `crash-bite`

### Deploy on Goerli with default config file

`dss-deploy goerli`

### Deploy on Mainnet with default config file

`dss-deploy main`

### Deploy on any network passing a custom config file

`dss-deploy -f `

### Output

Successful deployments save their output to the following files:

- `out/addresses.json`: addresses of all deployed contracts
- `out/config.json`: copy of the configuration file used for the deployment
- `out/abi/`: JSON representation of the ABIs of all deployed contracts
- `out/bin/`: .bin and .bin-runtime files of all deployed contracts
- `out/meta/`: meta.json files of all deployed contracts
- `out/dss-.log`: output log of deployment

### Helper scripts

The `auth-checker` script loads the addresses from `out/addresses.json` and the config file from `out/config.json` and verifies that the deployed authorizations match what is expected.

## Nix

To enable full reproducibility of our deployments, we use Nix.

This command will drop you in a shell with all dependencies and environment
variables definend:

```shell
nix-shell --pure
```

You can even run deploy scripts without having to clone this repo:

```shell
nix run -f https://github.com/makerdao/dss-deploy-scripts/tarball/master -c dss-deploy testchain
```

Dependencies are managed through a central repository referenced in
[`nix/pkgs.nix`](nix/pkgs.nix) and the main Nix expression to build this
repo is in [`default.nix`](default.nix).

## Smart Contract Dependencies

To update smart contract dependencies use `dapp2nix`:

```shell
nix-shell --pure
dapp2nix help
dapp2nix list
dapp2nix up vote-proxy
```

To clone smart contract dependencies into working directory run:

```shell
dapp2nix clone-recursive contracts
```

## Additional Documentation

- `dss-deploy` [source code](https://github.com/makerdao/dss-deploy)
- `dss` is documented in the [wiki](https://github.com/makerdao/dss/wiki) and in [DEVELOPING.md](https://github.com/makerdao/dss/blob/master/DEVELOPING.md)

## TODO

- More cases to test scenarios for testchain script