sol2uml 2.5.5 → 2.5.6

package/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")

package/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

package/lib/parserEtherscan.js

@@ -28,9 +28,13 @@ exports.networks = [
     'celo',
 ];
 class EtherscanParser {
-    constructor(apikey = 'ZAD4UI2RCXCQTP38EXS3UY2MPHFU5H9KB1', network = 'mainnet') {
+    constructor(apikey = 'ZAD4UI2RCXCQTP38EXS3UY2MPHFU5H9KB1', network = 'mainnet', url) {
         this.apikey = apikey;
         this.network = network;
+        if (url) {
+            this.url = url;
+            return;
+        }
         if (!exports.networks.includes(network)) {
             throw new Error(`Invalid network "${network}". Must be one of ${exports.networks}`);
         }

package/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;
 }

package/lib/parserGeneral.js

@@ -17,7 +17,7 @@ const parserUmlClasses = async (fileFolderAddress, options) => {
     if ((0, regEx_1.isAddress)(fileFolderAddress)) {
         debug(`argument ${fileFolderAddress} is an Ethereum address so checking Etherscan for the verified source code`);
         const etherscanApiKey = options.apiKey || 'ZAD4UI2RCXCQTP38EXS3UY2MPHFU5H9KB1';
-        const etherscanParser = new parserEtherscan_1.EtherscanParser(etherscanApiKey, options.network);
+        const etherscanParser = new parserEtherscan_1.EtherscanParser(etherscanApiKey, options.network, options.explorerUrl);
         result = await etherscanParser.getUmlClasses(fileFolderAddress);
     }
     else {

package/lib/sol2uml.js

@@ -29,10 +29,11 @@ Can also flatten or compare verified source files on Etherscan-like explorers.`)
     .default('svg'))
     .option('-o, --outputFileName <value>', 'output file name')
     .option('-i, --ignoreFilesOrFolders <filesOrFolders>', 'comma separated list of files or folders to ignore')
-    .addOption(new commander_1.Option('-n, --network <network>', 'Ethereum network')
+    .addOption(new commander_1.Option('-n, --network <network>', 'Ethereum network which maps to a blockchain explorer')
     .choices(parserEtherscan_1.networks)
     .default('mainnet')
     .env('ETH_NETWORK'))
+    .addOption(new commander_1.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 commander_1.Option('-k, --apiKey <key>', 'Blockchain explorer API key. eg Etherscan, Arbiscan, Optimism, BscScan, CronoScan, FTMScan, PolygonScan or SnowTrace API key').env('SCAN_API_KEY'))
     .option('-bc, --backColor <color>', 'Canvas background color. "none" will use a transparent canvas.', 'white')
     .option('-sc, --shapeColor <color>', 'Basic drawing color for graphics, not text', 'black')
@@ -202,7 +203,7 @@ In order for the merged code to compile, the following is done:
             ...command.parent._optionValues,
             ...options,
         };
-        const etherscanParser = new parserEtherscan_1.EtherscanParser(combinedOptions.apiKey, combinedOptions.network);
+        const etherscanParser = new parserEtherscan_1.EtherscanParser(combinedOptions.apiKey, combinedOptions.network, combinedOptions.explorerUrl);
         const { solidityCode, contractName } = await etherscanParser.getSolidityCode(contractAddress);
         // Write Solidity to the contract address
         const outputFilename = combinedOptions.outputFileName || contractName;
@@ -239,7 +240,7 @@ The line numbers are from contract B. There are no line numbers for the red sect
         const lineBuffer = parseInt(options.lineBuffer);
         if (isNaN(lineBuffer))
             throw Error(`Invalid line buffer "${options.lineBuffer}". Must be a number`);
-        const etherscanParser = new parserEtherscan_1.EtherscanParser(combinedOptions.apiKey, combinedOptions.network);
+        const etherscanParser = new parserEtherscan_1.EtherscanParser(combinedOptions.apiKey, combinedOptions.network, combinedOptions.explorerUrl);
         // Get verified Solidity code from Etherscan and flatten
         const { solidityCode: codeA, contractName: contractNameA } = await etherscanParser.getSolidityCode(addressA, combinedOptions.aFile);
         const { solidityCode: codeB, contractName: contractNameB } = await etherscanParser.getSolidityCode(addressB, combinedOptions.bFile || combinedOptions.aFile);

package/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",