# @gotbit/merkle

> Merkle tree tools

Latest version **0.1.9** (published 2023-05-01) · MIT license · 0 weekly downloads

## Install

```sh
npm install @gotbit/merkle
pnpm add @gotbit/merkle
yarn add @gotbit/merkle
bun add @gotbit/merkle
```

## Health

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

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.9 |
| Published | 2023-05-01 |
| First published | 2023-01-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 8.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | kotsmile |
| Maintainers | kotsmile |
| Keywords | ethers, merkle tree, hash |

## Links

- npm: https://www.npmjs.com/package/@gotbit/merkle
- npm.io page: https://npm.io/package/@gotbit/merkle

## Alternatives

- [@gemini-wallet/core](https://npm.io/package/@gemini-wallet/core.md) — 515.6K weekly downloads
- [utility](https://npm.io/package/utility.md) — 416.6K weekly downloads
- [@primno/dpapi](https://npm.io/package/@primno/dpapi.md) — 7.2K weekly downloads
- [pi-readseek](https://npm.io/package/pi-readseek.md) — 3.7K weekly downloads
- [@emilia-protocol/verify](https://npm.io/package/@emilia-protocol/verify.md) — 1.1K weekly downloads

## Recent versions

- 0.1.9 (latest) — 2023-05-01
- 0.1.8 — 2023-02-01
- 0.1.7 — 2023-01-28
- 0.1.6 — 2023-01-27
- 0.1.5 — 2023-01-27
- 0.1.4 — 2023-01-26
- 0.1.3 — 2023-01-26
- 0.1.2 — 2023-01-26
- 0.1.1 — 2023-01-19
- 0.1.0 — 2023-01-19
- 0.0.2 — 2023-01-19

## README

# @gotbit/merkle

Library for work with [Merkle Tree](https://en.wikipedia.org/wiki/Merkle_tree)
Was choosen sorted version of Merkle Tree, with `keccak256` hash function from `ethers.js`

## Features

- Calculate root from raw leaves
- Generate proofs
- Verify proof

## Examples

### Root

Calculation of `root` for Merkle tree you need to prepare array of leaves (hashed values)

```typescript
import { calculateRoot } from '@gotbit/merkle'

const leaves = [
  '0xbc45a2b14ce263793725c93e12afa83d2cc6312b9abe44ed06fb66afd4394175',
  '0x67cdf3d02c0c38e81f3def6251132aaae3d70cd50a1639b039b3c87c99a6092b',
  '0x85e0c2c66b77fed6c821710352651309dc3792db7db10788af32daa42706a527',
  '0xdb5425be7bb655e161ff2939dfe331a07c16e42933b133c624d1dce76f66fb6b',
]

const root = calculateRoot(leaves)
```

### Proof

Generation of proof for specific leafe

```typescript
import { generateProof } from '@gotbit/merkle'

const leaves = [
  '0xbc45a2b14ce263793725c93e12afa83d2cc6312b9abe44ed06fb66afd4394175',
  '0x67cdf3d02c0c38e81f3def6251132aaae3d70cd50a1639b039b3c87c99a6092b',
  '0x85e0c2c66b77fed6c821710352651309dc3792db7db10788af32daa42706a527',
  '0xdb5425be7bb655e161ff2939dfe331a07c16e42933b133c624d1dce76f66fb6b',
]

const i = 0
const proof = generateProof(leaves, leaves[i]) // generates proof for i-leaf
```

### Verify

To verify correctness of proof you can use `typescript` or make on-chain with `Merkle` solidity library

#### Typescript

```typescript
import { generateProof, calculateRoot, verify } from '@gotbit/merkle'

const leaves = [
  '0xbc45a2b14ce263793725c93e12afa83d2cc6312b9abe44ed06fb66afd4394175',
  '0x67cdf3d02c0c38e81f3def6251132aaae3d70cd50a1639b039b3c87c99a6092b',
  '0x85e0c2c66b77fed6c821710352651309dc3792db7db10788af32daa42706a527',
  '0xdb5425be7bb655e161ff2939dfe331a07c16e42933b133c624d1dce76f66fb6b',
]

const root = calculateRoot(leaves)

const index = 0
const proof = generateProof(leaves, leaves[index]) // generates proof for i-leaf

const result = verify(proof, root, leaves[index]) // return `true` if proof is correct
```

#### Solidity

```solidity

import "@gotbit/merkle/contracts/Merkle.sol";

contract Vesting {
  using Merkle for bytes32[];

  bytes32 ROOT;

  function verify(bytes32[] memory proof) external {
    bytes32 leaf = abi.encode(msg.sender);
    require(proof.verify(ROOT, leaf), 'Incorrect proof');
  }
}

```

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