trufflesuite/truffle

View on GitHub
packages/decoder/README.md

Summary

Maintainability
Test Coverage
# Truffle Decoder

This module, `@truffle/decoder`, provides an interface for decoding Solidity
smart contract state as well as information sent to or from smart contracts
using the Solidity ABI.  It produces output in a machine-readable form that
avoids losing any information.

For detailed instructions on how to use this module, please see the [API
documentation](https://www.trufflesuite.com/docs/truffle/codec/index.html).

## Install

```
$ npm install --save @truffle/decoder
```

This module does not provide a CLI; it is entirely meant to be used as part
of a larger JavaScript or TypeScript program.

## Usage and Documentation

Please see the [API
documentation](https://www.trufflesuite.com/docs/truffle/codec/index.html) for
detailed usage instructions.

## License

As part of the larger [Truffle Suite](https://github.com/trufflesuite/truffle/),
this module is MIT-licensed.