Add support for multiple addresses (#73)

Author: sz-piotr

CONTRIBUTING.md

@@ -23,7 +23,7 @@ cd ..
 # install deps
 pnpm install
 
-pnpm build # this builds whole vscode and can take A LOT of time
+pnpm build # this builds whole vscode and can take A LOT of time. If you are having issues, read below
 pnpm serve
 ```
 
@@ -35,6 +35,13 @@ pnpm serve
 
 - **`pnpm build`** - Builds all packages.
 
+  If you are having issues with MacOS and Python try the following:
+  ```
+  $ brew install sqlite
+  $ npm config set sqlite /opt/homebrew/opt/sqlite
+  $ npm config set python python3
+  ```
+
 - **`pnpm watch`** - Starts webpack for `ethereum-extension` in watch mode.
 
 - **`pnpm serve`** - Starts HTTP server with `vscode-host`.

packages/ethereum-viewer/src/contributedCommands.ts

@@ -50,11 +50,16 @@ export function registerContributedCommands(
 
       const { apiName } = picked;
 
-      const info = await openContractSource(context, { fs, address, apiName });
+      const contractName = await openContractSource(
+        context,
+        fs,
+        apiName,
+        address
+      );
 
       renderStatusBarItems({
         contractAddress: address,
-        contractName: info.ContractName || "contract",
+        contractName,
         apiName,
       });
     },

packages/ethereum-viewer/src/explorer/api-types.ts

@@ -31,7 +31,7 @@ export function sourceHasSettings(
   return s.startsWith("{{");
 }
 
-export function sourceHasMulitpleFiles(
+export function sourceHasMultipleFiles(
   s: SourceCode
 ): s is SourceCode.MultipleSources {
   return s.startsWith("{");

packages/ethereum-viewer/src/explorer/fetchFiles.ts

@@ -18,12 +18,16 @@ interface FetchFilesOptions {
    * If more than 0, we fetch implementation contract and merge its files.
    */
   proxyDepth?: number;
+  /**
+   * If true multiple files are not prefixed.
+   */
+  skipPrefix?: boolean;
 }
 
 export async function fetchFiles(
   apiName: ApiName,
   contractAddress: string,
-  { fetch = _fetch, proxyDepth = 3 }: FetchFilesOptions = {}
+  { fetch = _fetch, proxyDepth = 3, skipPrefix = false }: FetchFilesOptions = {}
 ): Promise<FetchFilesResult> {
   const apiUrl = explorerApiUrls[apiName];
   const url =
@@ -72,15 +76,15 @@ export async function fetchFiles(
       files[path] = content;
     }
 
-    files = prefixFiles(files, info.ContractName);
-  } else if (types.sourceHasMulitpleFiles(sourceCode)) {
+    if (!skipPrefix) files = prefixFiles(files, info.ContractName);
+  } else if (types.sourceHasMultipleFiles(sourceCode)) {
     const parsed = types.parseSourceCode(sourceCode);
 
     for (const [path, { content }] of Object.entries(parsed)) {
       files[path] = content;
     }
 
-    files = prefixFiles(files, info.ContractName);
+    if (!skipPrefix) files = prefixFiles(files, info.ContractName);
   } else {
     files[info.ContractName + fileExtension(info)] = sourceCode;
   }

packages/ethereum-viewer/src/extension.ts

@@ -49,15 +49,11 @@ async function main(context: vscode.ExtensionContext) {
     apiName,
   });
 
-  const info = await openContractSource(context, {
-    fs,
-    apiName,
-    address,
-  });
+  const contractName = await openContractSource(context, fs, apiName, address);
 
   renderStatusBarItems({
     contractAddress: address,
-    contractName: info.ContractName || "contract",
+    contractName,
     apiName,
   });
 }

packages/ethereum-viewer/src/openContractSource.ts

@@ -21,19 +21,17 @@ const IS_ONLINE = true; // Treat this as a toggle for development.
 let fileSearchProviderDisposable: Disposable | undefined;
 let textSearchProviderDisposable: Disposable | undefined;
 
-export interface OpenContractSourceArgs {
-  fs: FileSystem;
-  apiName: explorer.ApiName;
-  address: string;
-}
-
 export async function openContractSource(
   context: ExtensionContext,
-  args: OpenContractSourceArgs
-) {
-  const [entries, info] = await saveContractFilesToFs(args);
-
-  const mainFile = getMainContractFile(entries, info);
+  fs: FileSystem,
+  apiName: explorer.ApiName,
+  address: string
+): Promise<string> {
+  const { entries, mainFile, contractName } = await saveContractFilesToFs(
+    fs,
+    apiName,
+    address
+  );
 
   fileSearchProviderDisposable?.dispose();
   fileSearchProviderDisposable = workspace.registerFileSearchProvider(
@@ -51,47 +49,93 @@ export async function openContractSource(
 
   await showTextDocument(mainFile);
 
-  return info;
+  return contractName;
+}
+
+async function saveContractFilesToFs(
+  fs: FileSystem,
+  apiName: explorer.ApiName,
+  address: string
+) {
+  if (address.includes(",")) {
+    const addresses = address.split(",");
+    const results = await Promise.all(
+      addresses.map((a) =>
+        saveSingleContractFilesToFs(fs, apiName, a, {
+          prefix: a + "/",
+          allowProxies: false,
+          includeMainInfo: true,
+        })
+      )
+    );
+    return {
+      entries: results.flatMap((r) => r.entries),
+      mainFile: results[0].mainFile,
+      contractName: results[0].contractName,
+    };
+  }
+  return saveSingleContractFilesToFs(fs, apiName, address, {
+    allowProxies: true,
+    includeMainInfo: false,
+  });
 }
 
-async function saveContractFilesToFs({
-  fs,
-  address,
-  apiName,
-}: OpenContractSourceArgs) {
+async function saveSingleContractFilesToFs(
+  fs: FileSystem,
+  apiName: explorer.ApiName,
+  address: string,
+  options: {
+    prefix?: string;
+    allowProxies: boolean;
+    includeMainInfo: boolean;
+  }
+) {
   let result: explorer.FetchFilesResult;
 
   // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
   if (IS_ONLINE) {
-    result = await explorer.fetchFiles(apiName, address);
+    result = await explorer.fetchFiles(apiName, address, {
+      proxyDepth: options.allowProxies ? undefined : 0,
+      skipPrefix: !!options.prefix,
+    });
   } else {
     result = fixtures.etherscanResult;
   }
 
+  const withPrefix = (file: string) =>
+    options.prefix ? options.prefix + file : file;
+
   const entries = Object.entries(result.files);
   for (const [path, content] of entries) {
-    fs.writeFile(path, content);
+    fs.writeFile(withPrefix(path), content);
   }
 
-  return [entries, result.info] as const;
+  const mainFile = getMainContractFile(entries, result.info);
+
+  if (options.includeMainInfo) {
+    fs.writeFile(withPrefix("main.md"), `Main file: ${mainFile}`);
+  }
+
+  return {
+    entries,
+    mainFile: withPrefix(mainFile),
+    contractName: result.info.ContractName ?? "contract",
+  };
 }
 
 function getMainContractFile(
-  files: [string, ...unknown[]][],
+  files: [string, string][],
   info: explorer.FetchFilesResult["info"]
 ): string {
   const ext = fileExtension(info);
+  const name = info.implementation?.ContractName ?? info.ContractName;
 
-  let fileToShow =
-    info.implementation &&
-    files.find(([path]) =>
-      path.endsWith(`/${info.implementation!.ContractName}${ext}`)
-    );
+  let fileToShow = files.find(([path]) => path.endsWith(`/${name}${ext}`));
 
-  if (!fileToShow)
-    fileToShow = files.find(([path]) =>
-      path.endsWith(`/${info.ContractName}${ext}`)
-    );
+  if (!fileToShow) {
+    const regexp = new RegExp(`contract\\s+${name}`);
+    fileToShow = files.find(([path, source]) => regexp.test(source));
+  }
 
   if (!fileToShow) fileToShow = files.sort(byPathLength)[0];