@arkade-os/sdk 0.4.0-next.0 → 0.4.0-next.1

package/dist/types/repositories/realm/schemas.d.ts

@@ -0,0 +1,208 @@
+/**
+ * Realm object schemas for the Ark wallet.
+ *
+ * All schema names are prefixed with "Ark" to avoid collisions with
+ * other Realm schemas in the consuming application.
+ *
+ * Since `realm` is a peer dependency (not installed in this package),
+ * schemas are defined as plain JS objects conforming to Realm's
+ * ObjectSchema shape.
+ */
+export declare const ArkVtxoSchema: {
+    readonly name: "ArkVtxo";
+    readonly primaryKey: "pk";
+    readonly properties: {
+        readonly pk: "string";
+        readonly address: {
+            readonly type: "string";
+            readonly indexed: true;
+        };
+        readonly txid: "string";
+        readonly vout: "int";
+        readonly value: "int";
+        readonly tapTree: "string";
+        readonly forfeitCb: "string";
+        readonly forfeitS: "string";
+        readonly intentCb: "string";
+        readonly intentS: "string";
+        readonly extraWitnessJson: "string?";
+        readonly statusJson: "string";
+        readonly virtualStatusJson: "string";
+        readonly spentBy: "string?";
+        readonly settledBy: "string?";
+        readonly arkTxId: "string?";
+        readonly createdAt: "string";
+        readonly isUnrolled: "bool";
+        readonly isSpent: "bool?";
+        readonly assetsJson: "string?";
+    };
+};
+export declare const ArkUtxoSchema: {
+    readonly name: "ArkUtxo";
+    readonly primaryKey: "pk";
+    readonly properties: {
+        readonly pk: "string";
+        readonly address: {
+            readonly type: "string";
+            readonly indexed: true;
+        };
+        readonly txid: "string";
+        readonly vout: "int";
+        readonly value: "int";
+        readonly tapTree: "string";
+        readonly forfeitCb: "string";
+        readonly forfeitS: "string";
+        readonly intentCb: "string";
+        readonly intentS: "string";
+        readonly extraWitnessJson: "string?";
+        readonly statusJson: "string";
+    };
+};
+export declare const ArkTransactionSchema: {
+    readonly name: "ArkTransaction";
+    readonly primaryKey: "pk";
+    readonly properties: {
+        readonly pk: "string";
+        readonly address: {
+            readonly type: "string";
+            readonly indexed: true;
+        };
+        readonly boardingTxid: "string";
+        readonly commitmentTxid: "string";
+        readonly arkTxid: "string";
+        readonly type: "string";
+        readonly amount: "int";
+        readonly settled: "bool";
+        readonly createdAt: "int";
+        readonly assetsJson: "string?";
+    };
+};
+export declare const ArkWalletStateSchema: {
+    readonly name: "ArkWalletState";
+    readonly primaryKey: "key";
+    readonly properties: {
+        readonly key: "string";
+        readonly lastSyncTime: "int?";
+        readonly settingsJson: "string?";
+    };
+};
+export declare const ArkContractSchema: {
+    readonly name: "ArkContract";
+    readonly primaryKey: "script";
+    readonly properties: {
+        readonly script: "string";
+        readonly address: "string";
+        readonly type: {
+            readonly type: "string";
+            readonly indexed: true;
+        };
+        readonly state: {
+            readonly type: "string";
+            readonly indexed: true;
+        };
+        readonly paramsJson: "string";
+        readonly createdAt: "int";
+        readonly expiresAt: "int?";
+        readonly label: "string?";
+        readonly metadataJson: "string?";
+    };
+};
+/**
+ * All Realm schemas needed by the Ark wallet repositories.
+ * Pass this array to your Realm configuration's `schema` property.
+ */
+export declare const ArkRealmSchemas: ({
+    readonly name: "ArkVtxo";
+    readonly primaryKey: "pk";
+    readonly properties: {
+        readonly pk: "string";
+        readonly address: {
+            readonly type: "string";
+            readonly indexed: true;
+        };
+        readonly txid: "string";
+        readonly vout: "int";
+        readonly value: "int";
+        readonly tapTree: "string";
+        readonly forfeitCb: "string";
+        readonly forfeitS: "string";
+        readonly intentCb: "string";
+        readonly intentS: "string";
+        readonly extraWitnessJson: "string?";
+        readonly statusJson: "string";
+        readonly virtualStatusJson: "string";
+        readonly spentBy: "string?";
+        readonly settledBy: "string?";
+        readonly arkTxId: "string?";
+        readonly createdAt: "string";
+        readonly isUnrolled: "bool";
+        readonly isSpent: "bool?";
+        readonly assetsJson: "string?";
+    };
+} | {
+    readonly name: "ArkUtxo";
+    readonly primaryKey: "pk";
+    readonly properties: {
+        readonly pk: "string";
+        readonly address: {
+            readonly type: "string";
+            readonly indexed: true;
+        };
+        readonly txid: "string";
+        readonly vout: "int";
+        readonly value: "int";
+        readonly tapTree: "string";
+        readonly forfeitCb: "string";
+        readonly forfeitS: "string";
+        readonly intentCb: "string";
+        readonly intentS: "string";
+        readonly extraWitnessJson: "string?";
+        readonly statusJson: "string";
+    };
+} | {
+    readonly name: "ArkTransaction";
+    readonly primaryKey: "pk";
+    readonly properties: {
+        readonly pk: "string";
+        readonly address: {
+            readonly type: "string";
+            readonly indexed: true;
+        };
+        readonly boardingTxid: "string";
+        readonly commitmentTxid: "string";
+        readonly arkTxid: "string";
+        readonly type: "string";
+        readonly amount: "int";
+        readonly settled: "bool";
+        readonly createdAt: "int";
+        readonly assetsJson: "string?";
+    };
+} | {
+    readonly name: "ArkWalletState";
+    readonly primaryKey: "key";
+    readonly properties: {
+        readonly key: "string";
+        readonly lastSyncTime: "int?";
+        readonly settingsJson: "string?";
+    };
+} | {
+    readonly name: "ArkContract";
+    readonly primaryKey: "script";
+    readonly properties: {
+        readonly script: "string";
+        readonly address: "string";
+        readonly type: {
+            readonly type: "string";
+            readonly indexed: true;
+        };
+        readonly state: {
+            readonly type: "string";
+            readonly indexed: true;
+        };
+        readonly paramsJson: "string";
+        readonly createdAt: "int";
+        readonly expiresAt: "int?";
+        readonly label: "string?";
+        readonly metadataJson: "string?";
+    };
+})[];

