https://github.com/multiformats/js-blake2
BLAKE2 multihash hashers for JavaScript multiformats
https://github.com/multiformats/js-blake2
Last synced: about 1 year ago
JSON representation
BLAKE2 multihash hashers for JavaScript multiformats
- Host: GitHub
- URL: https://github.com/multiformats/js-blake2
- Owner: multiformats
- License: other
- Created: 2020-10-20T06:09:37.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2025-04-28T16:00:10.000Z (about 1 year ago)
- Last Synced: 2025-04-28T17:21:36.415Z (about 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 58.6 KB
- Stars: 3
- Watchers: 7
- Forks: 3
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# @multiformats/blake2
[](http://multiformats.io)
[](https://codecov.io/gh/multiformats/js-blake2)
[](https://github.com/multiformats/js-blake2/actions/workflows/js-test-and-release.yml?query=branch%3Amaster)
> Multiformats BLAKE2 implementations
## Table of contents
- [Install](#install)
- [Usage](#usage)
- [License](#license)
- [Contribution](#contribution)
## Install
```console
$ npm i @multiformats/blake2
```
`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 { blake2b256 as hasher } from '@multiformats/blake2/blake2b'
async function run () {
const value = { hello: 'world' }
const block = await Block.encode({ value, hasher, codec })
console.log(block.cid)
// -> CID(bafy2bzacedtxqx7k666ugf5mmagr2fxmbpfncbcji5jfg5uduausgb62y3av4)
}
run().catch(console.error)
```
## Usage
The `@multiformats/blake2/blake2b` package exports `blake2bX` `MultihashHasher`s, where `X` is the output length in bits. The Multicodecs [table](https://github.com/multiformats/multicodec/blob/master/table.csv) defines 64 different output lengths for **BLAKE2b**, from `8` to `512`.
The `@multiformats/blake2/blake2s` package exports `blake2sX` `MultihashHasher`s, where `X` is the output length in bits. For **BLAKE2s**, there are 32 different output lengths, from `8` to `256`.
e.g. `blake2b-256`, multicodec code `0xb220`, may be imported as:
```js
import { blake2b256 } from '@multiformats/blake2/blake2b'
```
while `blake2s-256`, multicodec code `0xb260`, may be imported as:
```js
import { blake2s256 } from '@multiformats/blake2/blake2s'
```
## 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.