@umbra-privacy/nimbus-storage-solana
v0.2.0
Published
The Solana wallet's storage, for the shielded pool on Solana: an ordered key-value port with all-or-nothing conditional commits, the row envelope every store writes, and the backends that implement the port, with every outside function injected by the cal
Readme
@umbra-privacy/nimbus-storage-solana
The Solana wallet's storage: an ordered key-value port with all-or-nothing conditional commits, the row envelope every store writes, the stores built on it, and the backends that implement the port.
Most apps don't install it directly. It is a storage engine of @umbra-privacy/nimbus-solana-web, which installs it for you.
Pre-release (0.x): every API, type and behaviour is subject to change at any time, as and when the Nimbus Privacy team (built by Umbra Privacy) decides or requires.
Install
pnpm add @umbra-privacy/nimbus-storage-solanaEntry points
@umbra-privacy/nimbus-storage-solana: The storage port, the row envelope and ordered key encoding.@umbra-privacy/nimbus-storage-solana/note-store: The note store: the wallet's notes, their nullifiers, leases, attempts, balances and feed positions.@umbra-privacy/nimbus-storage-solana/record-store: The record store: the wallet's records judged from the records feed, and its history.@umbra-privacy/nimbus-storage-solana/commitment-tree-store: One pool's commitment tree, built locally from the feeds, for the wallet's own Merkle paths and roots.@umbra-privacy/nimbus-storage-solana/nullifier-set-store: One turnstile's nullifiers as an indexed tree, to answer whether a nullifier is spent.@umbra-privacy/nimbus-storage-solana/indexeddb: The IndexedDB backend, for browsers.@umbra-privacy/nimbus-storage-solana/sqlite: The SQLite backend, over a synchronous driver the caller supplies.@umbra-privacy/nimbus-storage-solana/memory: The in-memory backend, for tests and short-lived tools.@umbra-privacy/nimbus-storage-solana/testing: The conformance suite every backend must pass, and the contract suites of the tree and nullifier stores.
License
Apache-2.0
Nimbus Privacy (built by Umbra Privacy)
