@ocap/statedb-sqlite

OCAP statedb adapter that uses SQLite as backend via Kysely

Install

npm install @ocap/statedb-sqlite
// or
bun install @ocap/statedb-sqlite

Usage

In-Memory Mode

For testing or ephemeral data:

const SqliteStateDB = require('@ocap/statedb-sqlite').default;

const statedb = new SqliteStateDB({ filename: ':memory:' });
await statedb.initialize();

// Use statedb...
await statedb.account.create('z1abc...', { balance: '1000' });

// Close when done
await statedb.close();

File Mode

For persistent storage:

const SqliteStateDB = require('@ocap/statedb-sqlite').default;

const statedb = new SqliteStateDB({ filename: '/path/to/statedb.sqlite' });
await statedb.initialize();

// Data persists across restarts

Features

• WAL mode enabled by default for better concurrent read performance
• Automatic migrations on initialization
• Transaction support via runAsLambda()
• All 13 state tables: account, asset, token, factory, stake, delegation, rollup, etc.

API

Constructor Options

interface SqliteStateDBOptions {
  filename: string;  // ':memory:' or file path
}

Methods

• initialize() - Run migrations and prepare database
• close() - Close database connection
• runAsLambda(fn) - Execute function within a transaction