Added BSC and Polygon network support

naddison36 · Aug 7, 2021 · e76b808 · e76b808
1 parent 50f1295
commit e76b808
Show file tree

Hide file tree

Showing 11 changed files with 2,666 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -53,7 +53,7 @@ Options:
   -o, --outputFileName <value>                 output file name
   -d, --depthLimit <depth>                     number of sub folders that will be recursively searched for Solidity files. Default -1 is unlimited (default: -1)
   -i, --ignoreFilesOrFolders <filesOrFolders>  comma separated list of files or folders to ignore
-  -n, --network <network>                      mainnet, ropsten, kovan, rinkeby or goerli (default: "mainnet")
+  -n, --network <network>                      mainnet, polygon, bsc, ropsten, kovan, rinkeby or goerli (default: "mainnet")
   -a, --hideAttributes                         hide class and interface attributes
   -p, --hideOperators                          hide class and interface operators/functions
   -e, --hideEnums                              hide enum types

diff --git a/examples/README.md b/examples/README.md
@@ -1,6 +1,7 @@
 # Example UML Diagrams
 
 ## Crypto Kitties
+
 ![CryptoKitties](./cryptoKitties.svg)
 Generated from running
 ```
@@ -9,16 +10,34 @@ sol2uml 0x06012c8cf97BEaD5deAe237070F9587f8E7A266d
 This uses the verified Solidity code loaded to Etherscan https://etherscan.io/address/0x06012c8cf97BEaD5deAe237070F9587f8E7A266d#code
 
 ## Open Zeppelin ERC20 Tokens
+
 ![Open Zeppelin ERC20](./OpenZeppelinERC20.svg)
 Generated from version [2.3.0 contracts/token/ERC20](https://github.com/OpenZeppelin/openzeppelin-solidity/tree/v2.3.0/contracts/token/ERC20)
 
 ## Open Zeppelin Base Contract
+
 ![Open Zeppelin Base Contract](./OzToken.svg)
 Generated from version [2.5.1 contracts](https://github.com/OpenZeppelin/openzeppelin-solidity/tree/v2.5.1/contracts) with
-```base
+```
 sol2uml -b OzToken
 ```
 
+## mStable mUSD on Polygon
+
+![Polygon mUSD](./polygonMusd.svg)
+Generated from running
+```
+sol2uml -n polygon 0xcA9cf48aD534f1efA2B0f6923457F2953df86e0b
+```
+
+## Crypto Blades on BSC
+
+![BSC Crypto Blades](./bscCryptoBlades.svg)
+Generated from running
+```
+sol2uml -n bsc 0xB07c1C479b2Fdeb9f9B2d02300C13b328BF86d65
+```
+
 ## Open Zeppelin All
 ![Open Zeppelin ERC20](./OpenZeppelinAll.svg)
 Generated from version [2.5.1 contracts](https://github.com/OpenZeppelin/openzeppelin-solidity/tree/v2.5.1/contracts)

diff --git a/examples/bscCryptoBlades.svg b/examples/bscCryptoBlades.svg
diff --git a/examples/polygonMusd.svg b/examples/polygonMusd.svg
diff --git a/lib/etherscanParser.d.ts b/lib/etherscanParser.d.ts
@@ -1,6 +1,6 @@
 import { ASTNode } from '@solidity-parser/parser/dist/src/ast-types';
 import { UmlClass } from './umlClass';
-declare const networks: readonly ["mainnet", "ropsten", "kovan", "rinkeby", "goerli"];
+declare const networks: readonly ["mainnet", "ropsten", "kovan", "rinkeby", "goerli", "polygon", "bsc"];
 declare type Network = typeof networks[number];
 export declare class EtherscanParser {
     protected apikey: string;

diff --git a/lib/etherscanParser.js b/lib/etherscanParser.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": "1.1.28",
+  "version": "1.1.29",
   "description": "Unified Modeling Language (UML) class diagram generator for Solidity contracts",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",

diff --git a/src/ts/etherscanParser.ts b/src/ts/etherscanParser.ts
@@ -6,7 +6,15 @@ import { VError } from 'verror'
 import { convertNodeToUmlClass } from './parser'
 import { UmlClass } from './umlClass'
 
-const networks = <const>['mainnet', 'ropsten', 'kovan', 'rinkeby', 'goerli']
+const networks = <const>[
+    'mainnet',
+    'ropsten',
+    'kovan',
+    'rinkeby',
+    'goerli',
+    'polygon',
+    'bsc',
+]
 type Network = typeof networks[number]
 
 export class EtherscanParser {
@@ -22,6 +30,12 @@ export class EtherscanParser {
             )
         } else if (network === 'mainnet') {
             this.url = 'https://api.etherscan.io/api'
+        } else if (network === 'polygon') {
+            this.url = 'https://api.polygonscan.com/api'
+            this.apikey = 'AMHGNTV5A7XYGX2M781JB3RC1DZFVRWQEB'
+        } else if (network === 'bsc') {
+            this.url = 'https://api.bscscan.com/api'
+            this.apikey = 'APYH49FXVY9UA3KTDI6F4WP3KPIC86NITN'
         } else {
             this.url = `https://api-${network}.etherscan.io/api`
         }

diff --git a/src/ts/sol2uml.ts b/src/ts/sol2uml.ts
@@ -46,7 +46,7 @@ If an Ethereum address with a 0x prefix is passed, the verified source code from
     )
     .option(
         '-n, --network <network>',
-        'mainnet, ropsten, kovan, rinkeby or goerli',
+        'mainnet, polygon, bsc, ropsten, kovan, rinkeby or goerli',
         'mainnet'
     )
     .option('-a, --hideAttributes', 'hide class and interface attributes')