# merk

> Node.js bindings for Merk

Latest version **2.1.4** (published 2020-11-14) · MIT license · 0 weekly downloads

## Install

```sh
npm install merk
pnpm add merk
yarn add merk
bun add merk
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; large bundle.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.1.4 |
| Published | 2020-11-14 |
| First published | 2017-11-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 16.1 MB |
| Known vulnerabilities | 0 |
| Install scripts | yes |
| GitHub stars | 6 |
| Author | Matt Bell |
| Maintainers | mappum |

## Links

- npm: https://www.npmjs.com/package/merk
- Repository: https://github.com/nomic-io/node-merk
- Homepage: https://github.com/nomic-io/node-merk#readme
- Issues: https://github.com/nomic-io/node-merk/issues
- npm.io page: https://npm.io/package/merk

## Recent versions

- 2.1.4 (latest) — 2020-11-14
- 2.1.3 — 2020-11-14
- 2.1.2 — 2019-09-06
- 2.1.1 — 2019-09-05
- 2.1.0 — 2019-09-04
- 2.0.0 — 2019-09-04
- 1.3.9 — 2019-05-10
- 1.3.8 — 2019-05-08
- 1.3.7 — 2019-05-04
- 1.3.6 — 2019-05-04
- 1.3.5 — 2019-05-04
- 1.3.4 — 2018-05-02
- 1.3.3 — 2018-03-05
- 1.3.2 — 2018-02-17
- 1.3.1 — 2018-02-14
- … 5 more at https://npm.io/package/merk/versions

## README

# node-merk

*Node.js bindings for [Merk](https://github.com/nomic-io/merk)*

## Usage

`npm install merk`

```js
let { Merk, verifyProof } = require('merk')

// create or load store
let db = Merk('./state.db')

// get value
let value = db.getSync(Buffer.from('mykey'))

// get Merkle root
let hash = db.rootHash()

// create merkle proof
let keys = [
  Buffer.from('key1'),
  Buffer.from('key2')
]
let proof = db.proveSync(keys)

// verify a merkle proof
let proofResult = verifyProof(proof, keys, db.rootHash())

// modify values
db.batch()
  .put(Buffer.from('key1'), Buffer.from('value1'))
  .put(Buffer.from('key2'), Buffer.from('value2'))
  .delete(Buffer.from('key3'))
  .commitSync()
```

---
_Source: https://npm.io/package/merk · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
