Add script to generate Supported Networks pages from safe-deployments repo as a github action

.github/scripts/generateSupportedNetworks.js

@@ -0,0 +1,120 @@
+const shell = require('shelljs')
+const fs = require('fs')
+const path = require('path')
+
+const walkPath = dir => {
+  let results = []
+  const list = fs.readdirSync(dir)
+  list.forEach(function (file) {
+    const filePath = path.join(dir, file)
+    const stat = fs.statSync(filePath)
+    if (stat?.isDirectory()) {
+      results = results.concat(walkPath(filePath))
+    } else {
+      results.push(filePath)
+    }
+  })
+
+  return results
+}
+
+const deduplicate = () => [
+  (acc, curr) => {
+    if (acc.includes(curr)) {
+      return acc
+    }
+
+    return [...acc, curr]
+  },
+  []
+]
+
+const generateSupportedNetworks = async () => {
+  const deploymentRepoUrl = 'https://github.com/safe-global/safe-deployments/'
+  shell.exec(`git clone ${deploymentRepoUrl} ./deployments`)
+  shell.rm('-rf', './supported-networks')
+
+  const fetch = await import('node-fetch')
+  const paths = walkPath('deployments/src/assets').map(p =>
+    p.replace('deployments/src/assets/', '')
+  )
+
+  const allNetworks = await fetch
+    .default('https://chainid.network/chains.json')
+    .then(res => res.json())
+
+  const contracts = paths.map(p => {
+    const file = fs.readFileSync(`deployments/src/assets/${p}`, 'utf8')
+    const json = JSON.parse(file)
+
+    return Object.entries(json.networkAddresses).map(([chainId, address]) => ({
+      name: p.split('/')[1].split('.')[0],
+      version: p.split('/')[0],
+      address,
+      chainId,
+      chainName: allNetworks.find(n => n.chainId === parseInt(chainId))?.name,
+      blockExplorerUrl: allNetworks.find(n => n.chainId === parseInt(chainId))
+        ?.explorers?.[0]?.url
+    }))
+  })
+
+  const versions = contracts
+    .flat()
+    .map(c => c.version)
+    .reduce(...deduplicate())
+    .reverse()
+
+  shell.mkdir('./supported-networks')
+
+  versions.forEach(version => {
+    const _contracts = contracts.flat().filter(c => c.version === version)
+
+    const networks = Object.entries(
+      _contracts.reduce((acc, curr) => {
+        const { chainId, chainName } = curr
+        if (acc[chainId]) {
+          return acc
+        }
+
+        return {
+          ...acc,
+          [chainId]: chainName
+        }
+      }, {})
+    )
+
+    const content = `# ${version}
+
+This page references the addresses of all the Safe\\{Core\\} Protocol contracts deployed on all supported networks for ${version}.
+
+## Networks
+${networks
+  .map(([chainId, network]) => {
+    return `
+### ${network}
+
+This network's Chain Id is ${chainId}.
+
+${_contracts
+  .filter(c => c.chainId === chainId)
+  .map(
+    c =>
+      `- \`${c.name}.sol\`: ${
+        c.blockExplorerUrl == null
+          ? c.address
+          : `[${c.address}](${c.blockExplorerUrl}/address/${c.address})`
+      }`
+  )
+  .join('\n')}
+`
+  })
+  .join('\n')}
+
+    `
+    fs.writeFileSync(`./supported-networks/${version}.md`, content)
+  })
+
+  shell.rm('-rf', './deployments')
+}
+
+generateSupportedNetworks()

.github/styles/Vocab/default/accept.txt

@@ -71,3 +71,5 @@ DAO
 composable
 endhint
 endembed
+Rinkeby
+Testnet

.github/workflows/generate-supported-networks.yml

