71 lines
2.5 KiB
Markdown
71 lines
2.5 KiB
Markdown
|
# @multiformats/murmur3 <!-- omit in toc -->
|
||
|
|
|
||
|
|
[](http://multiformats.io)
|
||
|
|
[](https://codecov.io/gh/multiformats/js-murmur3)
|
||
|
|
[](https://github.com/multiformats/js-murmur3/actions/workflows/js-test-and-release.yml)
|
||
|
|
|
||
|
|
> Multiformats Murmur3 implementations
|
||
|
|
|
||
|
|
## Table of contents <!-- omit in toc -->
|
||
|
|
|
||
|
|
- [Install](#install)
|
||
|
|
- [Usage](#usage)
|
||
|
|
- [License](#license)
|
||
|
|
- [Contribute](#contribute)
|
||
|
|
|
||
|
|
## Install
|
||
|
|
|
||
|
|
```console
|
||
|
|
$ npm i @multiformats/murmur3
|
||
|
|
```
|
||
|
|
|
||
|
|
`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 { murmur3128 as hasher } from '@multiformats/murmur3'
|
||
|
|
|
||
|
|
async function run () {
|
||
|
|
const value = { hello: 'world' }
|
||
|
|
const block = await Block.encode({ value, hasher, codec })
|
||
|
|
console.log(block.cid)
|
||
|
|
// -> CID(bafyseebn7ksk6khsn4an2lzmae6wm4qk)
|
||
|
|
}
|
||
|
|
|
||
|
|
run().catch(console.error)
|
||
|
|
```
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
The `@multiformats/murmur3` package exports `murmur332` and `murmur3128` `MultihashHasher`s. The Multicodecs [table](https://github.com/multiformats/multicodec/blob/master/table.csv) defines these multihashes.
|
||
|
|
|
||
|
|
The `murmur3-32`, multicodec code `0x23`, may be imported as:
|
||
|
|
|
||
|
|
```js
|
||
|
|
import { murmur332 } from '@multiformats/murmur3'
|
||
|
|
```
|
||
|
|
|
||
|
|
The `murmur3-128`, multicodec code `0x22`, may be imported as:
|
||
|
|
|
||
|
|
```js
|
||
|
|
import { murmur3128 } from '@multiformats/murmur3'
|
||
|
|
```
|
||
|
|
|
||
|
|
The `murmur3-x64-64` (which is first 64-bits of `murmur3-128` used in UnixFS directory sharding), multicodec code `0x22`, may be imported as:
|
||
|
|
|
||
|
|
```js
|
||
|
|
import { murmur364 } from '@multiformats/murmur3'
|
||
|
|
```
|
||
|
|
|
||
|
|
## License
|
||
|
|
|
||
|
|
Licensed under either of
|
||
|
|
|
||
|
|
- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
|
||
|
|
- MIT ([LICENSE-MIT](LICENSE-MIT) / <http://opensource.org/licenses/MIT>)
|
||
|
|
|
||
|
|
## Contribute
|
||
|
|
|
||
|
|
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.
|