├── package.json ├── LICENSE ├── .gitignore ├── README.md └── index.js /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "sol-function-profiler", 3 | "version": "1.0.0", 4 | "description": "", 5 | "main": "index.js", 6 | "scripts": { 7 | "test": "echo \"Error: no test specified\" && exit 1" 8 | }, 9 | "repository": { 10 | "type": "git", 11 | "url": "git+https://github.com/EricR/sol-function-profiler.git" 12 | }, 13 | "author": "Eric Rafaloff", 14 | "license": "MIT", 15 | "bugs": { 16 | "url": "https://github.com/EricR/sol-function-profiler/issues" 17 | }, 18 | "homepage": "https://github.com/EricR/sol-function-profiler#readme", 19 | "dependencies": { 20 | "ascii-table": "0.0.9", 21 | "solidity-parser": "^0.3.0" 22 | } 23 | } 24 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2017 Eric Rafaloff 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Logs 2 | logs 3 | *.log 4 | npm-debug.log* 5 | yarn-debug.log* 6 | yarn-error.log* 7 | 8 | # Runtime data 9 | pids 10 | *.pid 11 | *.seed 12 | *.pid.lock 13 | 14 | # Directory for instrumented libs generated by jscoverage/JSCover 15 | lib-cov 16 | 17 | # Coverage directory used by tools like istanbul 18 | coverage 19 | 20 | # nyc test coverage 21 | .nyc_output 22 | 23 | # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) 24 | .grunt 25 | 26 | # Bower dependency directory (https://bower.io/) 27 | bower_components 28 | 29 | # node-waf configuration 30 | .lock-wscript 31 | 32 | # Compiled binary addons (http://nodejs.org/api/addons.html) 33 | build/Release 34 | 35 | # Dependency directories 36 | node_modules/ 37 | jspm_packages/ 38 | 39 | # Typescript v1 declaration files 40 | typings/ 41 | 42 | # Optional npm cache directory 43 | .npm 44 | 45 | # Optional eslint cache 46 | .eslintcache 47 | 48 | # Optional REPL history 49 | .node_repl_history 50 | 51 | # Output of 'npm pack' 52 | *.tgz 53 | 54 | # Yarn Integrity file 55 | .yarn-integrity 56 | 57 | # dotenv environment variables file 58 | .env 59 | 60 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Solidity Function Profiler 2 | 3 | A command line tool that generates a human-consumable report listing a contract's functions. This is useful during manual code review to understand what functions are made public, use which modifiers, and so on. 4 | 5 | Usage Example: 6 | 7 | ``` 8 | $ npm install 9 | ... 10 | $ node index.js ~/contracts/mytoken.sol 11 | .--------------------------------------------------------------------------------------------------------. 12 | | ~/contracts/mytoken.sol | 13 | |--------------------------------------------------------------------------------------------------------| 14 | | Contract | Function | Visibility | Constant | Returns | Modifiers | 15 | |---------------|-------------------------------|------------|----------|-----------|--------------------| 16 | | MyToken | () | public | false | | payable | 17 | | MyToken | initTokenHolder(address,uint) | public | false | | onlyOwner | 18 | | MyToken | balance(address) | public | true | uint | | 19 | | MyToken | transferAll(address,address) | external | false | | onlyTokenHolder | 20 | | MyToken | kill() | internal | false | | | 21 | '--------------------------------------------------------------------------------------------------------' 22 | ``` 23 | -------------------------------------------------------------------------------- /index.js: -------------------------------------------------------------------------------- 1 | const parser = require("solidity-parser"); 2 | const asciiTable = require('ascii-table'); 3 | 4 | if(process.argv.length < 3) { 5 | console.log("Error: Missing argument for sol file to scan"); 6 | process.exit(1); 7 | } 8 | 9 | var target = process.argv[2], 10 | contract = parser.parseFile(target); 11 | 12 | generateReport(target, contract); 13 | 14 | function generateReport(target, contract) { 15 | var table = new asciiTable(target); 16 | table.setHeading('Contract', 'Function', 'Visibility', 'Constant', 'Returns', 'Modifiers'); 17 | 18 | contract.body.forEach(function(contract) { 19 | if(contract.type == 'ContractStatement') { 20 | contract.body.forEach(function(part) { 21 | if(part.type == "FunctionDeclaration" && part.is_abstract == false) { 22 | var func = parseFunctionPart(contract, part); 23 | table.addRow(func.contract, func.function, func.visibility, func.constant, func.returns, func.modifiers); 24 | } 25 | }) 26 | } 27 | }) 28 | console.log(table.toString()); 29 | } 30 | 31 | function parseFunctionPart(contract, part) { 32 | var contractName = contract.name, 33 | funcName = part.name || "", 34 | params = []; 35 | 36 | if(part.params) { 37 | part.params.forEach(function(param) { 38 | params.push(param.literal.literal); 39 | }); 40 | funcName += "(" + params.join(',') + ")" 41 | } else { 42 | funcName += "()" 43 | } 44 | 45 | // Default is public 46 | var visibility = "public" 47 | isConstant = false, 48 | returns = [], 49 | custom = []; 50 | 51 | if(part.modifiers) { 52 | part.modifiers.forEach(function(mod) { 53 | switch(mod.name) { 54 | case "public": 55 | break; 56 | case "private": 57 | visibility = "private"; 58 | break; 59 | case "internal": 60 | visibility = "internal"; 61 | break; 62 | case "external": 63 | visibility = "external"; 64 | break; 65 | case "constant": 66 | isConstant = true; 67 | break; 68 | case "returns": 69 | mod.params.forEach(function(param) { 70 | returns.push(param.name); 71 | }); 72 | break; 73 | default: 74 | custom.push(mod.name); 75 | } 76 | }); 77 | } 78 | 79 | return { 80 | contract: contractName, 81 | function: funcName, 82 | visibility: visibility, 83 | constant: isConstant, 84 | returns: returns, 85 | modifiers: custom 86 | } 87 | } 88 | --------------------------------------------------------------------------------