package/dist/types/repositories/realm/types.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Minimal interface for the subset of the Realm API used by the
+ * Ark repositories.  Consumers pass their real Realm instance and
+ * the compiler validates it satisfies this shape.
+ */
+/** Result set returned by `realm.objects()`. */
+export interface RealmResults<T = Record<string, unknown>> extends Iterable<T> {
+    filtered(query: string, ...args: unknown[]): RealmResults<T>;
+}
+/** The Realm API surface used by Ark repositories. */
+export interface RealmLike {
+    write(callback: () => void): void;
+    objects<T = Record<string, unknown>>(schemaName: string): RealmResults<T>;
+    create(schemaName: string, values: Record<string, any>, mode?: string): void;
+    delete(objects: unknown): void;
+}

package/dist/types/repositories/realm/walletRepository.d.ts

@@ -0,0 +1,31 @@
+import { ArkTransaction, ExtendedCoin, ExtendedVirtualCoin } from "../../wallet";
+import { WalletRepository, WalletState } from "../walletRepository";
+import { RealmLike } from "./types";
+/**
+ * Realm-based implementation of WalletRepository.
+ *
+ * Consumers must open Realm with the schemas from `./schemas.ts` and pass
+ * the instance to the constructor.
+ *
+ * Realm handles schema creation on open, so `ensureInit()` is a no-op.
+ * The consumer owns the Realm lifecycle — `[Symbol.asyncDispose]` is a no-op.
+ */
+export declare class RealmWalletRepository implements WalletRepository {
+    private readonly realm;
+    readonly version: 1;
+    constructor(realm: RealmLike);
+    private ensureInit;
+    [Symbol.asyncDispose](): Promise<void>;
+    clear(): Promise<void>;
+    getVtxos(address: string): Promise<ExtendedVirtualCoin[]>;
+    saveVtxos(address: string, vtxos: ExtendedVirtualCoin[]): Promise<void>;
+    deleteVtxos(address: string): Promise<void>;
+    getUtxos(address: string): Promise<ExtendedCoin[]>;
+    saveUtxos(address: string, utxos: ExtendedCoin[]): Promise<void>;
+    deleteUtxos(address: string): Promise<void>;
+    getTransactionHistory(address: string): Promise<ArkTransaction[]>;
+    saveTransactions(address: string, txs: ArkTransaction[]): Promise<void>;
+    deleteTransactions(address: string): Promise<void>;
+    getWalletState(): Promise<WalletState | null>;
+    saveWalletState(state: WalletState): Promise<void>;
+}