@@ -0,0 +1,31 @@
+name: Weekly update for supported networks
+
+on:
+  schedule:
+  - cron: "0 9 * * 1"
+  workflow_dispatch:
+
+jobs:
+  generate-supported-networks:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Use Node.js 20.x
+        uses: actions/setup-node@v2
+        with:
+          node-version: '20.x'
+          cache: 'yarn'
+          cache-dependency-path: ./yarn.lock
+      - name: Install dependencies
+        run: yarn install --frozen-lockfile
+      - name: Get yarn cache directory path
+        id: yarn-cache-dir-path
+        run: echo "::set-output name=dir::$(yarn config get cacheFolder)"
+      - uses: actions/cache@v3
+        id: yarn-cache
+        with:
+          path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
+          key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-yarn-
+      - name: Generate supported networks
+        run: node ./.github/scripts/generateSupportedNetworks.js

.gitignore

@@ -1 +1,2 @@
 .DS_Store
+node_modules

SUMMARY.md

@@ -44,6 +44,13 @@
 * [API Kit](safe-core-sdk/api-kit/README.md)
   * [Reference](safe-core-sdk/api-kit/reference/README.md)
 
+* [Supported Networks](safe-smart-account/supported-networks.md)
+  * [v.1.4.1](supported-networks/v1.4.1.md)
+  * [v.1.3.0](supported-networks/v1.3.0.md)
+  * [v.1.2.0](supported-networks/v1.2.0.md)
+  * [v.1.1.1](supported-networks/v1.1.1.md)
+  * [v.1.0.0](supported-networks/v1.0.0.md)
+
 ## Safe{Core} Protocol
 
 * [Overview](safe-core-protocol/README.md)

package.json

@@ -0,0 +1,6 @@
+{
+  "dependencies": {
+    "node-fetch": "^3.3.2",
+    "shelljs": "^0.8.5"
+  }
+}

safe-smart-account/supported-networks.md

