@alanshaw/pail

pail

DAG based key value store. Sharded DAG that minimises traversals and work to build shards.

• 📖 Read the SPEC.
• 🎬 Watch the Presentation.

Install

npm install @alanshaw/pail

Usage

import { ShardBlock, put, get, del } from '@alanshaw/pail'
import { MemoryBlockstore } from '@alanshaw/pail/block'

// Initialize a new bucket
const blocks = new MemoryBlockstore()
const init = await ShardBlock.create() // empty root shard
await blocks.put(init.cid, init.bytes)

// Add a key and value to the bucket
const { root, additions, removals } = await put(blocks, init.cid, 'path/to/data0', dataCID0)

console.log(`new root: ${root}`)

// Process the diff
for (const block of additions) {
  await blocks.put(block.cid, block.bytes)
}
for (const block of removals) {
  await blocks.delete(block.cid)
}

Contributing

Feel free to join in. All welcome. Open an issue!

License

Dual-licensed under MIT or Apache 2.0

Changelog

0.4.0 (2024-01-10)

Features

• batch put (#27) (e1e1db6)

Bug Fixes

• add missing dependency (030ffb6)
• build before publish (9be719c)
• import (13c8c59)

Performance Improvements

• optimised sorted events find when head is tail (7b9975b)