package/dist/types/repositories/serialization.d.ts

@@ -0,0 +1,40 @@
+import { TapLeafScript } from "../script/base";
+import { ExtendedCoin, ExtendedVirtualCoin } from "../wallet";
+export type SerializedTapLeaf = {
+    cb: string;
+    s: string;
+};
+export type SerializedVtxo = ReturnType<typeof serializeVtxo>;
+export type SerializedUtxo = ReturnType<typeof serializeUtxo>;
+export declare const serializeTapLeaf: ([cb, s,]: TapLeafScript) => SerializedTapLeaf;
+export declare const serializeVtxo: (v: ExtendedVirtualCoin) => {
+    tapTree: string;
+    forfeitTapLeafScript: SerializedTapLeaf;
+    intentTapLeafScript: SerializedTapLeaf;
+    extraWitness: string[] | undefined;
+    virtualStatus: import("../wallet").VirtualStatus;
+    spentBy?: string;
+    settledBy?: string;
+    arkTxId?: string;
+    createdAt: Date;
+    isUnrolled: boolean;
+    isSpent?: boolean;
+    assets?: import("../wallet").Asset[];
+    value: number;
+    status: import("../wallet").Status;
+    txid: string;
+    vout: number;
+};
+export declare const serializeUtxo: (u: ExtendedCoin) => {
+    tapTree: string;
+    forfeitTapLeafScript: SerializedTapLeaf;
+    intentTapLeafScript: SerializedTapLeaf;
+    extraWitness: string[] | undefined;
+    value: number;
+    status: import("../wallet").Status;
+    txid: string;
+    vout: number;
+};
+export declare const deserializeTapLeaf: (t: SerializedTapLeaf) => TapLeafScript;
+export declare const deserializeVtxo: (o: SerializedVtxo) => ExtendedVirtualCoin;
+export declare const deserializeUtxo: (o: SerializedUtxo) => ExtendedCoin;

package/dist/types/repositories/sqlite/contractRepository.d.ts

@@ -0,0 +1,33 @@
+import { Contract } from "../../contracts/types";
+import { ContractFilter, ContractRepository } from "../contractRepository";
+import { SQLExecutor } from "./types";
+interface SQLiteContractRepositoryOptions {
+    /** Table name prefix (default: "ark_") */
+    prefix?: string;
+}
+/**
+ * SQLite-based implementation of ContractRepository.
+ *
+ * Uses the SQLExecutor interface so consumers can plug in any SQLite driver
+ * (expo-sqlite, better-sqlite3, etc.).
+ *
+ * Tables are created lazily on first operation via `ensureInit()`.
+ * The consumer owns the SQLExecutor lifecycle — `[Symbol.asyncDispose]` is a no-op.
+ */
+export declare class SQLiteContractRepository implements ContractRepository {
+    private readonly db;
+    readonly version: 1;
+    private initPromise;
+    private readonly prefix;
+    private readonly table;
+    constructor(db: SQLExecutor, options?: SQLiteContractRepositoryOptions);
+    private ensureInit;
+    private init;
+    [Symbol.asyncDispose](): Promise<void>;
+    clear(): Promise<void>;
+    getContracts(filter?: ContractFilter): Promise<Contract[]>;
+    saveContract(contract: Contract): Promise<void>;
+    deleteContract(script: string): Promise<void>;
+    private addFilterCondition;
+}
+export {};

package/dist/types/repositories/sqlite/index.d.ts

@@ -0,0 +1,3 @@
+export { SQLiteWalletRepository } from "./walletRepository";
+export { SQLiteContractRepository } from "./contractRepository";
+export type { SQLExecutor } from "./types";

