upgrade safe protocol-kit and fix tooling (#180)

* upgrade safe protocol-kit and fix tooling * ignore ts error * fix eslint issue * fix cspell * moah esm * fix types --------- Co-authored-by: Jan-Felix <[email protected]> Co-authored-by: Philipp Giese <[email protected]>
gnosisguild · Nov 13, 2024 · b6185b1 · b6185b1
1 parent b9429dd
commit b6185b1
Show file tree

Hide file tree

Showing 10 changed files with 29 additions and 25 deletions.
diff --git a/extension/.cspell.json b/extension/.cspell.json
@@ -21,6 +21,7 @@
     "cowswap",
     "Delegatecall",
     "delegatecalls",
+    "depay",
     "esbuild",
     "ethersproject",
     "foundance",
@@ -51,30 +52,30 @@
     "refork",
     "rpcs",
     "Samczun",
+    "sandboxed",
     "sepolia",
+    "servedir",
+    "serviceworker",
     "shazow",
+    "sidepanel",
     "sighash",
     "Sindre",
     "Sorhus",
     "Sourcify",
+    "speculationrules",
     "staderlabs",
     "Stakewise",
     "Sushiswap",
+    "tailwindcss",
+    "textbox",
     "toastify",
     "Uids",
     "UNWRAPPER",
     "vnet",
     "walletconnect",
     "whatsabi",
     "xdai",
-    "xmlhttprequest",
-    "serviceworker",
-    "textbox",
-    "servedir",
-    "sidepanel",
-    "sandboxed",
-    "speculationrules",
-    "depay"
+    "xmlhttprequest"
   ],
   "flagWords": [],
   "ignorePaths": [

diff --git a/extension/.vscode/settings.json b/extension/.vscode/settings.json
@@ -6,5 +6,6 @@
   "typescript.enablePromptUseWorkspaceTsdk": true,
   "editor.codeActionsOnSave": {
     "source.fixAll.eslint": "explicit"
-  }
+  },
+  "typescript.tsdk": "node_modules/typescript/lib"
 }
diff --git a/extension/esbuild.js → extension/esbuild.mjs b/extension/esbuild.js → extension/esbuild.mjs
@@ -29,6 +29,7 @@ esbuild
       './src/panel/app.tsx',
     ],
     bundle: true,
+    format: 'esm',
     minify: process.env.NODE_ENV === 'production',
     sourcemap: process.env.NODE_ENV !== 'production' ? 'inline' : 'linked',
     loader: {

diff --git a/extension/eslint.config.mjs b/extension/eslint.config.mjs
@@ -44,7 +44,7 @@ export default tsEslint.config(
     ignores: ['public/build', 'playwright-report'],
   },
   {
-    files: ['esbuild.js', 'manifest-util.js'],
+    files: ['esbuild.mjs', 'manifest-util.js'],
     languageOptions: { globals: { process: true } },
   }
 )
diff --git a/extension/package.json b/extension/package.json
@@ -1,18 +1,18 @@
 {
   "name": "zodiac-pilot",
   "version": "0.0.0",
-  "type": "module",
   "description": "Chrome extension to simulate dApp interactions and record transactions",
+  "type": "module",
   "main": "index.js",
   "repository": "https://github.com/gnosisguild/zodiac-pilot.git",
   "author": "Jan-Felix <[email protected]>",
   "license": "LGPLv3",
   "private": true,
   "scripts": {
     "prebuild": "rimraf public/build",
-    "build": "NODE_ENV=production node esbuild.js",
+    "build": "NODE_ENV=production node esbuild.mjs",
     "zip": "mv public zodiac-pilot && zip -vr zodiac-pilot.zip zodiac-pilot/ -x \"*.DS_Store\" && mv zodiac-pilot public",
-    "dev": "NODE_ENV=development node esbuild.js",
+    "dev": "NODE_ENV=development node esbuild.mjs",
     "test:unit": "vitest",
     "test:e2e": "playwright test --headed",
     "check": "pnpm check:ts && pnpm check:format && pnpm check:lint && pnpm check:spelling",
@@ -33,7 +33,7 @@
     "@noble/hashes": "^1.4.0",
     "@playwright/test": "^1.48.1",
     "@safe-global/api-kit": "^2.4.2",
-    "@safe-global/protocol-kit": "^4.0.2",
+    "@safe-global/protocol-kit": "^5.0.1",
     "@safe-global/safe-apps-sdk": "^9.1.0",
     "@safe-global/safe-core-sdk-types": "^5.0.2",
     "@safe-global/safe-gateway-typescript-sdk": "^3.21.10",
@@ -113,4 +113,4 @@
       "vitest-chrome": "patches/vitest-chrome.patch"
     }
   }
-}
+}
diff --git a/extension/pnpm-lock.yaml b/extension/pnpm-lock.yaml
diff --git a/extension/public/sidepanel.html b/extension/public/sidepanel.html
@@ -12,7 +12,7 @@
     />
     <title>Zodiac Pilot</title>
     <link rel="stylesheet" href="/build/panel/app.css" />
-    <script src="/build/panel/app.js" defer></script>
+    <script type="module" src="/build/panel/app.js" defer></script>
   </head>
   <body class="h-full">
     <div class="flex h-full flex-col" id="root"></div>

diff --git a/extension/src/panel/integrations/safe/kits.ts b/extension/src/panel/integrations/safe/kits.ts
@@ -36,7 +36,7 @@ export const initSafeApiKit = (chainId: ChainId): SafeApiKit => {
 export const initSafeProtocolKit = async (
   chainId: ChainId,
   safeAddress: string
-) => {
+): Promise<Safe> => {
   // @ts-expect-error protocol-kit is only available as a CJS module. That doesn't play super nice with us being ESM.
   if (Safe.default) {
     // @ts-expect-error protocol-kit is only available as a CJS module. That doesn't play super nice with us being ESM.

diff --git a/extension/src/panel/providers/ForkProvider.ts b/extension/src/panel/providers/ForkProvider.ts
@@ -406,17 +406,18 @@ async function prepareSafeForSimulation(
   let from = moduleAddress || ownerAddress || DUMMY_MODULE_ADDRESS
   if (from === ZeroAddress) from = DUMMY_MODULE_ADDRESS
 
-  const iface = safe.getContractManager().safeContract?.contract.interface
+  const { safeContract } = safe.getContractManager()
 
-  invariant(iface, 'Safe contract not found')
+  invariant(safeContract != null, 'Safe contract not found')
 
   try {
     await provider.request({
       method: 'eth_sendTransaction',
       params: [
         {
           to: avatarAddress,
-          data: iface.encodeFunctionData('enableModule', [from]),
+          // @ts-expect-error TODO: needs a fix in protocol-kit -> https://github.com/safe-global/safe-core-sdk/issues/1021
+          data: safeContract.encode('enableModule', [from]),
           from: avatarAddress,
         },
       ],

diff --git a/extension/tsconfig.json b/extension/tsconfig.json
@@ -1,6 +1,6 @@
 {
   "compilerOptions": {
-    "target": "ES2020",
+    "target": "ES2023",
     "lib": ["dom", "dom.iterable", "esnext"],
     "allowJs": true,
     "skipLibCheck": true,
@@ -9,8 +9,8 @@
     "strict": true,
     "forceConsistentCasingInFileNames": true,
     "noFallthroughCasesInSwitch": true,
-    "module": "esnext",
-    "moduleResolution": "node",
+    "module": "ESNext",
+    "moduleResolution": "Node",
     "resolveJsonModule": true,
     "isolatedModules": true,
     "noEmit": true,