README

Urkel Tree

An optimized and cryptographically provable key-value store.

Design

The urkel tree was created for the Handshake protocol, and is implemented as a base-2 merkelized trie. It was created as an alternative to Ethereum's base-16 trie (which was the initial choice for Handshake name proofs).

Urkel stores nodes in a series of append-only files for snapshotting and crash consistency capabilities. Due to these presence of these features, Urkel has the ability to expose a fully transactional database.

The primary advantages in using an urkel tree over something like Ethereum's trie are:

Performance - Stores nodes in flat files instead of an existing key-value store like LevelDB. Urkel is its own database. In benchmarks, this results in a 100x+ speedup.
Simplicity - Maintains only two types of nodes: internal nodes and leaf nodes.
Storage - Internal nodes are small (a constant size of 76 bytes on disk). This is important as internal nodes are frequently rewritten during updates to the tree.
Proof Size - Sibling nodes required for proofs are a constant size of 32 bytes, similar to a typical merkle tree proof. This results in an extremely compact proof size.

The final benefit was the primary focus of the Handshake protocol. As name resolutions are a frequently requested operation, Handshake required proof sizes less than 1kb even after hundreds of millions of leaves are present in the tree.

History independence and non-destruction are also inherent properties of the urkel tree, just the same as the Ethereum trie. Note that urkel should only be used with uniformally distributed keys (i.e. hashed).

Compaction, while available, is currently inefficient and requires user intervention. This will be optimized in a future C implementation of the urkel tree. In the meantime, we don't see this as a problem as long as frequent commissions are avoided in consensus applications of the tree (i.e. avoid committing the tree on every block).

A more in-depth description is available in the Handshake Whitepaper.

Backends

There are currently three different backends:

urkel/trie - A simple base-2 merkelized trie whose design shares similarities with earlier work done by Bram Cohen.
urkel/radix - A base-2 merkelized radix tree, similar to Amaury Séchet's Merklix tree.
urkel/optimized - A memory and storage optimized version of the simplified trie.

Usage

const bcrypto = require('bcrypto');
const urkel = require('urkel');
const {BLAKE2b, randomBytes} = bcrypto;
const {Tree, Proof} = urkel;

// Create a tree using blake2b-256
// and a depth/key-size of 256 bits.
const tree = new Tree(BLAKE2b, 256, '/path/to/my/db');

await tree.open();

let key;

const txn = tree.transaction();

for (let i = 0; i < 500; i++) {
  const k = randomBytes(32);
  const v = randomBytes(300);

  await txn.insert(k, v);

  key = k;
}

// Commit and get the new root.
const root = await txn.commit();
const snapshot = tree.snapshot(root);

// Prove a key/value from our snapshotted root.
const proof = await snapshot.prove(key);
const [code, value] = proof.verify(root, key, BLAKE2b, 256);

if (code !== 0) {
  console.log('Could not verify proof: %s.', Proof.code(code));
  return;
}

if (value) {
  console.log('Valid proof for %s: %s',
    key.toString('hex'), value.toString('hex'));
} else {
  console.log('Absence proof for %s.', key.toString('hex'));
}

// Snapshots and transactions are async iterators.
// If your environment supports `for await`, you
// can use it with a snapshot, tree, or transaction.
for await (const [key, value] of snapshot) {
  console.log('Iterated over item:');
  console.log('%s: %s', key.toString('hex'), value.toString('hex'));
}

// Otherwise, the non-for-await way is available.
const iter = snapshot.iterator();

while (await iter.next()) {
  const {key, value} = iter;
  console.log('Iterated over item:');
  console.log('%s: %s', key.toString('hex'), value.toString('hex'));
}

await tree.close();

Contribution and License Agreement

If you contribute code to this project, you are implicitly allowing your code to be distributed under the MIT license. You are also implicitly verifying that all code is your original work. </legalese>

License

See LICENSE for more info.

Usage no npm install needed!