package/dist/types/repositories/sqlite/types.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Minimal SQL execution interface that consumers implement
+ * to connect their SQLite (or any SQL) database to the SDK.
+ *
+ * Example for expo-sqlite:
+ * ```
+ * const executor: SQLExecutor = {
+ *   run: (sql, params) => db.runAsync(sql, params ?? []),
+ *   get: (sql, params) => db.getFirstAsync(sql, params ?? []),
+ *   all: (sql, params) => db.getAllAsync(sql, params ?? []),
+ * };
+ * ```
+ */
+export interface SQLExecutor {
+    run(sql: string, params?: unknown[]): Promise<void>;
+    get<T = Record<string, unknown>>(sql: string, params?: unknown[]): Promise<T | undefined>;
+    all<T = Record<string, unknown>>(sql: string, params?: unknown[]): Promise<T[]>;
+}

package/dist/types/repositories/sqlite/walletRepository.d.ts

@@ -0,0 +1,40 @@
+import { ArkTransaction, ExtendedCoin, ExtendedVirtualCoin } from "../../wallet";
+import { WalletRepository, WalletState } from "../walletRepository";
+import { SQLExecutor } from "./types";
+interface SQLiteWalletRepositoryOptions {
+    /** Table name prefix (default: "ark_") */
+    prefix?: string;
+}
+/**
+ * SQLite-based implementation of WalletRepository.
+ *
+ * Uses the SQLExecutor interface so consumers can plug in any SQLite driver
+ * (expo-sqlite, better-sqlite3, etc.).
+ *
+ * Tables are created lazily on first operation via `ensureInit()`.
+ * The consumer owns the SQLExecutor lifecycle — `[Symbol.asyncDispose]` is a no-op.
+ */
+export declare class SQLiteWalletRepository implements WalletRepository {
+    private readonly db;
+    readonly version: 1;
+    private initPromise;
+    private readonly prefix;
+    private readonly tables;
+    constructor(db: SQLExecutor, options?: SQLiteWalletRepositoryOptions);
+    private ensureInit;
+    private init;
+    [Symbol.asyncDispose](): Promise<void>;
+    clear(): Promise<void>;
+    getVtxos(address: string): Promise<ExtendedVirtualCoin[]>;
+    saveVtxos(address: string, vtxos: ExtendedVirtualCoin[]): Promise<void>;
+    deleteVtxos(address: string): Promise<void>;
+    getUtxos(address: string): Promise<ExtendedCoin[]>;
+    saveUtxos(address: string, utxos: ExtendedCoin[]): Promise<void>;
+    deleteUtxos(address: string): Promise<void>;
+    getTransactionHistory(address: string): Promise<ArkTransaction[]>;
+    saveTransactions(address: string, txs: ArkTransaction[]): Promise<void>;
+    deleteTransactions(address: string): Promise<void>;
+    getWalletState(): Promise<WalletState | null>;
+    saveWalletState(state: WalletState): Promise<void>;
+}
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arkade-os/sdk",
-  "version": "0.4.0-next.0",
+  "version": "0.4.0-next.1",
   "description": "Bitcoin wallet SDK with Taproot and Ark integration",
   "type": "module",
   "main": "./dist/cjs/index.js",
@@ -23,12 +23,6 @@
       "require": "./dist/cjs/adapters/expo.js",
       "default": "./dist/esm/adapters/expo.js"
     },
-    "./adapters/expo-db": {
-      "types": "./dist/types/adapters/expo-db.d.ts",
-      "import": "./dist/esm/adapters/expo-db.js",
-      "require": "./dist/cjs/adapters/expo-db.js",
-      "default": "./dist/esm/adapters/expo-db.js"
-    },
     "./adapters/localStorage": {
       "types": "./dist/types/adapters/localStorage.d.ts",
       "import": "./dist/esm/adapters/localStorage.js",
@@ -53,6 +47,18 @@
       "require": "./dist/cjs/adapters/asyncStorage.js",
       "default": "./dist/esm/adapters/asyncStorage.js"
     },
