README.template.md

debug-solidity

Solidity library and related contracts for debugging

API Reference

Installation & Usage

⚠️ Do not use debug-solidity in production contracts. It is meant to aid in development and test environments.

Install using yarn/npm:

$ yarn add debug-solidity

Then, in your Solidity file, use the library:

import "debug-solidity/contracts/Debuggable.sol";
import "debug-solidity/contracts/DebugCounter.sol";

contract MyContract {

    using Debuggable for *;

    function myFunction() public {
        string valueString = "foobar";
        bytes32 valueBytes32 = 0x1234;
        uint256 valueUint256 = 1234;
        address valueAddress = address(0x0);

        valueString.debug();  // => emit DebugString(value: "foobar")
        valueBytes32.debug(); // => emit DebugBytes32(value: 0x1234)
        valueUint256.debug(); // => emit DebugUint256(value: 1234)
        valueAddress.debug(); // => emit DebugAddress(value: 0x0)

        Debuggable.debugRevert("msg");  // always reverts
        Debuggable.debugNoop();         // does nothing
        Debuggable.debugNoopConstant(); // does nothing (constant fn)

        DebugCounter counter = new DebugCounter("xyz");
        counter.increment(); // => emit DebugCount(name: "my counter", count: 1)
        counter.increment(); // => emit DebugCount(name: "my counter", count: 2)
        counter.increment(); // => emit DebugCount(name: "my counter", count: 3)
    }

}

Development

PRs welcome. To install dependencies and start the local development server:

$ yarn install
$ yarn run migrate
$ yarn start

Testing

$ yarn test
$ yarn watch

License

Licensed under Apache 2.0.

API Reference