debug-solidity

Solidity library and related contracts for debugging contracts

API Reference

Installation & Usage

:warning: 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

Regenerate documentation

$ npm run gen-docs

License

Licensed under Apache 2.0.

API Reference

• Debuggable
  • debugRevert
  • debug
  • debugNoopConstant
  • debug
  • debugRevert
  • debug
  • debug
  • debugNoop
  • DebugString
  • DebugBytes32
  • DebugUint256
  • DebugAddress

Debuggable

Alexander Kern [email protected]

function debugRevert

Debuggable.debugRevert() pure 29b9505f

Reverts when called

function debug

Debuggable.debug(value) nonpayable 2f50fbfa

Emits a DebugString event with a string value

Inputs

| type | name | description | |-|-|-| | string | value | The string value |

function debugNoopConstant

Debuggable.debugNoopConstant() pure 58e8e8db

Does nothing (constant fn)

function debug

Debuggable.debug(value) nonpayable 6714a34e

Emits a DebugAddress event with an address value

Inputs

| type | name | description | |-|-|-| | address | value | The address value |

function debugRevert

Debuggable.debugRevert(message) pure 6a9b418f

Reverts with a message when called

Inputs

| type | name | description | |-|-|-| | string | message | The message |

function debug

Debuggable.debug(value) nonpayable 815dd951

Emits a DebugUint256 event with a uint256 value

Inputs

| type | name | description | |-|-|-| | uint256 | value | The uint256 value |

function debug

Debuggable.debug(value) nonpayable 9bb4050e

Emits a DebugBytes32 event with a bytes32 value

Inputs

| type | name | description | |-|-|-| | bytes32 | value | The bytes32 value |

function debugNoop

Debuggable.debugNoop() nonpayable eda892c1

Does nothing

event DebugString

Debuggable.DebugString(value) 20670ef4

Arguments

| type | name | description | |-|-|-| | string | value | not indexed |

event DebugBytes32

Debuggable.DebugBytes32(value) 110cb96f

Arguments

| type | name | description | |-|-|-| | bytes32 | value | not indexed |

event DebugUint256

Debuggable.DebugUint256(value) 43d4b470

Arguments

| type | name | description | |-|-|-| | uint256 | value | not indexed |

event DebugAddress

Debuggable.DebugAddress(value) e7375f84

Arguments

| type | name | description | |-|-|-| | address | value | not indexed |