+    "./repositories/sqlite": {
+      "types": "./dist/types/repositories/sqlite/index.d.ts",
+      "import": "./dist/esm/repositories/sqlite/index.js",
+      "require": "./dist/cjs/repositories/sqlite/index.js",
+      "default": "./dist/esm/repositories/sqlite/index.js"
+    },
+    "./repositories/realm": {
+      "types": "./dist/types/repositories/realm/index.d.ts",
+      "import": "./dist/esm/repositories/realm/index.js",
+      "require": "./dist/cjs/repositories/realm/index.js",
+      "default": "./dist/esm/repositories/realm/index.js"
+    },
     "./worker/expo": {
       "types": "./dist/types/worker/expo/index.d.ts",
       "import": "./dist/esm/worker/expo/index.js",
@@ -85,8 +91,10 @@
     "bip68": "1.0.4"
   },
   "devDependencies": {
+    "@types/better-sqlite3": "7.6.13",
     "@types/node": "24.3.1",
     "@vitest/coverage-v8": "3.2.4",
+    "better-sqlite3": "12.6.2",
     "esbuild": "^0.27.3",
     "eventsource": "4.0.0",
     "glob": "11.1.0",
@@ -99,17 +107,13 @@
     "vitest": "3.2.4"
   },
   "peerDependencies": {
-    "indexeddbshim": ">=16.0.0",
+    "@react-native-async-storage/async-storage": ">=1.0.0",
     "expo": ">=54.0.0",
-    "expo-sqlite": "~16.0.10",
     "expo-background-task": "~1.0.10",
-    "expo-task-manager": "~14.0.9",
-    "@react-native-async-storage/async-storage": ">=1.0.0"
+    "expo-sqlite": "~16.0.10",
+    "expo-task-manager": "~14.0.9"
   },
   "peerDependenciesMeta": {
-    "indexeddbshim": {
-      "optional": true
-    },
     "expo": {
       "optional": true
     },

package/dist/cjs/adapters/expo-db.js

@@ -1,35 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.openDatabase = void 0;
-exports.setupExpoDb = setupExpoDb;
-// Expo IndexedDB polyfill — requires expo-sqlite and indexeddbshim.
-//
-// Separated from ./expo so that consumers who only need the streaming
-// providers (ExpoArkProvider, ExpoIndexerProvider) don't pull in a
-// hard dependency on expo-sqlite at bundle time.
-const indexeddbshim_1 = __importDefault(require("indexeddbshim"));
-const websqlAdapter_1 = require("../repositories/indexedDB/websqlAdapter");
-var websqlAdapter_2 = require("../repositories/indexedDB/websqlAdapter");
-Object.defineProperty(exports, "openDatabase", { enumerable: true, get: function () { return websqlAdapter_2.openDatabase; } });
-let _initialized = false;
-function setupExpoDb(options) {
-    if (_initialized)
-        return;
-    const { origin = "expo://localhost", checkOrigin = false, cacheDatabaseInstances = true, } = options ?? {};
-    if (typeof globalThis.window === "undefined") {
-        globalThis.window = globalThis;
-    }
-    if (typeof globalThis.location === "undefined") {
-        globalThis.location = { origin };
-    }
-    globalThis.openDatabase = websqlAdapter_1.openDatabase;
-    (0, indexeddbshim_1.default)(globalThis, {
-        checkOrigin,
-        useSQLiteIndexes: true,
-        cacheDatabaseInstances,
-    });
-    _initialized = true;
-}

package/dist/esm/adapters/expo-db.js

@@ -1,27 +0,0 @@
-// Expo IndexedDB polyfill — requires expo-sqlite and indexeddbshim.
-//
-// Separated from ./expo so that consumers who only need the streaming
-// providers (ExpoArkProvider, ExpoIndexerProvider) don't pull in a
-// hard dependency on expo-sqlite at bundle time.
-import setGlobalVars from "indexeddbshim";
-import { openDatabase } from '../repositories/indexedDB/websqlAdapter.js';
-export { openDatabase } from '../repositories/indexedDB/websqlAdapter.js';
-let _initialized = false;
-export function setupExpoDb(options) {
-    if (_initialized)
-        return;
-    const { origin = "expo://localhost", checkOrigin = false, cacheDatabaseInstances = true, } = options ?? {};
-    if (typeof globalThis.window === "undefined") {
-        globalThis.window = globalThis;
-    }
-    if (typeof globalThis.location === "undefined") {
-        globalThis.location = { origin };
-    }
-    globalThis.openDatabase = openDatabase;
-    setGlobalVars(globalThis, {
-        checkOrigin,
-        useSQLiteIndexes: true,
-        cacheDatabaseInstances,
-    });
-    _initialized = true;
-}

package/dist/types/adapters/expo-db.d.ts

@@ -1,7 +0,0 @@
-export { openDatabase } from "../repositories/indexedDB/websqlAdapter";
-export interface SetupExpoDbOptions {
-    origin?: string;
-    checkOrigin?: boolean;
-    cacheDatabaseInstances?: boolean;
-}
-export declare function setupExpoDb(options?: SetupExpoDbOptions): void;