feat: added explorerUrl option for testnet block explorers

chore: bumped version to 2.5.6
naddison36 · Jun 25, 2023 · 328694e · 328694e
1 parent 5093f67
commit 328694e
Show file tree

Hide file tree

Showing 11 changed files with 229 additions and 156 deletions.
diff --git a/README.md b/README.md
@@ -55,8 +55,9 @@ Options:
   -f, --outputFormat <value>                   output file format. (choices: "svg", "png", "dot", "all", default: "svg")
   -o, --outputFileName <value>                 output file name
   -i, --ignoreFilesOrFolders <filesOrFolders>  comma separated list of files or folders to ignore
-  -n, --network <network>                      Ethereum network (choices: "mainnet", "goerli", "sepolia", "polygon", "arbitrum", "avalanche", "bsc", "crono", "fantom", "moonbeam",
+  -n, --network <network>                      Ethereum network which maps to a blockchain explorer (choices: "mainnet", "goerli", "sepolia", "polygon", "arbitrum", "avalanche", "bsc", "crono", "fantom", "moonbeam",
                                                "optimism", "gnosis", "celo", default: "mainnet", env: ETH_NETWORK)
+  -e, --explorerUrl <url>                      Override network with custom blockchain explorer API URL. eg Polygon Mumbai testnet https://api-testnet.polygonscan.com/api (env: EXPLORER_URL)
   -k, --apiKey <key>                           Blockchain explorer API key. eg Etherscan, Arbiscan, Optimism, BscScan, CronoScan, FTMScan, PolygonScan or SnowTrace API key (env: SCAN_API_KEY)
   -bc, --backColor <color>                     Canvas background color. "none" will use a transparent canvas. (default: "white")
   -sc, --shapeColor <color>                    Basic drawing color for graphics, not text (default: "black")

diff --git a/lib/parserEtherscan.d.ts b/lib/parserEtherscan.d.ts
@@ -10,7 +10,7 @@ export declare class EtherscanParser {
     protected apikey: string;
     network: Network;
     readonly url: string;
-    constructor(apikey?: string, network?: Network);
+    constructor(apikey?: string, network?: Network, url?: string);
     /**
      * Parses the verified source code files from Etherscan
      * @param contractAddress Ethereum contract address with a 0x prefix

diff --git a/lib/parserEtherscan.js b/lib/parserEtherscan.js
diff --git a/lib/parserGeneral.d.ts b/lib/parserGeneral.d.ts
@@ -3,6 +3,7 @@ import { UmlClass } from './umlClass';
 export interface ParserOptions {
     apiKey?: string;
     network?: Network;
+    explorerUrl?: string;
     subfolders?: string;
     ignoreFilesOrFolders?: string;
 }

diff --git a/lib/parserGeneral.js b/lib/parserGeneral.js
diff --git a/lib/sol2uml.js b/lib/sol2uml.js
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "sol2uml",
-  "version": "2.5.5",
+  "version": "2.5.6",
   "description": "Solidity contract visualisation tool.",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",

diff --git a/src/ts/parserEtherscan.ts b/src/ts/parserEtherscan.ts
@@ -38,8 +38,13 @@ export class EtherscanParser {
 
     constructor(
         protected apikey: string = 'ZAD4UI2RCXCQTP38EXS3UY2MPHFU5H9KB1',
-        public network: Network = 'mainnet'
+        public network: Network = 'mainnet',
+        url?: string
     ) {
+        if (url) {
+            this.url = url
+            return
+        }
         if (!networks.includes(network)) {
             throw new Error(
                 `Invalid network "${network}". Must be one of ${networks}`

diff --git a/src/ts/parserGeneral.ts b/src/ts/parserGeneral.ts
@@ -8,6 +8,7 @@ const debug = require('debug')('sol2uml')
 export interface ParserOptions {
     apiKey?: string
     network?: Network
+    explorerUrl?: string
     subfolders?: string
     ignoreFilesOrFolders?: string
 }
@@ -39,7 +40,8 @@ export const parserUmlClasses = async (
             options.apiKey || 'ZAD4UI2RCXCQTP38EXS3UY2MPHFU5H9KB1'
         const etherscanParser = new EtherscanParser(
             etherscanApiKey,
-            options.network
+            options.network,
+            options.explorerUrl
         )
 
         result = await etherscanParser.getUmlClasses(fileFolderAddress)

diff --git a/src/ts/sol2uml.ts b/src/ts/sol2uml.ts
@@ -50,11 +50,20 @@ Can also flatten or compare verified source files on Etherscan-like explorers.`
         'comma separated list of files or folders to ignore'
     )
     .addOption(
-        new Option('-n, --network <network>', 'Ethereum network')
+        new Option(
+            '-n, --network <network>',
+            'Ethereum network which maps to a blockchain explorer'
+        )
             .choices(networks)
             .default('mainnet')
             .env('ETH_NETWORK')
     )
+    .addOption(
+        new Option(
+            '-e, --explorerUrl <url>',
+            'Override network with custom blockchain explorer API URL. eg Polygon Mumbai testnet https://api-testnet.polygonscan.com/api'
+        ).env('EXPLORER_URL')
+    )
     .addOption(
         new Option(
             '-k, --apiKey <key>',
@@ -400,7 +409,8 @@ In order for the merged code to compile, the following is done:
 
             const etherscanParser = new EtherscanParser(
                 combinedOptions.apiKey,
-                combinedOptions.network
+                combinedOptions.network,
+                combinedOptions.explorerUrl
             )
 
             const { solidityCode, contractName } =
@@ -480,7 +490,8 @@ The line numbers are from contract B. There are no line numbers for the red sect
 
             const etherscanParser = new EtherscanParser(
                 combinedOptions.apiKey,
-                combinedOptions.network
+                combinedOptions.network,
+                combinedOptions.explorerUrl
             )
 
             // Get verified Solidity code from Etherscan and flatten