diff --git a/CHANGELOG.md b/CHANGELOG.md index 8c69d58..3c289a8 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,7 @@ # Changelog +## 0.8.0 +* make keccak module configurable (https://github.com/poanetwork/ex_abi/pull/169) ## 0.7.3 * Fix type decoder to use lazy stream instead of pre-allocated list (https://github.com/poanetwork/ex_abi/pull/170) ## 0.7.2 diff --git a/README.md b/README.md index 8adb254..207b7c2 100644 --- a/README.md +++ b/README.md @@ -5,12 +5,13 @@ The [Application Binary Interface](https://solidity.readthedocs.io/en/develop/ab ## Installation If [available in Hex](https://hex.pm/docs/publish), the package can be installed -by adding `ex_abi` to your list of dependencies in `mix.exs`: +by adding `ex_abi` and `ex_keccak` to your list of dependencies in `mix.exs`: ```elixir def deps do [ - {:ex_abi, "~> 0.7.3"} + {:ex_abi, "~> 0.8.0"}, + {:ex_keccak, "~> 0.7.5"} ] end ``` @@ -21,12 +22,14 @@ be found at [https://hexdocs.pm/ex_abi](https://hexdocs.pm/ex_abi). ## Confiiguration -The default keccak library is set to `ex_keccak` but that can be ovveriden for a different libary: +The default keccak library is set to `ex_keccak` but that can be overridden with a different module. The module should implement one function `hash_256/1`. ```elixir -config :ex_abi, keccak_module: KeccakEx +config :ex_abi, keccak_module: MyCustomKeccak ``` +If you're going to use a custom module, you should remove `ex_keccak` from deps in `mix.exs`. + ## Usage ### Encoding diff --git a/mix.exs b/mix.exs index 3b8f4e7..35a47ee 100644 --- a/mix.exs +++ b/mix.exs @@ -4,7 +4,7 @@ defmodule ABI.Mixfile do def project do [ app: :ex_abi, - version: "0.7.3", + version: "0.8.0", elixir: "~> 1.8", description: "Ethereum's ABI Interface", package: [