@@ -0,0 +1,3 @@
+This section lists the addresses of all the Safe\{Core\} Protocol contracts deployed on all supported networks for each version. The same list can be found on our [GitHub repository](https://github.com/safe-global/safe-deployments), from which these pages are automatically generated.
+
+The most recent version of the Safe\{Core\} Protocol is v1.4.1, however the default version to be used is v1.3.0 as it is deployed in many more networks and is the only currently supported in the [Safe Transaction Service](safe-core-api/safe-transaction-service.md).

supported-networks/v1.0.0.md

@@ -0,0 +1,47 @@
+# v1.0.0
+
+This page references the addresses of all the Safe\{Core\} Protocol contracts deployed on all supported networks for v1.0.0.
+
+## Networks
+
+### Ethereum Mainnet
+
+This network's Chain Id is 1.
+
+- `gnosis_safe.sol`: [0xb6029EA3B2c51D09a50B53CA8012FeEB05bDa35A](https://etherscan.io/address/0xb6029EA3B2c51D09a50B53CA8012FeEB05bDa35A)
+- `proxy_factory.sol`: [0x12302fE9c02ff50939BaAaaf415fc226C078613C](https://etherscan.io/address/0x12302fE9c02ff50939BaAaaf415fc226C078613C)
+
+
+### Rinkeby
+
+This network's Chain Id is 4.
+
+- `gnosis_safe.sol`: [0xb6029EA3B2c51D09a50B53CA8012FeEB05bDa35A](https://rinkeby.etherscan.io/address/0xb6029EA3B2c51D09a50B53CA8012FeEB05bDa35A)
+- `proxy_factory.sol`: [0x12302fE9c02ff50939BaAaaf415fc226C078613C](https://rinkeby.etherscan.io/address/0x12302fE9c02ff50939BaAaaf415fc226C078613C)
+
+
+### Goerli
+
+This network's Chain Id is 5.
+
+- `gnosis_safe.sol`: [0xb6029EA3B2c51D09a50B53CA8012FeEB05bDa35A](https://goerli.etherscan.io/address/0xb6029EA3B2c51D09a50B53CA8012FeEB05bDa35A)
+- `proxy_factory.sol`: [0x12302fE9c02ff50939BaAaaf415fc226C078613C](https://goerli.etherscan.io/address/0x12302fE9c02ff50939BaAaaf415fc226C078613C)
+
+
+### LUKSO Mainnet
+
+This network's Chain Id is 42.
+
+- `gnosis_safe.sol`: [0xb6029EA3B2c51D09a50B53CA8012FeEB05bDa35A](https://explorer.execution.mainnet.lukso.network/address/0xb6029EA3B2c51D09a50B53CA8012FeEB05bDa35A)
+- `proxy_factory.sol`: [0x12302fE9c02ff50939BaAaaf415fc226C078613C](https://explorer.execution.mainnet.lukso.network/address/0x12302fE9c02ff50939BaAaaf415fc226C078613C)
+
+
+### Gnosis
+
+This network's Chain Id is 100.
+
+- `gnosis_safe.sol`: [0xb6029EA3B2c51D09a50B53CA8012FeEB05bDa35A](https://gnosisscan.io/address/0xb6029EA3B2c51D09a50B53CA8012FeEB05bDa35A)
+- `proxy_factory.sol`: [0x12302fE9c02ff50939BaAaaf415fc226C078613C](https://gnosisscan.io/address/0x12302fE9c02ff50939BaAaaf415fc226C078613C)
+
+
+

supported-networks/v1.1.1.md

@@ -0,0 +1,103 @@
+# v1.1.1
+
+This page references the addresses of all the Safe\{Core\} Protocol contracts deployed on all supported networks for v1.1.1.
+
+## Networks
+
+### Ethereum Mainnet
+
+This network's Chain Id is 1.
+
+- `create_and_add_modules.sol`: [0xF61A721642B0c0C8b334bA3763BA1326F53798C0](https://etherscan.io/address/0xF61A721642B0c0C8b334bA3763BA1326F53798C0)
+- `create_call.sol`: [0x8538fcbccba7f5303d2c679fa5d7a629a8c9bf4a](https://etherscan.io/address/0x8538fcbccba7f5303d2c679fa5d7a629a8c9bf4a)
+- `default_callback_handler.sol`: [0xd5D82B6aDDc9027B22dCA772Aa68D5d74cdBdF44](https://etherscan.io/address/0xd5D82B6aDDc9027B22dCA772Aa68D5d74cdBdF44)
+- `gnosis_safe.sol`: [0x34CfAC646f301356fAa8B21e94227e3583Fe3F5F](https://etherscan.io/address/0x34CfAC646f301356fAa8B21e94227e3583Fe3F5F)
+- `multi_send.sol`: [0x8D29bE29923b68abfDD21e541b9374737B49cdAD](https://etherscan.io/address/0x8D29bE29923b68abfDD21e541b9374737B49cdAD)
+- `proxy_factory.sol`: [0x76E2cFc1F5Fa8F6a5b3fC4c8F4788F0116861F9B](https://etherscan.io/address/0x76E2cFc1F5Fa8F6a5b3fC4c8F4788F0116861F9B)
+
+
+### Rinkeby
+
+This network's Chain Id is 4.
+
+- `create_and_add_modules.sol`: [0xF61A721642B0c0C8b334bA3763BA1326F53798C0](https://rinkeby.etherscan.io/address/0xF61A721642B0c0C8b334bA3763BA1326F53798C0)
+- `create_call.sol`: [0x8538fcbccba7f5303d2c679fa5d7a629a8c9bf4a](https://rinkeby.etherscan.io/address/0x8538fcbccba7f5303d2c679fa5d7a629a8c9bf4a)
+- `default_callback_handler.sol`: [0xd5D82B6aDDc9027B22dCA772Aa68D5d74cdBdF44](https://rinkeby.etherscan.io/address/0xd5D82B6aDDc9027B22dCA772Aa68D5d74cdBdF44)
+- `gnosis_safe.sol`: [0x34CfAC646f301356fAa8B21e94227e3583Fe3F5F](https://rinkeby.etherscan.io/address/0x34CfAC646f301356fAa8B21e94227e3583Fe3F5F)
+- `multi_send.sol`: [0x8D29bE29923b68abfDD21e541b9374737B49cdAD](https://rinkeby.etherscan.io/address/0x8D29bE29923b68abfDD21e541b9374737B49cdAD)
+- `proxy_factory.sol`: [0x76E2cFc1F5Fa8F6a5b3fC4c8F4788F0116861F9B](https://rinkeby.etherscan.io/address/0x76E2cFc1F5Fa8F6a5b3fC4c8F4788F0116861F9B)
+
+
+### Goerli
+
+This network's Chain Id is 5.
+
+- `create_and_add_modules.sol`: [0xF61A721642B0c0C8b334bA3763BA1326F53798C0](https://goerli.etherscan.io/address/0xF61A721642B0c0C8b334bA3763BA1326F53798C0)
+- `create_call.sol`: [0x8538fcbccba7f5303d2c679fa5d7a629a8c9bf4a](https://goerli.etherscan.io/address/0x8538fcbccba7f5303d2c679fa5d7a629a8c9bf4a)
+- `default_callback_handler.sol`: [0xd5D82B6aDDc9027B22dCA772Aa68D5d74cdBdF44](https://goerli.etherscan.io/address/0xd5D82B6aDDc9027B22dCA772Aa68D5d74cdBdF44)
+- `gnosis_safe.sol`: [0x34CfAC646f301356fAa8B21e94227e3583Fe3F5F](https://goerli.etherscan.io/address/0x34CfAC646f301356fAa8B21e94227e3583Fe3F5F)
+- `multi_send.sol`: [0x8D29bE29923b68abfDD21e541b9374737B49cdAD](https://goerli.etherscan.io/address/0x8D29bE29923b68abfDD21e541b9374737B49cdAD)
+- `proxy_factory.sol`: [0x76E2cFc1F5Fa8F6a5b3fC4c8F4788F0116861F9B](https://goerli.etherscan.io/address/0x76E2cFc1F5Fa8F6a5b3fC4c8F4788F0116861F9B)
+
+
+### LUKSO Mainnet
+
+This network's Chain Id is 42.
+
+- `create_and_add_modules.sol`: [0xF61A721642B0c0C8b334bA3763BA1326F53798C0](https://explorer.execution.mainnet.lukso.network/address/0xF61A721642B0c0C8b334bA3763BA1326F53798C0)
+- `create_call.sol`: [0x8538fcbccba7f5303d2c679fa5d7a629a8c9bf4a](https://explorer.execution.mainnet.lukso.network/address/0x8538fcbccba7f5303d2c679fa5d7a629a8c9bf4a)
+- `default_callback_handler.sol`: [0xd5D82B6aDDc9027B22dCA772Aa68D5d74cdBdF44](https://explorer.execution.mainnet.lukso.network/address/0xd5D82B6aDDc9027B22dCA772Aa68D5d74cdBdF44)
+- `gnosis_safe.sol`: [0x34CfAC646f301356fAa8B21e94227e3583Fe3F5F](https://explorer.execution.mainnet.lukso.network/address/0x34CfAC646f301356fAa8B21e94227e3583Fe3F5F)
+- `multi_send.sol`: [0x8D29bE29923b68abfDD21e541b9374737B49cdAD](https://explorer.execution.mainnet.lukso.network/address/0x8D29bE29923b68abfDD21e541b9374737B49cdAD)
+- `proxy_factory.sol`: [0x76E2cFc1F5Fa8F6a5b3fC4c8F4788F0116861F9B](https://explorer.execution.mainnet.lukso.network/address/0x76E2cFc1F5Fa8F6a5b3fC4c8F4788F0116861F9B)
+
+
+### TomoChain
+
+This network's Chain Id is 88.
+
+- `create_and_add_modules.sol`: 0xF61A721642B0c0C8b334bA3763BA1326F53798C0
+- `create_call.sol`: 0x8538fcbccba7f5303d2c679fa5d7a629a8c9bf4a
+- `default_callback_handler.sol`: 0xd5D82B6aDDc9027B22dCA772Aa68D5d74cdBdF44
+- `gnosis_safe.sol`: 0x34CfAC646f301356fAa8B21e94227e3583Fe3F5F
+- `multi_send.sol`: 0x8D29bE29923b68abfDD21e541b9374737B49cdAD
+- `proxy_factory.sol`: 0x76E2cFc1F5Fa8F6a5b3fC4c8F4788F0116861F9B
+
+
+### Gnosis
+
+This network's Chain Id is 100.
+
+- `create_and_add_modules.sol`: [0xF61A721642B0c0C8b334bA3763BA1326F53798C0](https://gnosisscan.io/address/0xF61A721642B0c0C8b334bA3763BA1326F53798C0)
+- `create_call.sol`: [0x8538fcbccba7f5303d2c679fa5d7a629a8c9bf4a](https://gnosisscan.io/address/0x8538fcbccba7f5303d2c679fa5d7a629a8c9bf4a)
+- `default_callback_handler.sol`: [0xd5D82B6aDDc9027B22dCA772Aa68D5d74cdBdF44](https://gnosisscan.io/address/0xd5D82B6aDDc9027B22dCA772Aa68D5d74cdBdF44)
+- `gnosis_safe.sol`: [0x34CfAC646f301356fAa8B21e94227e3583Fe3F5F](https://gnosisscan.io/address/0x34CfAC646f301356fAa8B21e94227e3583Fe3F5F)
+- `multi_send.sol`: [0x8D29bE29923b68abfDD21e541b9374737B49cdAD](https://gnosisscan.io/address/0x8D29bE29923b68abfDD21e541b9374737B49cdAD)
+- `proxy_factory.sol`: [0x76E2cFc1F5Fa8F6a5b3fC4c8F4788F0116861F9B](https://gnosisscan.io/address/0x76E2cFc1F5Fa8F6a5b3fC4c8F4788F0116861F9B)
+
+
+### Energy Web Chain
+
+This network's Chain Id is 246.
+
+- `create_and_add_modules.sol`: [0xF61A721642B0c0C8b334bA3763BA1326F53798C0](https://explorer.energyweb.org/address/0xF61A721642B0c0C8b334bA3763BA1326F53798C0)
+- `create_call.sol`: [0x8538fcbccba7f5303d2c679fa5d7a629a8c9bf4a](https://explorer.energyweb.org/address/0x8538fcbccba7f5303d2c679fa5d7a629a8c9bf4a)
+- `default_callback_handler.sol`: [0xd5D82B6aDDc9027B22dCA772Aa68D5d74cdBdF44](https://explorer.energyweb.org/address/0xd5D82B6aDDc9027B22dCA772Aa68D5d74cdBdF44)
+- `gnosis_safe.sol`: [0x34CfAC646f301356fAa8B21e94227e3583Fe3F5F](https://explorer.energyweb.org/address/0x34CfAC646f301356fAa8B21e94227e3583Fe3F5F)
+- `multi_send.sol`: [0x8D29bE29923b68abfDD21e541b9374737B49cdAD](https://explorer.energyweb.org/address/0x8D29bE29923b68abfDD21e541b9374737B49cdAD)
+- `proxy_factory.sol`: [0x76E2cFc1F5Fa8F6a5b3fC4c8F4788F0116861F9B](https://explorer.energyweb.org/address/0x76E2cFc1F5Fa8F6a5b3fC4c8F4788F0116861F9B)
+
+
+### Energy Web Volta Testnet
+
+This network's Chain Id is 73799.
+
+- `create_and_add_modules.sol`: 0xF61A721642B0c0C8b334bA3763BA1326F53798C0
+- `create_call.sol`: 0x8538fcbccba7f5303d2c679fa5d7a629a8c9bf4a
+- `default_callback_handler.sol`: 0xd5D82B6aDDc9027B22dCA772Aa68D5d74cdBdF44
+- `gnosis_safe.sol`: 0x34CfAC646f301356fAa8B21e94227e3583Fe3F5F
+- `multi_send.sol`: 0x8D29bE29923b68abfDD21e541b9374737B49cdAD
+- `proxy_factory.sol`: 0x76E2cFc1F5Fa8F6a5b3fC4c8F4788F0116861F9B
+
+
+