@phorbas/store v0.5.1

PHORBAS Store

A PHORBAS store is an associative 1:1 key to binary content data storage abstraction. Key must be a string, although often hex encoded from cryptographic hashing via PHORBAS Opaque. Content is binary (ArrayBuffer), direclty supporting encrypted content. The store handles the principles of Persistent, Binary content, Addressable, and Store.

• PHORBAS Opaque handles the principle of Hashed, Opaque, and Addressable.

• PHORBAS HAMT handles the principle of Replicable.

  PHORBAS Opaque: https://github.com/phorbas/js-phorbas-opaque

  PHORBAS HAMT: https://github.com/phorbas/js-phorbas-hamt

API & Use

import {kbc_js_map} from '@phorbas/store'

// use one of the many backend storage adapters
let stg = kbc_js_map()

// keys are opaque strings; some backend adapters may route based on parts of keys
let some_key = `some_key_${Date.now().toString(36)}`

await stg.bkc_exists(some_key) // 0

// store binary content addressed by key
let binary_body = crypto.getRandomValues(new Uint32Array(1024))
await stg.bkc_store(some_key, binary_body)


// key now exists
await stg.bkc_exists(some_key) // 1

// and we can fetch the binary content, returned in an ArrayBuffer
let body_result = await stg.bkc_fetch(some_key)

The backend storage API is fundamentally asynchronous, designed for use with @phorbas/opaque. The kbc prefix is for "keyed binary content".

• async kbc_exists(key) returns 1 if exists, otherwise 0
• async kbc_fetch(key) returns ArrayBuffer if exists, otherwise null|undefined

• async kbc_store(key, body) returns error | null, where error is null upon success.

• async * kbc_stream_exists(key_aiter, {signal}) is an async iterable streaming version of kbc_stream_exists

• async * kbc_stream_fetch(key_aiter, {signal}) is an async iterable streaming version of kbc_stream_fetch
• async * kbc_stream_store(key_body_aiter, {signal}) is an async iterable streaming version of kbc_store

Storage Implementations

JavaScript, Browser, and WinterCG

Local

NoSQL

S3 NoSQL

SQL and Knex adapter

Keyv adapter

About PHORBAS

The PHORBAS project implements a persistent binary data storage scheme that accomodates opaque (encrypted) information. It is inspired by binary content addressable data storage, replication features of CouchDB, the opaque data storage of Tahoe-LAFS, the eventual consistency of CRDTs, and persistent Hash array mapped trie data structures.

Phorbas appears in in Greek mythology and is connected to "giving pasture" -- in this case, safe pasture to for data storage.

P - Persistent
H - Hashed
O - Opaque
R - Replicable
B - Binary content
A - Addressable
S - Store

Due to the opaque nature of the data storage, the storage is not queryable like a database. It is similar to IPFS with a less ambitious goal of being a pratical data storage scheme for data for embedding into other projects.

License

2-Clause BSD