Skip to content

Commit

Permalink
direct to eth-utils; disambiguate from pyethash
Browse files Browse the repository at this point in the history
  • Loading branch information
@carver
carver committed Feb 7, 2018
1 parent e2e7c70 commit 6d1bc23
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,13 @@

The Ethereum hashing function, keccak256, sometimes (erroneously) called sha3

* Python 3.5+ support
Note: the similarly named [pyethash](https://github.com/ethereum/ethash)
has a completely different use: it generates proofs of work.

This is a low-level library, intended to be used internally by other Ethereum tools.
If you're looking for a convenient hashing tool, check out
[`eth_utils.keccak()`](https://github.com/ethereum/eth-utils#crypto-utils)
which will be a little friendlier, and provide access to other helpful utilities.

This comment has been minimized.

Sign in to view

Copy link
@onyb

onyb Feb 7, 2018

Contributor

@carver Small question. Are you saying that the API of eth_utils.keccak() is friendlier because it forces conversion of the prehash image to bytes?

This comment has been minimized.

Sign in to view

Copy link
@carver

carver Feb 9, 2018

Author Collaborator

Yes, once this is completed: ethereum/eth-utils#48

It's really common for people to want to hash hex strings, or text, and that doesn't belong in eth-hash IMO.

Read more in the [documentation on ReadTheDocs](http://eth-hash.readthedocs.io/). [View the change log](http://eth-hash.readthedocs.io/en/latest/releases.html).

Expand Down

0 comments on commit 6d1bc23

Please sign in to comment.