contracts: script for making markdown file with all our contract addr…

…esses (#456) * contracts: adds generate-markdown script for making markdown file with all our contract addresses * Moves generate-markdown to deploy script * Adds Goerli chain Id * Removes etherscan Open column Co-authored-by: Pacien Boisson <[email protected]>
ethereum-optimism · Apr 15, 2021 · 3c92bdb · 3c92bdb
1 parent fae4e29
commit 3c92bdb
Show file tree

Hide file tree

Showing 3 changed files with 240 additions and 2 deletions.
diff --git a/packages/contracts/addresses.md b/packages/contracts/addresses.md
@@ -0,0 +1,148 @@
+# Optimism Regenesis Deployments
+## LAYER 2
+
+### Chain IDs:
+- Mainnet: 10
+- Kovan: 69
+- Goerli: 420
+*The contracts relevant for the majority of developers are `OVM_ETH` and the cross-domain messengers. The L2 addresses don't change.*
+
+### Predeploy contracts:
+|Contract|Address|
+|--|--|
+|OVM_ETH: | `0x4200000000000000000000000000000000000006`
+|OVM_L2CrossDomainMessenger: | `0x4200000000000000000000000000000000000007`
+|OVM_L2ToL1MessagePasser: | `0x4200000000000000000000000000000000000000`
+|OVM_L1MessageSender: | `0x4200000000000000000000000000000000000001`
+|OVM_DeployerWhitelist: | `0x4200000000000000000000000000000000000002`
+|OVM_ECDSAContractAccount: | `0x4200000000000000000000000000000000000003`
+|OVM_ProxySequencerEntrypoint: | `0x4200000000000000000000000000000000000004`
+|OVM_SequencerEntrypoint: | `0x4200000000000000000000000000000000000005`
+|Lib_AddressManager: | `0x4200000000000000000000000000000000000008`
+|ERC1820Registry: | `0x1820a4B7618BdE71Dce8cdc73aAB6C95905faD24`
+
+---
+---
+
+## LAYER 1
+
+## MAINNET-V2
+
+Network : __mainnet (chain id: 1)__
+
+|Contract|Address|
+|--|--|
+|Lib_AddressManager|[0xd3EeD86464Ff13B4BFD81a3bB1e753b7ceBA3A39](https://etherscan.io/address/0xd3EeD86464Ff13B4BFD81a3bB1e753b7ceBA3A39)|
+|OVM_CanonicalTransactionChain|[0x405B4008Da75C48F4E54AA39607378967Ae62338](https://etherscan.io/address/0x405B4008Da75C48F4E54AA39607378967Ae62338)|
+|OVM_ChainStorageContainer:CTC:batches|[0x65E921eE201E4a0881FF84ea462baB744bB2fbf0](https://etherscan.io/address/0x65E921eE201E4a0881FF84ea462baB744bB2fbf0)|
+|OVM_ChainStorageContainer:CTC:queue|[0x03004C447722d207B0355529A6d0dA0696BF6ec6](https://etherscan.io/address/0x03004C447722d207B0355529A6d0dA0696BF6ec6)|
+|OVM_ChainStorageContainer:SCC:batches|[0x6B7Fce2C4FD1934a2d251F8b0930ac82DdDAD804](https://etherscan.io/address/0x6B7Fce2C4FD1934a2d251F8b0930ac82DdDAD804)|
+|OVM_ExecutionManager|[0xEd93C5c21c502bB52b4D77240fA9a5d38472304d](https://etherscan.io/address/0xEd93C5c21c502bB52b4D77240fA9a5d38472304d)|
+|OVM_FraudVerifier|[0xF7C64A47A557D2944798801C08771e15455c56c4](https://etherscan.io/address/0xF7C64A47A557D2944798801C08771e15455c56c4)|
+|OVM_L1CrossDomainMessenger|[0xeec700E5a793e28B068537c7dd95d632B603440A](https://etherscan.io/address/0xeec700E5a793e28B068537c7dd95d632B603440A)|
+|OVM_L1ETHGateway|[0x384bC62a4bb9aE617c8dD0eC351d7780444EFDc0](https://etherscan.io/address/0x384bC62a4bb9aE617c8dD0eC351d7780444EFDc0)|
+|OVM_L1MultiMessageRelayer|[0x22adc8A1152B090721E253Ee88CC12a15bcF9222](https://etherscan.io/address/0x22adc8A1152B090721E253Ee88CC12a15bcF9222)|
+|OVM_SafetyChecker|[0x4667c625b36Df62e393a9483BCfB2F00cA0708D1](https://etherscan.io/address/0x4667c625b36Df62e393a9483BCfB2F00cA0708D1)|
+|OVM_StateCommitmentChain|[0x1D0C46671E0696a4Ba800032D5195d5b0f8c60A3](https://etherscan.io/address/0x1D0C46671E0696a4Ba800032D5195d5b0f8c60A3)|
+|OVM_StateManagerFactory|[0xc43AB03567A18CC75CD4B75ABDBEb6DfC2192fF3](https://etherscan.io/address/0xc43AB03567A18CC75CD4B75ABDBEb6DfC2192fF3)|
+|OVM_StateTransitionerFactory|[0x8FA5bfeeb7786D2a241527E8aE8cA1d7511A0E10](https://etherscan.io/address/0x8FA5bfeeb7786D2a241527E8aE8cA1d7511A0E10)|
+|Proxy__OVM_L1CrossDomainMessenger|[0xD1EC7d40CCd01EB7A305b94cBa8AB6D17f6a9eFE](https://etherscan.io/address/0xD1EC7d40CCd01EB7A305b94cBa8AB6D17f6a9eFE)|
+|Proxy__OVM_L1ETHGateway|[0xF20C38fCdDF0C790319Fd7431d17ea0c2bC9959c](https://etherscan.io/address/0xF20C38fCdDF0C790319Fd7431d17ea0c2bC9959c)|
+|mockOVM_BondManager|[0x99EDa8472E93Aa28E5470eEDEc6e32081E14DaFC](https://etherscan.io/address/0x99EDa8472E93Aa28E5470eEDEc6e32081E14DaFC)|
+---
+## MAINNET-V1
+
+Network : __mainnet (chain id: 1)__
+
+|Contract|Address|
+|--|--|
+|Lib_AddressManager|[0x1De8CFD4C1A486200286073aE91DE6e8099519f1](https://etherscan.io/address/0x1De8CFD4C1A486200286073aE91DE6e8099519f1)|
+|OVM_CanonicalTransactionChain|[0xed2701f7135eab0D7ca02e6Ab634AD6CbE159Ffb](https://etherscan.io/address/0xed2701f7135eab0D7ca02e6Ab634AD6CbE159Ffb)|
+|OVM_ChainStorageContainer:CTC:batches|[0x7Cb043e523F6B5D492E0d2221e45062d3878599c](https://etherscan.io/address/0x7Cb043e523F6B5D492E0d2221e45062d3878599c)|
+|OVM_ChainStorageContainer:CTC:queue|[0x62De49fe8215DFF88b9C1a2ea573E1471fF61f83](https://etherscan.io/address/0x62De49fe8215DFF88b9C1a2ea573E1471fF61f83)|
+|OVM_ChainStorageContainer:SCC:batches|[0x7C3e67e5E885556cEF01866CB7bdB5A254D35698](https://etherscan.io/address/0x7C3e67e5E885556cEF01866CB7bdB5A254D35698)|
+|OVM_L1CrossDomainMessenger|[0xE8F1bD5e5629F4adac6fd63A39F4b4cB76c5E7B2](https://etherscan.io/address/0xE8F1bD5e5629F4adac6fd63A39F4b4cB76c5E7B2)|
+|OVM_StateCommitmentChain|[0x901a629a72A5daF200fc359657f070b34bBfdd18](https://etherscan.io/address/0x901a629a72A5daF200fc359657f070b34bBfdd18)|
+|Proxy__OVM_L1CrossDomainMessenger|[0xfBE93ba0a2Df92A8e8D40cE00acCF9248a6Fc812](https://etherscan.io/address/0xfBE93ba0a2Df92A8e8D40cE00acCF9248a6Fc812)|
+|mockOVM_BondManager|[0x64cfd73BE445F6Aa4ee9F4f7B1d068008a9DAc06](https://etherscan.io/address/0x64cfd73BE445F6Aa4ee9F4f7B1d068008a9DAc06)|
+---
+## KOVAN-V2
+
+Network : __kovan (chain id: 42)__
+
+|Contract|Address|
+|--|--|
+|Lib_AddressManager|[0xFaf27b24ba54C6910C12CFF5C9453C0e8D634e05](https://kovan.etherscan.io/address/0xFaf27b24ba54C6910C12CFF5C9453C0e8D634e05)|
+|OVM_CanonicalTransactionChain|[0xeBD8F6ACF629f27AC7dDDD0603df3359a4f063E3](https://kovan.etherscan.io/address/0xeBD8F6ACF629f27AC7dDDD0603df3359a4f063E3)|
+|OVM_ChainStorageContainer:CTC:batches|[0x18bA855471f10B74851C0e133db597075Dff128d](https://kovan.etherscan.io/address/0x18bA855471f10B74851C0e133db597075Dff128d)|
+|OVM_ChainStorageContainer:CTC:queue|[0xf388A98F640baB14e5Cd343B1c27817811aDd682](https://kovan.etherscan.io/address/0xf388A98F640baB14e5Cd343B1c27817811aDd682)|
+|OVM_ChainStorageContainer:SCC:batches|[0xDC1f37ec1eeBF9fe5087c24f889E15AB228FDD22](https://kovan.etherscan.io/address/0xDC1f37ec1eeBF9fe5087c24f889E15AB228FDD22)|
+|OVM_ExecutionManager|[0x1e9d3f68422b50d3Fc413cb6a79C4144089cf64A](https://kovan.etherscan.io/address/0x1e9d3f68422b50d3Fc413cb6a79C4144089cf64A)|
+|OVM_FraudVerifier|[0x139D12963897129D48C99402Cc481e8C0E8FD0BC](https://kovan.etherscan.io/address/0x139D12963897129D48C99402Cc481e8C0E8FD0BC)|
+|OVM_L1CrossDomainMessenger|[0xDBafb4AB19eafE27aF30Dd9C811a1BF4F64b603b](https://kovan.etherscan.io/address/0xDBafb4AB19eafE27aF30Dd9C811a1BF4F64b603b)|
+|OVM_L1ETHGateway|[0x0E8917aF9eB7812c7819EF4e80D2217679d11324](https://kovan.etherscan.io/address/0x0E8917aF9eB7812c7819EF4e80D2217679d11324)|
+|OVM_L1MultiMessageRelayer|[0xf56d4FAeD6F52c4ce14e44885084dAFc5c440138](https://kovan.etherscan.io/address/0xf56d4FAeD6F52c4ce14e44885084dAFc5c440138)|
+|OVM_SafetyChecker|[0xeb91D9059761aFa197deD7b1FB4228F7ea921d3e](https://kovan.etherscan.io/address/0xeb91D9059761aFa197deD7b1FB4228F7ea921d3e)|
+|OVM_StateCommitmentChain|[0x41f707A213FB83010586860f81A4BF2F0FEbe56D](https://kovan.etherscan.io/address/0x41f707A213FB83010586860f81A4BF2F0FEbe56D)|
+|OVM_StateManagerFactory|[0xda9Da06A7b7D902A746649cA1304665C83a465F8](https://kovan.etherscan.io/address/0xda9Da06A7b7D902A746649cA1304665C83a465F8)|
+|OVM_StateTransitionerFactory|[0xE77250c2663d4E81a0Cd7B321f0BB270694A4851](https://kovan.etherscan.io/address/0xE77250c2663d4E81a0Cd7B321f0BB270694A4851)|
+|Proxy__OVM_L1CrossDomainMessenger|[0x48062eD9b6488EC41c4CfbF2f568D7773819d8C9](https://kovan.etherscan.io/address/0x48062eD9b6488EC41c4CfbF2f568D7773819d8C9)|
+|Proxy__OVM_L1ETHGateway|[0xf3902e50dA095bD2e954AB320E8eafDA6152dFDa](https://kovan.etherscan.io/address/0xf3902e50dA095bD2e954AB320E8eafDA6152dFDa)|
+|mockOVM_BondManager|[0x77e244ec49014cFb9c4572453568eCC3AbB70A2d](https://kovan.etherscan.io/address/0x77e244ec49014cFb9c4572453568eCC3AbB70A2d)|
+---
+## KOVAN-V1
+
+Network : __kovan (chain id: 42)__
+
+|Contract|Address|
+|--|--|
+|Lib_AddressManager|[0x72e6F5244828C10737cbC9659378B207246D26B2](https://kovan.etherscan.io/address/0x72e6F5244828C10737cbC9659378B207246D26B2)|
+|OVM_CanonicalTransactionChain|[0x0ecB7253Aef93dD936E2a9BCEb49bc2fA683Ee65](https://kovan.etherscan.io/address/0x0ecB7253Aef93dD936E2a9BCEb49bc2fA683Ee65)|
+|OVM_ChainStorageContainer:CTC:batches|[0x095744753D5353C1FC43EFb1ab81D06f3e2F4630](https://kovan.etherscan.io/address/0x095744753D5353C1FC43EFb1ab81D06f3e2F4630)|
+|OVM_ChainStorageContainer:CTC:queue|[0xFCE31EC2Bc82553FaA4A9a6DF36c9b0DFDAdD4B8](https://kovan.etherscan.io/address/0xFCE31EC2Bc82553FaA4A9a6DF36c9b0DFDAdD4B8)|
+|OVM_ChainStorageContainer:SCC:batches|[0xcFf7ed66bC3C1eA64c6394FEBb2408D16c6cBC5E](https://kovan.etherscan.io/address/0xcFf7ed66bC3C1eA64c6394FEBb2408D16c6cBC5E)|
+|OVM_L1CrossDomainMessenger|[0x19da6C4945f18F5E720054FECC50D6b5E015bd40](https://kovan.etherscan.io/address/0x19da6C4945f18F5E720054FECC50D6b5E015bd40)|
+|OVM_StateCommitmentChain|[0x2AAbAf6799822Efc77865401E05CE02897ecf520](https://kovan.etherscan.io/address/0x2AAbAf6799822Efc77865401E05CE02897ecf520)|
+|Proxy__OVM_L1CrossDomainMessenger|[0xb89065D5eB05Cac554FDB11fC764C679b4202322](https://kovan.etherscan.io/address/0xb89065D5eB05Cac554FDB11fC764C679b4202322)|
+|mockOVM_BondManager|[0x3Ff73EBc1d916a1A976521160ad92dFDF6a06d1f](https://kovan.etherscan.io/address/0x3Ff73EBc1d916a1A976521160ad92dFDF6a06d1f)|
+---
+## GOERLI-V2
+
+Network : __goerli (chain id: 5)__
+
+|Contract|Address|
+|--|--|
+|Lib_AddressManager|[0x9933d137bBF050Cf3D7555fE1beC91eF698814e5](https://goerli.etherscan.io/address/0x9933d137bBF050Cf3D7555fE1beC91eF698814e5)|
+|OVM_CanonicalTransactionChain|[0x557057458Ba57F03e3191ddA69118DFe42a7295d](https://goerli.etherscan.io/address/0x557057458Ba57F03e3191ddA69118DFe42a7295d)|
+|OVM_ChainStorageContainer:CTC:batches|[0x648D625eCa2A2491547d2D702e21070675518E4a](https://goerli.etherscan.io/address/0x648D625eCa2A2491547d2D702e21070675518E4a)|
+|OVM_ChainStorageContainer:CTC:queue|[0xe7C69bfEC244EC659871E5685fc17D86eaFB8305](https://goerli.etherscan.io/address/0xe7C69bfEC244EC659871E5685fc17D86eaFB8305)|
+|OVM_ChainStorageContainer:SCC:batches|[0x96bD3A792Cc288C51C55A33BC8089026c7009bfd](https://goerli.etherscan.io/address/0x96bD3A792Cc288C51C55A33BC8089026c7009bfd)|
+|OVM_ExecutionManager|[0x3212027673655d3047c13139e3233ccd4A78417c](https://goerli.etherscan.io/address/0x3212027673655d3047c13139e3233ccd4A78417c)|
+|OVM_FraudVerifier|[0x08BB26333Ed18CcF632e2d68DdC9B5aFfb2EE687](https://goerli.etherscan.io/address/0x08BB26333Ed18CcF632e2d68DdC9B5aFfb2EE687)|
+|OVM_L1CrossDomainMessenger|[0x7910D57c49fAE4F7c896A6cd185aB1e6196D8161](https://goerli.etherscan.io/address/0x7910D57c49fAE4F7c896A6cd185aB1e6196D8161)|
+|OVM_L1ETHGateway|[0x2C9573A5c0d94075601dB745255645FE5D2e5f7C](https://goerli.etherscan.io/address/0x2C9573A5c0d94075601dB745255645FE5D2e5f7C)|
+|OVM_L1MultiMessageRelayer|[0x120b44cC54e9b7E79b3583BE6B797D36DF9fD90a](https://goerli.etherscan.io/address/0x120b44cC54e9b7E79b3583BE6B797D36DF9fD90a)|
+|OVM_SafetyChecker|[0x97203a63AC85D811b75575bc5F7Ddc414548B287](https://goerli.etherscan.io/address/0x97203a63AC85D811b75575bc5F7Ddc414548B287)|
+|OVM_StateCommitmentChain|[0xc983d52292DCBBEE53a0730C6A3EEb61c6F19129](https://goerli.etherscan.io/address/0xc983d52292DCBBEE53a0730C6A3EEb61c6F19129)|
+|OVM_StateManagerFactory|[0x625Ee9D6a8486FDc0c70b1793F37d368f4698014](https://goerli.etherscan.io/address/0x625Ee9D6a8486FDc0c70b1793F37d368f4698014)|
+|OVM_StateTransitionerFactory|[0x28f8A0877c2DC85b3Aa269bD772CaCc6e92D7371](https://goerli.etherscan.io/address/0x28f8A0877c2DC85b3Aa269bD772CaCc6e92D7371)|
+|Proxy__OVM_L1CrossDomainMessenger|[0x03F6221792451CAD23dF17fF4D702bF93978a9b3](https://goerli.etherscan.io/address/0x03F6221792451CAD23dF17fF4D702bF93978a9b3)|
+|Proxy__OVM_L1ETHGateway|[0x499223f87451F2dcC638c506ff7549838A3ee00e](https://goerli.etherscan.io/address/0x499223f87451F2dcC638c506ff7549838A3ee00e)|
+|mockOVM_BondManager|[0x1e4f220d5CDD25e2C0E60e0B2f56a7CCC25719C1](https://goerli.etherscan.io/address/0x1e4f220d5CDD25e2C0E60e0B2f56a7CCC25719C1)|
+---
+## GOERLI-V1
+
+Network : __goerli (chain id: 5)__
+
+|Contract|Address|
+|--|--|
+|Lib_AddressManager|[0x5011A092e66B2c89e2d09dfb9E418B4bCFb24C80](https://goerli.etherscan.io/address/0x5011A092e66B2c89e2d09dfb9E418B4bCFb24C80)|
+|OVM_CanonicalTransactionChain|[0x8468e3B58Cc7B34ab07ca5b80CB234e271435120](https://goerli.etherscan.io/address/0x8468e3B58Cc7B34ab07ca5b80CB234e271435120)|
+|OVM_ChainStorageContainer:CTC:batches|[0xe0992cB281cfb66cC53A98B7d32B0305d37F723D](https://goerli.etherscan.io/address/0xe0992cB281cfb66cC53A98B7d32B0305d37F723D)|
+|OVM_ChainStorageContainer:CTC:queue|[0x85f5bDc9C0269D32154fa1CCdbf697B46AF37273](https://goerli.etherscan.io/address/0x85f5bDc9C0269D32154fa1CCdbf697B46AF37273)|
+|OVM_ChainStorageContainer:SCC:batches|[0x2c68C92992c516b7Bdd816cc471938025672fd7a](https://goerli.etherscan.io/address/0x2c68C92992c516b7Bdd816cc471938025672fd7a)|
+|OVM_L1CrossDomainMessenger|[0x1c15fcA66a14eB2de5cDCf0BF1f45580b58ca5AC](https://goerli.etherscan.io/address/0x1c15fcA66a14eB2de5cDCf0BF1f45580b58ca5AC)|
+|OVM_StateCommitmentChain|[0xAE493AD1fFCD654E6e4b78a66be3c9780a6ca89d](https://goerli.etherscan.io/address/0xAE493AD1fFCD654E6e4b78a66be3c9780a6ca89d)|
+|Proxy__OVM_L1CrossDomainMessenger|[0x0f94dA8E27A6116E341c5C807aD32c62EBc90eB6](https://goerli.etherscan.io/address/0x0f94dA8E27A6116E341c5C807aD32c62EBc90eB6)|
+|mockOVM_BondManager|[0x1F5AbC065D4B3F3dc127CA8B0042bD4Fcaf79EFC](https://goerli.etherscan.io/address/0x1F5AbC065D4B3F3dc127CA8B0042bD4Fcaf79EFC)|
+---
diff --git a/packages/contracts/package.json b/packages/contracts/package.json
@@ -31,12 +31,13 @@
     "lint:fix": "yarn run lint:fix:typescript",
     "lint:fix:typescript": "prettier --config prettier-config.json --write \"hardhat.config.ts\" \"{src,test}/**/*.ts\"",
     "clean": "rm -rf ./dist ./artifacts ./artifacts-ovm ./cache ./cache-ovm ./tsconfig.build.tsbuildinfo",
-    "deploy": "./bin/deploy.ts",
+    "deploy": "./bin/deploy.ts && yarn generate-markdown",
     "serve": "./bin/serve_dump.sh",
     "prepublishOnly": "yarn copyfiles -u 2 \"contracts/optimistic-ethereum/**/*\" ./",
     "postpublish": "rimraf OVM iOVM libraries mockOVM",
     "prepack": "yarn prepublishOnly",
-    "postpack": "yarn postpublish"
+    "postpack": "yarn postpublish",
+    "generate-markdown": "node scripts/generate-markdown.js"
   },
   "dependencies": {
     "@eth-optimism/core-utils": "^0.2.1",

diff --git a/packages/contracts/scripts/generate-markdown.js b/packages/contracts/scripts/generate-markdown.js
@@ -0,0 +1,89 @@
+#!/usr/bin/env node
+const dirtree = require("directory-tree");
+const fs = require("fs");
+
+/**
+ *
+ * takes a directory of hardhat artifacts and builds a markdown table that shows the name of the contract in one column and its address in another column with a hyperlink to etherscan
+ *
+ */
+
+const networks = {
+  1: "mainnet",
+  3: "ropsten",
+  4: "rinkeby",
+  5: "goerli",
+  42: "kovan",
+};
+
+(async () => {
+  console.log(`Writing contract addresses`);
+
+  const deployments = dirtree(`./deployments`)
+    .children.filter((child) => {
+      return child.type === "directory";
+    })
+    .map((d) => d.name)
+    .reverse();
+
+  let md = `# Optimism Regenesis Deployments
+## LAYER 2
+
+### Chain IDs:
+- Mainnet: 10
+- Kovan: 69
+- Goerli: 420
+*The contracts relevant for the majority of developers are \`OVM_ETH\` and the cross-domain messengers. The L2 addresses don't change.*
+
+### Predeploy contracts:
+|Contract|Address|
+|--|--|
+|OVM_ETH: | \`0x4200000000000000000000000000000000000006\`
+|OVM_L2CrossDomainMessenger: | \`0x4200000000000000000000000000000000000007\`
+|OVM_L2ToL1MessagePasser: | \`0x4200000000000000000000000000000000000000\`
+|OVM_L1MessageSender: | \`0x4200000000000000000000000000000000000001\`
+|OVM_DeployerWhitelist: | \`0x4200000000000000000000000000000000000002\`
+|OVM_ECDSAContractAccount: | \`0x4200000000000000000000000000000000000003\`
+|OVM_ProxySequencerEntrypoint: | \`0x4200000000000000000000000000000000000004\`
+|OVM_SequencerEntrypoint: | \`0x4200000000000000000000000000000000000005\`
+|Lib_AddressManager: | \`0x4200000000000000000000000000000000000008\`
+|ERC1820Registry: | \`0x1820a4B7618BdE71Dce8cdc73aAB6C95905faD24\`
+
+---
+---
+
+## LAYER 1\n\n`;
+
+  for (let deployment of deployments) {
+    md += `## ${deployment.toUpperCase()}\n\n`;
+
+    const chainId = Number(
+      fs.readFileSync(`./deployments/${deployment}/.chainId`)
+    );
+    const network = networks[chainId];
+
+    md += `Network : __${network} (chain id: ${chainId})__\n\n`;
+
+    md += `|Contract|Address|\n`;
+    md += `|--|--|\n`;
+
+    const contracts = dirtree(`./deployments/${deployment}`)
+      .children.filter((child) => {
+        return child.extension === ".json";
+      })
+      .map((child) => {
+        return child.name.replace(".json", "");
+      });
+
+    for (const contract of contracts) {
+      const deploymentInfo = require(`../deployments/${deployment}/${contract}.json`);
+
+      const escPrefix = chainId !== 1 ? `${network}.` : "";
+      const etherscanUrl = `https://${escPrefix}etherscan.io/address/${deploymentInfo.address}`;
+      md += `|${contract}|[${deploymentInfo.address}](${etherscanUrl})|\n`;
+    }
+    md += `---\n`;
+  }
+
+  fs.writeFileSync(`./addresses.md`, md);
+})().catch(console.error);