✨ feat: Add phantom support

packages/cache/package.json

@@ -32,18 +32,21 @@
     "axios": "1.6.7",
     "chalk": "5.3.0",
     "commander": "12.0.0",
+    "download": "8.0.0",
     "esbuild": "0.20.0",
     "fs-extra": "11.2.0",
     "glob": "10.3.10",
     "gradient-string": "2.0.2",
     "progress": "2.0.3",
     "tsup": "8.0.2",
+    "unzip-crx-3": "0.2.0",
     "unzipper": "0.10.14",
     "zod": "3.22.4"
   },
   "devDependencies": {
     "@synthetixio/synpress-tsconfig": "0.0.1-alpha.7",
     "@types/archiver": "6.0.2",
+    "@types/download": "8.0.5",
     "@types/fs-extra": "11.0.4",
     "@types/gradient-string": "1.1.5",
     "@types/node": "20.11.17",

packages/cache/src/cli/cliEntrypoint.ts

@@ -12,6 +12,7 @@ import { footer } from './footer'
 interface CliFlags {
   keplr: boolean
   metamask: boolean
+  phantom: boolean
   headless: boolean
   force: boolean
   debug: boolean
@@ -34,6 +35,7 @@ export const cliEntrypoint = async () => {
     .option('-d, --debug', 'If this flag is present, the compilation files are not going to be deleted', false)
     .option('-k, --keplr', 'Prepare the Keplr extension', false)
     .option('-m, --metamask', 'Prepare the MetaMask extension', false)
+    .option('-p, --phantom', 'Prepare the Phantom extension', false)
     .helpOption(undefined, 'Display help for command')
     .addHelpText('afterAll', `\n${footer}\n`)
     .parse(process.argv)
@@ -57,12 +59,15 @@ export const cliEntrypoint = async () => {
     if (flags.metamask) {
       extensions.push('MetaMask')
     }
+    if (flags.phantom) {
+      extensions.push('Phantom')
+    }
     return extensions
   }
   let extensionNames = extensionsToSetup()
 
   if (!extensionNames.length) {
-    extensionNames = ['Keplr']
+    extensionNames = ['Metamask']
   }
 
   if (os.platform() === 'win32') {
@@ -81,7 +86,6 @@ export const cliEntrypoint = async () => {
   for (const extensionName of extensionNames) {
     await createCache(compiledWalletSetupDirPath, () => prepareExtension(extensionName), flags.force) // Pass extensionName
   }
-  // TODO: We should be using `prepareExtension` function from the wallet itself!
 
   if (!flags.debug) {
     await rimraf(compiledWalletSetupDirPath)

packages/cache/src/prepareExtension.ts

@@ -1,3 +1,5 @@
+import download from 'download'
+import unzipCrx from 'unzip-crx-3';
 import { downloadFile, ensureCacheDirExists, unzipArchive } from '.'
 
 interface ExtensionConfig {
@@ -20,6 +22,12 @@
         version: '0.12.102',
         downloadUrl:
           'https://github.com/chainapsis/keplr-wallet/releases/download/v0.12.102/keplr-extension-manifest-v2-v0.12.102.zip'
+      },
+      {
+        name: 'Phantom',
+        version: 'phantom-chrome-latest',
+        downloadUrl:
+          'https://crx-backup.phantom.dev/latest.crx'
       }
     ]
   }
@@ -34,16 +42,27 @@
 export async function prepareExtension(extensionName: string) {
   const cacheDirPath = ensureCacheDirExists()
   const extensionConfig = await getExtensionConfig(extensionName) // Get config
-
-  const downloadResult = await downloadFile({
-    url: extensionConfig.downloadUrl,
-    outputDir: cacheDirPath,
-    fileName: `${extensionConfig.name.toLowerCase()}-chrome-${extensionConfig.version}.zip`
-  })
-
-  const unzipResult = await unzipArchive({
-    archivePath: downloadResult.filePath
-  })
-
-  return unzipResult.outputPath
+  let downloadResult
+  if (extensionConfig.name === 'Phantom') {
+    const outputPath = `${cacheDirPath}/latest`
+    downloadResult = await download(extensionConfig.downloadUrl, cacheDirPath, {
+      headers: {
+        Accept: 'application/octet-stream',
+      },
+    });
+    await unzipCrx('.cache-synpress/latest.crx', outputPath)
+    return outputPath
+  }
+  else {
+    downloadResult = await downloadFile({
+      url: extensionConfig.downloadUrl,
+      outputDir: cacheDirPath,
+      fileName: `${extensionConfig.name.toLowerCase()}-chrome-${extensionConfig.version}.zip`
+    })
+    const unzipResult = await unzipArchive({
+      archivePath: downloadResult.filePath
+    })
+
+    return unzipResult.outputPath
+  }
 }

packages/cache/src/unzip.d.ts

@@ -0,0 +1 @@
+declare module 'unzip-crx-3';