Code Monkey home page Code Monkey logo

ex_keccak's Introduction

ExKeccak

ExKeccak is a NIF that wraps the KECCAK-256 function from the tiny-keccak Rust library. KECCAK-256 is used by Ethereum.

Installation

ex_keccak requires Rust to be installed.

The package can be installed by adding ex_keccak to your list of dependencies in mix.exs:

def deps do
  [
    {:ex_keccak, "~> 0.1.2"}
  ]
end

Usage

To calculate KECCAK-256 hash, use ExKeccak.hash_256/1 function. It returns {:ok, result} on success:

{
  :ok,
  <<28, 138, 255, 149, 6, 133, 194, 237, 75, 195, 23, 79, 52, 114, 40, 123, 86, 217, 81, 123, 156, 148, 129, 39, 49, 154, 9, 167, 163, 109, 234, 200>>
} = ExKeccak.hash_256("hello")

And it returns {:error, :invalid_type} if the provided data is not binary:

{:error, :invalid_type} = ExKeccak.hash_256(11)

Contributing

  1. Fork it!
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

License

ExKeccak is released under the Apache-2.0 License.

ex_keccak's People

Contributors

tzumby avatar ayrat555 avatar tsutsu avatar julianwyz avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.