sol-profiler v2.0.1

sol-profiler

sol-profiler lists down the properties of all the contract methods which helps to visualize and review the definition of various contract methods involved at one glance. This is easy to use and user-friendly.

Note: sol-profiler does not ensure/guarantee any kind of security or correctness of any smart-contract.

Features

• Lists down attributes of contract methods
• Works with file & directory both
• Displays user friendly colourful profile on console for single file
• Also stores generated profile in a folder names profiles in a .txt file named with suffix _Profile
• Generates & stores profile for each available Solidity file if directory path is passed
• Supports file import relatively and from node_modules
• Explicitly marks abstract and fallback functions
• Explicitly marks library and interface contracts
• Since Solidity release 0.5.0, Explicit data location for all variables of struct, array or mapping types is now mandatory, so profile also include the data location of parameters defined explicitly.

Install

npm install --global sol-profiler

or

npm install --save-dev sol-profiler

Application

For DApp, one can provide its contract directory path and profile will be stored for each contract which can be referred in future to get the knowledge of the methods defined in various contract.

sol-profiler <dapp/contracts/or/any/directory/path>

It can be used for individual file as:

sol-profiler <solidity/contract/file/path>

It can also be added in the package.json as:

{
  "scripts": {
    "generateProfile": "sol-profiler ./contracts/"
  },
}

Example

We have attached an extensive example i.e. sample.sol. For this, profiler result will be same as in below image :

Generated profile which get stored in .txt file can be seen here.

VSCode Extension

sol-profiler is also available as Visual Studio Code Extension

Contribution/Suggestions

Any kind of suggestion/feedback/contribution is most welcome!

License

MIT