https://github.com/multiformats/js-sha3
Multiformats hash functions for SHA3
https://github.com/multiformats/js-sha3
Last synced: about 1 year ago
JSON representation
Multiformats hash functions for SHA3
- Host: GitHub
- URL: https://github.com/multiformats/js-sha3
- Owner: multiformats
- License: other
- Created: 2020-06-10T01:56:09.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2025-04-28T16:01:13.000Z (about 1 year ago)
- Last Synced: 2025-04-28T17:22:09.035Z (about 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 68.4 KB
- Stars: 4
- Watchers: 7
- Forks: 3
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# @multiformats/sha3
[](http://multiformats.io)
[](https://codecov.io/gh/multiformats/js-sha3)
[](https://github.com/multiformats/js-sha3/actions/workflows/js-test-and-release.yml?query=branch%3Amaster)
> Multiformats hash functions for SHA3
## Table of contents
- [Install](#install)
- [Usage](#usage)
- [License](#license)
- [Contribution](#contribution)
## Install
```console
$ npm i @multiformats/sha3
```
`MultihashHashers`s are exported from this library, they produce `MultihashDigest`s. Details about these can be found in the [multiformats multihash interface definitions](https://github.com/multiformats/js-multiformats/blob/master/src/hashes/interface.ts).
```js
import * as Block from 'multiformats/block'
import * as codec from '@ipld/dag-cbor'
import { sha3256 as hasher } from '@multiformats/sha3'
async function run () {
const value = { hello: 'world' }
const block = await Block.encode({ value, hasher, codec })
console.log(block.cid)
// -> CID(bafyrmidyqnbqbeh5lmkwavjizfmsz6ezwvjleweh5frwk56akfyugoio2e)
}
run().catch(console.error)
```
## Usage
The `@multiformats/sha3` package exports `sha3*`, `shake*` and `keccak*` `MultihashHasher`s. The Multicodecs [table](https://github.com/multiformats/multicodec/blob/master/table.csv) defines these multihashes.
The following `MultihashHasher`s are exported:
- `sha3224` - SHA3-224
- `sha3256` - SHA3-256
- `sha3384` - SHA3-384
- `sha3512` - SHA3-512
- `shake128` - SHAKE-128 (256 output bits)
- `shake256` - SHAKE-256 (512 output bits)
- `keccak224` - KECCAK-224
- `keccak256` - KECCAK-256
- `keccak384` - KECCAK-384
- `keccak512` - KECCAK-512
e.g. he `sha3-384`, multicodec code `0x15`, may be imported as:
```js
import { sha3384 } from '@multiformats/sha3'
```
## License
Licensed under either of
- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / )
- MIT ([LICENSE-MIT](LICENSE-MIT) / )
## Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.