JSPM

  • Created
  • Published
  • Downloads 1895
  • Score
    100M100P100Q101672F
  • License GPL-3.0

Sūrya, The Sun God: A set of utilities for inspecting the structure of Solidity contracts.

Package Exports

  • surya

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (surya) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Sūrya, The Sun God: A Solidity Inspector

Created by @federicobond extended by @GNSPS

A set of utilities for inspecting the structure of Solidity contracts.

The name stems from the sun deity Surya

Why the sun, you ask? Because "sun" in latin and portuguese is Sol.

Getting Started

Install it via npm:

npm install -g surya

Command List

describe

The describe command shows a summary of the contracts and methods in the files provided.

surya describe MyContract.sol

graph

The graph command outputs a DOT-formatted graph of the control flow.

surya graph MyContract.sol | dot -Tpng > MyContract.png

parse

The parse command outputs a "treefied" AST object coming from the parser.

surya parse MyContract.sol

ftrace

The ftrace command outputs a "treefied" function call trace stemming from the defined "CONTRACT::FUNCTION" and traversing "all|internal|external" types of calls.

surya ftrace APMRegistry::_newRepo all MyContract.sol

License

GPL-3.0