feat: Add smart accounts reference generation script and docs pages

.github/scripts/generateModulesReference.ts

@@ -0,0 +1,93 @@
+import shell from 'shelljs'
+
+import { modulesVersions } from '../../lib/solidity/constants.ts'
+import {
+  generateMarkdownFromNatspec,
+  setupSolarity
+} from '../../lib/solidity/solarity.ts'
+import {
+  generateOverviewPageModule,
+  runSolidityGenerationScript
+} from '../../lib/solidity/templates.ts'
+import {
+  generateMetaJson,
+  generateMetaJsonVersionsModule
+} from '../../lib/solidity/metaJsons.ts'
+
+const repoUrl = 'https://github.com/safe-global/safe-modules/'
+const repoDestination = '.temp/safe-modules'
+const mdDestination = 'pages/reference-modules'
+const versions = Object.entries(modulesVersions).reduce(
+  (acc, [moduleName, versions]) => {
+    versions.forEach(version => {
+      acc.push(moduleName + '/' + version)
+    })
+    return acc
+  },
+  [] as string[]
+)
+
+// Clones the safe-modules GitHub repository and generates documentation for each public function and event
+const generateModulesReference = (
+  version: string,
+  callback: () => void,
+  repoDestination: string,
+  mdDestination: string
+) => {
+  // Prepare files
+  const moduleName = version.split('/')[0]
+  const _version = version.split('/')[1]
+  const _repoDestination = `${repoDestination}/modules/${moduleName === 'allowance' ? 'allowances' : moduleName}`
+  const _mdDestination = `${mdDestination}/${moduleName}/${_version}`
+  const _repoUrl = `${repoUrl}tree/${version}/`
+  shell.exec(
+    `cd ${repoDestination} && git checkout tags/${version} && npx pnpm@9 i`,
+    { async: true },
+    async () => {
+      // Prepare repo & generate .md doc files using @solarity:
+      setupSolarity({
+        repoDestination: _repoDestination,
+        moduleName,
+        callback: () => {
+          shell.exec(
+            `cd ${_repoDestination} && npx pnpm@9 exec hardhat markup && mkdir -p ${_mdDestination}`,
+            { async: true },
+            () => {
+              // Generate final .mdx files
+              generateMarkdownFromNatspec({
+                repoDestination: _repoDestination,
+                mdDestination: _mdDestination,
+                repoUrl,
+                version,
+                callback: () => {
+                  generateOverviewPageModule(version, _mdDestination, _repoUrl)
+                  generateMetaJsonVersionsModule(moduleName, _mdDestination)
+                  generateMetaJson(
+                    `${mdDestination}/${moduleName}`,
+                    [_version],
+                    () => {
+                      // Remove all changes to the git index so we can git checkout different branches again
+                      shell.exec(
+                        `rm -rf ${_repoDestination}/build && rm -rf ${_repoDestination}/node_modules && rm -rf ${_repoDestination}/generated-markups && cd ${repoDestination} && rm -f pnpm-lock.yaml && git stash && git stash drop`,
+                        { async: true },
+                        callback
+                      )
+                    }
+                  )
+                }
+              })
+            }
+          )
+        }
+      })
+    }
+  )
+}
+
+void runSolidityGenerationScript(
+  mdDestination,
+  repoDestination,
+  repoUrl,
+  versions,
+  generateModulesReference
+)

.github/scripts/generateSmartAccountReference.ts

@@ -0,0 +1,71 @@
+import shell from 'shelljs'
+
+import { smartAccountVersions } from '../../lib/solidity/constants.ts'
+import {
+  setupSolarity,
+  generateMarkdownFromNatspec
+} from '../../lib/solidity/solarity.ts'
+import {
+  generateOverviewPage,
+  runSolidityGenerationScript
+} from '../../lib/solidity/templates.ts'
+import { generateMetaJsonVersions } from '../../lib/solidity/metaJsons.ts'
+
+const repoUrl = 'https://github.com/safe-global/safe-smart-account/'
+const repoDestination = '.temp/contracts'
+const mdDestination = 'pages/reference-smart-account'
+
+const generateSmartAccountReference = (
+  version: string,
+  callback: () => void,
+  repoDestination: string,
+  mdDestination: string
+) => {
+  shell.exec(
+    `cd ${repoDestination} && git checkout tags/${version}`,
+    { async: true },
+    () => {
+      // Prepare repo & generate .md doc files using @solarity:
+      setupSolarity({
+        repoDestination,
+        callback: () => {
+          shell.exec(
+            `cd ${repoDestination} && npx hardhat markup && mkdir -p ${mdDestination}`,
+            {
+              async: true
+            },
+            () => {
+              // Generate final .mdx files
+              generateMarkdownFromNatspec({
+                repoDestination,
+                mdDestination: `${mdDestination}/${version}`,
+                repoUrl,
+                version,
+                callback: () => {
+                  generateOverviewPage(version, `${mdDestination}/${version}`)
+                  generateMetaJsonVersions(
+                    version,
+                    `${mdDestination}/${version}`
+                  )
+                  shell.exec(
+                    `rm -rf ${repoDestination}/build && rm -rf ${repoDestination}/node_modules && rm -rf ${repoDestination}/generated-markups && cd ${repoDestination} && git stash && git stash drop`,
+                    { async: true },
+                    callback
+                  )
+                }
+              })
+            }
+          )
+        }
+      })
+    }
+  )
+}
+
+void runSolidityGenerationScript(
+  mdDestination,
+  repoDestination,
+  repoUrl,
+  smartAccountVersions,
+  generateSmartAccountReference
+)

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

