trufflesuite/truffle

View on GitHub
packages/encoder/README.md

Summary

Maintainability
Test Coverage
# Truffle Encoder

This module, `@truffle/encoder`, provides an interface for encoding
user input to Solidity transactions as well as resolving overloads.
It can also be used to process user-input Solidity values for other
purposes such as specifying mapping keys.

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/encoder
```

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.