sol2uml 2.2.4 → 2.2.6

package/README.md

@@ -58,7 +58,7 @@ 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", "ropsten", "kovan", "rinkeby", "goerli", "sepolia", "polygon", "testnet.polygon", "arbitrum", "testnet.arbitrum", "avalanche", "testnet.avalanche", "bsc", "testnet.bsc", "crono", "fantom", "testnet.fantom", "moonbeam", "optimistic", "kovan-optimistic", default: "mainnet", env: ETH_NETWORK)
+  -n, --network <network>                      Ethereum network (choices: "mainnet", "ropsten", "kovan", "rinkeby", "goerli", "sepolia", "polygon", "testnet.polygon", "arbitrum", "testnet.arbitrum", "avalanche", "testnet.avalanche", "bsc", "testnet.bsc", "crono", "fantom", "testnet.fantom", "moonbeam", "optimistic", "kovan-optimistic", "gnosisscan", default: "mainnet", env: ETH_NETWORK)
   -k, --apiKey <key>                           Blockchain explorer API key. eg Etherscan, Arbiscan, BscScan, CronoScan, FTMScan, PolygonScan or SnowTrace API key (env: SCAN_API_KEY)
   -v, --verbose                                run with debugging statements (default: false)
   -h, --help                                   display help for command

package/lib/parserEtherscan.d.ts

@@ -1,6 +1,6 @@
 import { ASTNode } from '@solidity-parser/parser/dist/src/ast-types';
 import { UmlClass } from './umlClass';
-export declare const networks: readonly ["mainnet", "ropsten", "kovan", "rinkeby", "goerli", "sepolia", "polygon", "testnet.polygon", "arbitrum", "testnet.arbitrum", "avalanche", "testnet.avalanche", "bsc", "testnet.bsc", "crono", "fantom", "testnet.fantom", "moonbeam", "optimistic", "kovan-optimistic"];
+export declare const networks: readonly ["mainnet", "ropsten", "kovan", "rinkeby", "goerli", "sepolia", "polygon", "testnet.polygon", "arbitrum", "testnet.arbitrum", "avalanche", "testnet.avalanche", "bsc", "testnet.bsc", "crono", "fantom", "testnet.fantom", "moonbeam", "optimistic", "kovan-optimistic", "gnosisscan"];
 declare type Network = typeof networks[number];
 export declare class EtherscanParser {
     protected apikey: string;

package/lib/parserEtherscan.js

@@ -32,6 +32,7 @@ exports.networks = [
     'moonbeam',
     'optimistic',
     'kovan-optimistic',
+    'gnosisscan',
 ];
 class EtherscanParser {
     constructor(apikey = 'ZAD4UI2RCXCQTP38EXS3UY2MPHFU5H9KB1', network = 'mainnet') {
@@ -69,14 +70,15 @@ class EtherscanParser {
         }
         else if (network === 'bsc') {
             this.url = 'https://api.bscscan.com/api';
+            this.apikey = 'APYH49FXVY9UA3KTDI6F4WP3KPIC86NITN';
         }
         else if (network === 'testnet.bsc') {
             this.url = 'https://api-testnet.bscscan.com/api';
+            this.apikey = 'APYH49FXVY9UA3KTDI6F4WP3KPIC86NITN';
         }
         else if (network === 'crono') {
             this.url = 'https://api.cronoscan.com/api';
             this.apikey = '76A3RG5WHTPMMR66E9SFI2EIDT6MP976W2';
-            this.apikey = 'APYH49FXVY9UA3KTDI6F4WP3KPIC86NITN';
         }
         else if (network === 'fantom') {
             this.url = 'https://api.ftmscan.com/api';
@@ -94,6 +96,10 @@ class EtherscanParser {
             this.url = 'https://api-moonbeam.moonscan.io/api';
             this.apikey = '5EUFXW6TDC16VERF3D9SCWRRU6AEMTBHNJ';
         }
+        else if (network === 'gnosisscan') {
+            this.url = 'https://api.gnosisscan.io/api';
+            this.apikey = '2RWGXIWK538EJ8XSP9DE2JUINSCG7UCSJB';
+        }
         else {
             this.url = `https://api-${network}.etherscan.io/api`;
         }

package/lib/parserGeneral.js

@@ -11,7 +11,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.etherscanApiKey || 'ZAD4UI2RCXCQTP38EXS3UY2MPHFU5H9KB1';
+        const etherscanApiKey = options.apiKey || 'ZAD4UI2RCXCQTP38EXS3UY2MPHFU5H9KB1';
         const etherscanParser = new parserEtherscan_1.EtherscanParser(etherscanApiKey, options.network);
         result = await etherscanParser.getUmlClasses(fileFolderAddress);
     }

package/lib/sol2uml.js

@@ -37,7 +37,7 @@ The Solidity code can be pulled from verified source code on Blockchain explorer
     .choices(parserEtherscan_1.networks)
     .default('mainnet')
     .env('ETH_NETWORK'))
-    .addOption(new commander_1.Option('-k, --apiKey <key>', 'Blockchain explorer API key. eg Etherscan, Arbiscan, BscScan, CronoScan, FTMScan, PolygonScan or SnowTrace API key').env('SCAN_API_KEY'))
+    .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('-v, --verbose', 'run with debugging statements', false);
 program
     .command('class', { isDefault: true })

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sol2uml",
-  "version": "2.2.4",
+  "version": "2.2.6",
   "description": "Solidity contract visualisation tool.",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",
@@ -31,10 +31,10 @@
     "klaw": "^4.0.1"
   },
   "devDependencies": {
+    "@openzeppelin/contracts": "4.7.3",
     "@types/jest": "^29.1.1",
     "@types/klaw": "^3.0.3",
     "jest": "^29.1.2",
-    "@openzeppelin/contracts": "4.7.3",
     "prettier": "^2.7.1",
     "ts-jest": "^29.0.3",
     "ts-node": "^10.9.1",