Skip to content

Commit

Permalink
docs: update based on feedback
Browse files Browse the repository at this point in the history
  • Loading branch information
nick-bisonai committed May 16, 2024
1 parent 3c347a2 commit aac2f48
Showing 1 changed file with 35 additions and 38 deletions.
73 changes: 35 additions & 38 deletions contracts/v0.2/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,17 @@

Install Foundry by following name at https://book.getfoundry.sh/getting-started/installation or by executing the command below.

````shell
```shell
curl -L https://foundry.paradigm.xyz | bash
```

Running `foundryup` by itself will install the latest (nightly) precompiled binaries: `forge`, `cast`, `anvil`, and `chisel`

Running `foundryup` by itself will install the latest (nightly) precompiled binaries: `forge`, `cast`, `anvil`, and `chisel`

## Build

```shell
forge build
````
```

## Test

Expand Down Expand Up @@ -58,7 +58,6 @@ Following command will generate migration file for whole deployment in `./migrat
node ./script/generate-migration-from-config.cjs --chain test
```


## Migration Examples

### `./migration/{CHAIN(local/baobab/cypress)}/Feed/{migrationFile}.json`
Expand Down Expand Up @@ -94,12 +93,12 @@ node ./script/generate-migration-from-config.cjs --chain test
{
"proposeFeeds": [
{
"feedProxyAddress":"0x3aa5ebb10dc797cac828524e59a333d0a371443c",
"feedProxyAddress": "0x3aa5ebb10dc797cac828524e59a333d0a371443c",
"feedAddress": "0x68b1d87f95878fe05b998f19b66f4baba5de1aed"
},
{
"feedProxyAddress":"0x59b670e9fa9d0a427751af201d676719a970857b",
"feedAddress":"0xc6e7df5e7b4f2a278906862b61205850344d4e7d"
"feedProxyAddress": "0x59b670e9fa9d0a427751af201d676719a970857b",
"feedAddress": "0xc6e7df5e7b4f2a278906862b61205850344d4e7d"
}
]
}
Expand All @@ -111,20 +110,19 @@ node ./script/generate-migration-from-config.cjs --chain test
{
"confirmFeeds": [
{
"feedProxyAddress":"0x3aa5ebb10dc797cac828524e59a333d0a371443c",
"feedProxyAddress": "0x3aa5ebb10dc797cac828524e59a333d0a371443c",
"feedAddress": "0x68b1d87f95878fe05b998f19b66f4baba5de1aed"
},
{
"feedProxyAddress":"0x59b670e9fa9d0a427751af201d676719a970857b",
"feedAddress":"0xc6e7df5e7b4f2a278906862b61205850344d4e7d"
"feedProxyAddress": "0x59b670e9fa9d0a427751af201d676719a970857b",
"feedAddress": "0xc6e7df5e7b4f2a278906862b61205850344d4e7d"
}
]
}
```

### `./migration/{CHAIN(local/baobab/cypress)}/FeedRouter/{migrationFile}.json`


- Deploy `FeedRouter`

```json
Expand All @@ -139,15 +137,15 @@ node ./script/generate-migration-from-config.cjs --chain test
{
"address": "0x1ac6cd893eddb6cac15e5a9fc549335b8b449015",
"updateProxyBulk": [
{
"feedName": "BTC-USDT",
"proxyAddress": "0x50c23983ea26f30d368da5b257001ee3ddf9a539"
},
{
"feedName": "KLAY-USDT",
"proxyAddress": "0xd07bd0bcd3a8fa1087430b1be457e05c4a412a4b"
}
]
{
"feedName": "BTC-USDT",
"proxyAddress": "0x50c23983ea26f30d368da5b257001ee3ddf9a539"
},
{
"feedName": "KLAY-USDT",
"proxyAddress": "0xd07bd0bcd3a8fa1087430b1be457e05c4a412a4b"
}
]
}
```

Expand All @@ -173,29 +171,28 @@ node ./script/generate-migration-from-config.cjs --chain test
"setDataFreshness": 2,
"setExpirationPeriod": 2592000,
"setDefaultProofThreshold": 80,
"setProofThreshold": [
{
"name": "BTC-USDT",
"threshold": 60
}
],
"setProofThreshold": [
{
"name": "BTC-USDT",
"threshold": 60
}
],
"addOracle": {
"oracles": ["0x50c23983ea26f30d368da5b257001ee3ddf9a539"]
},
"removeOracle": {
"oracles": ["0xd07bd0bcd3a8fa1087430b1be457e05c4a412a4b"]
},
"updateFeed": [
{
"name": "BTC-USDT",
"feedAddress": "0xB7f8BC63BbcaD18155201308C8f3540b07f84F5e"
},
{
"name": "ETH-USDT",
"feedAddress": "0x0DCd1Bf9A1b36cE34237eEaFef220932846BCD82"
}
]
,
"updateFeed": [
{
"name": "BTC-USDT",
"feedAddress": "0xB7f8BC63BbcaD18155201308C8f3540b07f84F5e"
},
{
"name": "ETH-USDT",
"feedAddress": "0x0DCd1Bf9A1b36cE34237eEaFef220932846BCD82"
}
],
"removeFeed": {
"feedNames": ["BNB-USDT", "PEPE-USDT"]
}
Expand Down

0 comments on commit aac2f48

Please sign in to comment.