@@ -6,7 +6,11 @@
 (?i)zkevm
 (?i)zksync
 (?i)wagmi
-[Aa][Pp][Ii]
+ABI|abi
+API|api
+DelegateCall|delegatecall
+DelegateCalls|delegatecalls
+LLM|llm
 [Aa]urora
 [Aa]rbitrum
 [Aa]ccessor
@@ -19,6 +23,7 @@
 [Bb]oolean
 [Bb]undler
 [Bb]undlers
+[Cc]alldata
 [Cc]hainlist
 [Cc]elo
 [Cc]omposable
@@ -44,9 +49,7 @@
 [Ll]inea
 [Ll]inea
 [Ll]ogics
-[Ll][Ll][Mm]
 [Mm]ainnet
-[Mm]astercopy
 [Mm]iddleware
 [Mm]onerium
 [Mm]ultichain
@@ -67,6 +70,7 @@
 [Qq]uickstarts
 [Rr]eact
 [Rr]eauthenticate
+[Rr]eentrancy
 [Rr]elayer
 [Rr]elayers
 [Ss]epolia
@@ -79,9 +83,9 @@
 [Xx]code 
 A1
 AA
-ABI
 ABIs
 API Kit
+APIs
 Acala
 Alfajores
 Andromeda
@@ -141,6 +145,7 @@ Etherscan
 Eurus
 Evmos
 Fantom
+Fas
 Fireblocks
 Foesenek
 Fraxtal
@@ -171,9 +176,12 @@ keystore
 LUKSO
 Lightlink
 Lisk
+LLMs
 Mandala
 Mantle
 Masa
+MasterCopy
+MasterCopies
 Meld
 Metadium
 Metamask
@@ -226,6 +234,7 @@ Safe Transaction Service
 Safenet
 Safe{Core} Account Abstraction SDK
 Safe{DAO}
+SDKs
 Sei
 SEPA
 Shibarium
@@ -277,18 +286,26 @@ Zilliqa
 Zircuit
 Zoltu
 Zora
+_data
+_dataHash
+_execute
+authorizer
+approvalCount
 address_full_match
 auditable
+automations
 auth_code
+bool
 bytestrings
-calldata
 checksummed
 createTransaction
 const
 deployer
+e.g.
 eth_getLogs
 eSpace
 execTransaction
+initializer
 ledgerblue
 ledgereth
 maxWidth
@@ -308,10 +325,13 @@ preimage
 refetch
 refetches
 refetching
+returndata
 rollups
 saltNonce
+sigAuthorizer
 stablecoin
 superset
+targetContract
 textWrap
 timelock
 timelocks
@@ -322,6 +342,8 @@ undefined
 undeployed
 unencrypted
 v1
+validUntil
+validAfter
 viem
 zkLink
 zKyoto

.github/workflows/deploy-release.yml

@@ -38,7 +38,6 @@ jobs:
           NEXT_PUBLIC_HOST_URL: 'https://docs.safe.global'
           NODE_OPTIONS: '--max-old-space-size=8000'
 
-
       - name: Configure AWS credentials
         uses: aws-actions/configure-aws-credentials@v3
         with:

components/ApiReference/ApiReference.tsx

@@ -13,7 +13,7 @@ import ArrowBackIcon from '@mui/icons-material/ArrowBack'
 import ExpandLess from '@mui/icons-material/ExpandLess'
 
 import TOC, { type Heading } from './TOC'
-import { MDXComponents, useCurrentTocIndex } from '../../lib/mdx'
+import { MDXComponents, useCurrentTocIndex } from '../Mdx'
 import { NetworkProvider } from './Network'
 import css from './styles.module.css'
 

components/ApiReference/Parameter.tsx

@@ -1,5 +1,5 @@
 import Property from './Property'
-import { MdxHeading } from '../../lib/mdx'
+import { MdxHeading } from '../Mdx'
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 const Parameters: React.FC<{ parameters: any[] }> = ({ parameters }) => {

components/ApiReference/Response.tsx

@@ -8,7 +8,7 @@ import ExpandMore from '@mui/icons-material/ExpandMore'
 
 import Property from './Property'
 import Hr from '../Hr'
-import { MdxHeading } from '../../lib/mdx'
+import { MdxHeading } from '../Mdx'
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 const Response: React.FC<{ response: any; index: number }> = ({

components/ApiReference/SampleRequestHeader.tsx

@@ -2,7 +2,7 @@ import Button from '@mui/material/Button'
 import Grid from '@mui/material/Grid'
 import { useContext } from 'react'
 import { NetworkContext } from './Network'
-import { MdxHeading } from '../../lib/mdx'
+import { MdxHeading } from '../Mdx'
 
 const SampleRequestHeader: React.FC<{
   method: string

components/ApiReference/TOC.tsx

@@ -6,7 +6,7 @@ import Grid from '@mui/material/Grid'
 import Link from '@mui/material/Link'
 import { useState } from 'react'
 
-import { useCurrentTocIndex } from '../../lib/mdx'
+import { useCurrentTocIndex } from '../Mdx'
 import { theme } from '../../styles/theme'
 import Method from './Method'