multiformats
@multiformats/sha3
Multiformats hash functions for SHA3
Table of contents
Install
$ npm i @multiformats/sha3MultihashHasherss are exported from this library, they produce MultihashDigests. Details about these can be found in the multiformats multihash interface definitions.
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* MultihashHashers. The Multicodecs table defines these multihashes.
The following MultihashHashers are exported:
sha3224- SHA3-224sha3256- SHA3-256sha3384- SHA3-384sha3512- SHA3-512shake128- SHAKE-128 (256 output bits)shake256- SHAKE-256 (512 output bits)keccak224- KECCAK-224keccak256- KECCAK-256keccak384- KECCAK-384keccak512- KECCAK-512
e.g. he sha3-384, multicodec code 0x15, may be imported as:
import { sha3384 } from '@multiformats/sha3'License
Licensed under either of
- Apache 2.0, (LICENSE-APACHE / http://www.apache.org/licenses/LICENSE-2.0)
- MIT (LICENSE-MIT / http://opensource.org/licenses/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.