Add glossary page

.gitbook.yaml

@@ -9,3 +9,9 @@ redirects:
   safe-core-protocol/security/security-audits: safe-smart-account/security/security-audits.md
   safe-core-protocol/signatures: safe-smart-account/signatures/README.md
   safe-core-protocol/signatures/eip-1271: safe-smart-account/signatures/eip-1271.md
+  safe-smart-account/security/security-audits: safe-smart-account/security-audits.md
+  safe-smart-account/security/bug-bounty-program: miscellaneous/bug-bounty-program.md
+  safe-smart-account/security/past-paid-bounties: miscellaneous/past-paid-bounties.md
+  safe-apps-sdk/safe-apps: safe-apps/README.md
+  safe-apps-sdk/overview: safe-apps/README.md
+  safe-apps-sdk/example-safe-app: safe-apps/get-started.md

.github/scripts/generateSupportedNetworks.js

@@ -0,0 +1,146 @@
+// This script generates the supported networks page from the safe-deployments repo.
+// It clones the repo, reads the JSON files, and generates the markdown files as well as a _meta.json file for nextra.
+
+const shell = require('shelljs')
+const fs = require('fs')
+const path = require('path')
+
+// Explore a given directory recursively and return all the file paths
+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
+}
+
+// Reduce function to deduplicate an array
+const deduplicate = (acc, curr) => {
+  if (acc.includes(curr)) {
+    return acc
+  }
+
+  return [...acc, curr]
+}
+
+const supportedNetworksPath = './safe-smart-account/supported-networks'
+
+const generateSupportedNetworks = async () => {
+  const deploymentRepoUrl = 'https://github.com/safe-global/safe-deployments/'
+  shell.exec(`git clone ${deploymentRepoUrl} ./deployments`)
+  shell.rm('-rf', supportedNetworksPath)
+
+  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(supportedNetworksPath)
+
+  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 lists the addresses of all the Safe contracts \`${version}\` grouped by chain.
+
+## 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 ||
+        deprecatedBlockExplorers.includes(c.blockExplorerUrl)
+          ? c.address
+          : `[${c.address}](${c.blockExplorerUrl}/address/${c.address})`
+      }`
+  )
+  .join('\n')}
+`
+  })
+  .join('\n')}
+
+    `
+    fs.writeFileSync(`${supportedNetworksPath}/${version}.md`, content)
+  })
+
+  shell.rm('-rf', './deployments')
+}
+
+generateSupportedNetworks()
+
+const deprecatedBlockExplorers = [
+  'https://ropsten.etherscan.io',
+  'https://rinkeby.etherscan.io',
+  'https://kovan-optimistic.etherscan.io',
+  'https://stardust-explorer.metis.io',
+  'https://blockexplorer.rinkeby.boba.network',
+  'https://blockexplorer.bobabeam.boba.network',
+  'https://blockexplorer.avax.boba.network',
+  'https://rabbit.analogscan.com',
+  'https://explorer.eurus.network',
+  'https://testnetexplorer.eurus.network',
+  'https://explorer.tst.publicmint.io',
+  'https://evm-testnet.venidiumexplorer.com',
+  'https://evm.venidiumexplorer.com',
+  'https://evm.explorer.canto.io',
+  'https://explorer.autobahn.network',
+  'https://explorer.cascadia.foundation',
+  'https://testnet.torusscan.com',
+  'https://testnet.toruscan.com'
+]

.github/styles/config/vocabularies/default/accept.txt

@@ -0,0 +1,206 @@
+(?i)cra
+(?i)eth
+(?i)http
+(?i)https
+(?i)sdk
+(?i)zkevm
+(?i)zksync
+(?i)wagmi
+[Aa]urora
+[Aa]rbitrum
+[Bb]ackend
+[Bb]inance
+[Bb]lockchain
+[Bb]lockchains
+[Cc]elo
+[Cc]omposable
+[Cc]onfig
+[Cc]rypto
+[Cc]ryptocurrencies
+[Dd]app
+[Dd]apps
+[Dd]elist
+[Ee]ndhint
+[Ee]rigon
+[Gg]asless
+[Gg]oerli
+[Gg]nosis
+[Ll]ogics
+[Mm]ainnet
+[Mm]iddleware
+[Mm]ultisig
+[Nn]extra
+[Oo]ffchain
+[Oo]nboarding
+[Oo]nchain
+[Pp]olygon
+[Pp]luggable
+[Rr]eact
+[Rr]eauthenticate
+[Rr]elayer
+[Rr]elayers
+[Ss]epolia
+[Tt]estnet
+[Vv]alidator
+A1
+AA
+ABI
+ABIs
+API
+API Kit
+Acala
+Alfajores
+Andromeda
+Apothem
+Arianee
+Astar
+Auth Kit
+Autobahn
+Avax
+BNB
+Blocknative
+Blockscout
+Boba
+Bobabeam
+Bundlers
+C-Chain
+C1
+CORS
+Canto
+Callout
+Cascadia
+Chainlist
+Chiado
+Client Gateway
+CloudWalk
+Crab
+Cronos
+Crossbell
+DAO
+Darwinia
+Devnet
+EIP
+EOA
+EOAs
+ERC
+EURe
+EVM
+EdgeEVM
+Edgeware
+EtherLite
+Ethereum
+Etherscan
+Eurus
+Evmos
+Fantom
+Foesenek
+Fuji
+Fuse
+GC
+Gelato
+Godwoken
+Gunicorn
+Haqq
+Holesky
+IPFS
+Infura
+IoTeX
+KCC
+Kanazawa
+Karura
+Kava
+Klaytn
+Kovan
+LUKSO
+Lightlink
+Linea
+Mandala
+Mantle
+Meld
+Metadium
+Metamask
+Metis
+Milkomeda
+Monerium
+Moonbase
+Moonbeam
+Moonriver
+Mordor
+Nova
+OAuth
+OP
+Onramp
+Onramp Kit
+PGN
+Pimlico
+Polis
+Protocol Kit
+PublicMint
+README
+REI
+RPC
+Relay Kit
+Renan
+Rethereum
+Rinkeby
+Rollux
+Rootstock
+Ropsten
+Safe App
+Safe Apps
+Safe Apps SDK
+Safe Client Gateway
+Safe Config Service
+Safe Guards
+Safe Module
+Safe Modules
+Safe Smart Account
+Safe Transaction Service
+Safe{Core} Account Abstraction SDK
+Safe{Core} Protocol
+Safe{DAO}
+Shiden
+ShimmerEVM
+Shyft
+Solaris
+Sourcify
+Souza
+Sparknet
+Stardust
+Supernet
+Syscoin
+TC9
+Tanenbaum
+Telos
+Tenet
+ThunderCore
+Transaction Service
+U2U
+UI Kit
+Ultron
+Velas
+Venidium
+Vite
+Vue
+WEMIX3.0
+WSGI
+WebSocket
+XDC
+YouTube
+ZetaChain
+Zoltu
+Zora
+address_full_match
+auth_code
+boolean
+checksummed
+monorepo
+npm
+onboarding
+onchain
+pluggable
+trace_block
+trace_filter
+trace_transaction
+undefined
+v1

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

@@ -0,0 +1,25 @@
+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'
+      - uses: pnpm/action-setup@v2
+        with:
+          version: 8
+      - name: Install dependencies
+        run: pnpm install
+      - name: Generate supported networks
+        run: pnpm generate-supported-networks
+      - uses: actions/checkout@v4
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v5