@vegaprotocol/simple-abi-docgen

0.0.5 • Public • Published

Simple ABI docgen

Generates a basic Markdown overview from a given ABI file.

It's pretty basic.

Running it

node index.js ./contract.json My Contract Title

Sample output

See the ERC20 example for the output, run against OpenZeppelin IERC20.sol.

In the wild

Feel free to add your project here if you're using simple-abi-docgen:

Alternatives

You probably really want solidity-docgen and to use NatSpec.

Readme

Keywords

none

Package Sidebar

Install

npm i @vegaprotocol/simple-abi-docgen

Weekly Downloads

9

Version

0.0.5

License

MIT

Unpacked Size

18.7 kB

Total Files

18

Last publish

Collaborators

  • dexturr
  • curly42
  • eddhannay
  • vega-bot