@arkade-os/sdk 0.4.26 → 0.4.28

package/dist/esm/repositories/sqlite/walletRepository.js

@@ -1,437 +0,0 @@
-import { serializeVtxo, serializeUtxo, deserializeVtxo, deserializeUtxo, serializeAssets, deserializeAssets, } from "../serialization.js";
-import { scriptFromArkAddress } from "../scriptFromAddress.js";
-import { isVtxoForScript } from "../../contracts/vtxoOwnership.js";
-/**
- * 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 class SQLiteWalletRepository {
-    constructor(db, options) {
-        this.db = db;
-        this.version = 1;
-        this.initPromise = null;
-        this.prefix = sanitizePrefix(options?.prefix ?? "ark_");
-        this.tables = {
-            vtxos: `${this.prefix}vtxos`,
-            utxos: `${this.prefix}utxos`,
-            transactions: `${this.prefix}transactions`,
-            walletState: `${this.prefix}wallet_state`,
-        };
-    }
-    // ── Lifecycle ──────────────────────────────────────────────────────
-    ensureInit() {
-        if (!this.initPromise) {
-            this.initPromise = this.init();
-        }
-        return this.initPromise;
-    }
-    async init() {
-        await this.migrateVtxosTable();
-        await this.db.run(`
-            CREATE TABLE IF NOT EXISTS ${this.tables.utxos} (
-                txid TEXT NOT NULL,
-                vout INTEGER NOT NULL,
-                value INTEGER NOT NULL,
-                address TEXT NOT NULL,
-                tap_tree TEXT NOT NULL,
-                forfeit_cb TEXT NOT NULL,
-                forfeit_s TEXT NOT NULL,
-                intent_cb TEXT NOT NULL,
-                intent_s TEXT NOT NULL,
-                status_json TEXT NOT NULL,
-                extra_witness_json TEXT,
-                PRIMARY KEY (txid, vout)
-            )
-        `);
-        await this.db.run(`
-            CREATE TABLE IF NOT EXISTS ${this.tables.transactions} (
-                address TEXT NOT NULL,
-                boarding_txid TEXT NOT NULL,
-                commitment_txid TEXT NOT NULL,
-                ark_txid TEXT NOT NULL,
-                type TEXT NOT NULL,
-                amount INTEGER NOT NULL,
-                settled INTEGER NOT NULL DEFAULT 0,
-                created_at INTEGER NOT NULL,
-                assets_json TEXT,
-                PRIMARY KEY (address, boarding_txid, commitment_txid, ark_txid)
-            )
-        `);
-        await this.db.run(`
-            CREATE TABLE IF NOT EXISTS ${this.tables.walletState} (
-                key TEXT PRIMARY KEY,
-                settings_json TEXT,
-                last_sync_time INTEGER
-            )
-        `);
-        await this.db.run(`CREATE INDEX IF NOT EXISTS idx_${this.prefix}vtxos_address ON ${this.tables.vtxos} (address)`);
-        await this.db.run(`CREATE INDEX IF NOT EXISTS idx_${this.prefix}vtxos_script ON ${this.tables.vtxos} (script)`);
-        await this.db.run(`CREATE INDEX IF NOT EXISTS idx_${this.prefix}utxos_address ON ${this.tables.utxos} (address)`);
-        await this.db.run(`CREATE INDEX IF NOT EXISTS idx_${this.prefix}transactions_address ON ${this.tables.transactions} (address)`);
-    }
-    /**
-     * Bring the `vtxos` table to the current schema (v1 = `script` NOT NULL).
-     *
-     * Three cases:
-     *   - Fresh install: create the v1 schema directly.
-     *   - Legacy install without a `script` column: add it, backfill from
-     *     `address`, then rebuild the table with NOT NULL (SQLite cannot add
-     *     the NOT NULL constraint in place).
-     *   - Legacy install with a nullable `script` column: backfill the NULLs
-     *     and rebuild.
-     *
-     * The backfill derives `script` from the Ark address, matching what the
-     * indexer would have returned — new rows from the indexer always carry a
-     * populated `script`, so the migration is idempotent.
-     *
-     * The rebuild path is wrapped in a transaction: without it, a crash
-     * between the `DROP TABLE vtxos` and the `RENAME tmp → vtxos` commits
-     * would leave the next startup seeing no `vtxos` table and create a
-     * fresh empty one, silently orphaning every row in the temp table.
-     */
-    async migrateVtxosTable() {
-        const tableExists = await this.db.get(`SELECT name FROM sqlite_master WHERE type='table' AND name=?`, [this.tables.vtxos]);
-        if (!tableExists) {
-            await this.db.run(this.vtxosCreateSql(this.tables.vtxos));
-            return;
-        }
-        const cols = await this.db.all(`PRAGMA table_info(${this.tables.vtxos})`);
-        const scriptCol = cols.find((c) => c.name === "script");
-        if (scriptCol && scriptCol.notnull === 1) {
-            // Already on v1 schema.
-            return;
-        }
-        await this.db.run("BEGIN IMMEDIATE");
-        try {
-            if (!scriptCol) {
-                await this.db.run(`ALTER TABLE ${this.tables.vtxos} ADD COLUMN script TEXT`);
-            }
-            // Backfill any NULL scripts from the owning address. Derivation
-            // is deterministic, so re-running after a rolled-back attempt
-            // produces the same values.
-            const nullRows = await this.db.all(`SELECT txid, vout, address FROM ${this.tables.vtxos} WHERE script IS NULL`);
-            for (const row of nullRows) {
-                await this.db.run(`UPDATE ${this.tables.vtxos} SET script = ? WHERE txid = ? AND vout = ?`, [scriptFromArkAddress(row.address), row.txid, row.vout]);
-            }
-            // SQLite can't turn a nullable column into NOT NULL in place —
-            // do the canonical 12-step table rebuild. Drop any stale temp
-            // table from a prior aborted attempt first.
-            const tempName = `${this.tables.vtxos}__migrate_tmp`;
-            await this.db.run(`DROP TABLE IF EXISTS ${tempName}`);
-            await this.db.run(this.vtxosCreateSql(tempName));
-            await this.db.run(`
-                INSERT INTO ${tempName}
-                    (txid, vout, value, address, tap_tree,
-                     forfeit_cb, forfeit_s, intent_cb, intent_s,
-                     status_json, virtual_status_json, created_at,
-                     is_unrolled, is_spent, spent_by, settled_by, ark_tx_id,
-                     extra_witness_json, assets_json, script)
-                SELECT txid, vout, value, address, tap_tree,
-                       forfeit_cb, forfeit_s, intent_cb, intent_s,
-                       status_json, virtual_status_json, created_at,
-                       is_unrolled, is_spent, spent_by, settled_by, ark_tx_id,
-                       extra_witness_json, assets_json, script
-                FROM ${this.tables.vtxos}
-            `);
-            await this.db.run(`DROP TABLE ${this.tables.vtxos}`);
-            await this.db.run(`ALTER TABLE ${tempName} RENAME TO ${this.tables.vtxos}`);
-            await this.db.run("COMMIT");
-        }
-        catch (e) {
-            // A failed COMMIT auto-rolls-back in SQLite, which makes a
-            // follow-up ROLLBACK throw "no transaction is active". Swallow
-            // that secondary error so the original cause surfaces.
-            try {
-                await this.db.run("ROLLBACK");
-            }
-            catch {
-                // already rolled back
-            }
-            throw e;
-        }
-    }
-    vtxosCreateSql(tableName) {
-        return `CREATE TABLE ${tableName} (
-            txid TEXT NOT NULL,
-            vout INTEGER NOT NULL,
-            value INTEGER NOT NULL,
-            address TEXT NOT NULL,
-            tap_tree TEXT NOT NULL,
-            forfeit_cb TEXT NOT NULL,
-            forfeit_s TEXT NOT NULL,
-            intent_cb TEXT NOT NULL,
-            intent_s TEXT NOT NULL,
-            status_json TEXT NOT NULL,
-            virtual_status_json TEXT NOT NULL,
-            created_at TEXT NOT NULL,
-            is_unrolled INTEGER NOT NULL DEFAULT 0,
-            is_spent INTEGER,
-            spent_by TEXT,
-            settled_by TEXT,
-            ark_tx_id TEXT,
-            extra_witness_json TEXT,
-            assets_json TEXT,
-            script TEXT NOT NULL,
-            PRIMARY KEY (txid, vout)
-        )`;
-    }
-    async [Symbol.asyncDispose]() {
-        // no-op — consumer owns the SQLExecutor lifecycle
-    }
-    // ── Clear ──────────────────────────────────────────────────────────
-    async clear() {
-        await this.ensureInit();
-        await this.db.run(`DELETE FROM ${this.tables.vtxos}`);
-        await this.db.run(`DELETE FROM ${this.tables.utxos}`);
-        await this.db.run(`DELETE FROM ${this.tables.transactions}`);
-        await this.db.run(`DELETE FROM ${this.tables.walletState}`);
-    }
-    // ── VTXO management ────────────────────────────────────────────────
-    async getVtxos(address) {
-        await this.ensureInit();
-        const rows = await this.db.all(`SELECT * FROM ${this.tables.vtxos} WHERE address = ?`, [address]);
-        return rows.map(vtxoRowToDomain);
-    }
-    async saveVtxos(address, vtxos) {
-        await this.ensureInit();
-        for (const vtxo of vtxos) {
-            const s = serializeVtxo(vtxo);
-            await this.db.run(`INSERT OR REPLACE INTO ${this.tables.vtxos}
-                    (txid, vout, value, address,
-                     tap_tree, forfeit_cb, forfeit_s, intent_cb, intent_s,
-                     status_json, virtual_status_json, created_at,
-                     is_unrolled, is_spent, spent_by, settled_by, ark_tx_id,
-                     extra_witness_json, assets_json, script)
-                 VALUES (?, ?, ?, ?,
-                         ?, ?, ?, ?, ?,
-                         ?, ?, ?,
-                         ?, ?, ?, ?, ?,
-                         ?, ?, ?)`, [
-                s.txid,
-                s.vout,
-                s.value,
-                address,
-                s.tapTree,
-                s.forfeitTapLeafScript.cb,
-                s.forfeitTapLeafScript.s,
-                s.intentTapLeafScript.cb,
-                s.intentTapLeafScript.s,
-                JSON.stringify(s.status),
-                JSON.stringify(s.virtualStatus),
-                typeof s.createdAt === "string"
-                    ? s.createdAt
-                    : s.createdAt instanceof Date
-                        ? s.createdAt.toISOString()
-                        : new Date(s.createdAt).toISOString(),
-                s.isUnrolled ? 1 : 0,
-                s.isSpent === undefined ? null : s.isSpent ? 1 : 0,
-                s.spentBy ?? null,
-                s.settledBy ?? null,
-                s.arkTxId ?? null,
-                s.extraWitness ? JSON.stringify(s.extraWitness) : null,
-                s.assets ? JSON.stringify(s.assets) : null,
-                s.script ?? null,
-            ]);
-        }
-    }
-    async deleteVtxos(address) {
-        await this.ensureInit();
-        await this.db.run(`DELETE FROM ${this.tables.vtxos} WHERE address = ?`, [address]);
-    }
-    async getVtxosForScript(script) {
-        await this.ensureInit();
-        const rows = await this.db.all(`SELECT * FROM ${this.tables.vtxos} WHERE script = ?`, [script]);
-        return rows.map(vtxoRowToDomain);
-    }
-    async saveVtxosForScript(key, vtxos) {
-        if (!key.address) {
-            throw new Error("SQLiteWalletRepository requires an address");
-        }
-        for (const vtxo of vtxos) {
-            if (!isVtxoForScript(vtxo, key.script)) {
-                throw new Error(`VTXO ${vtxo.txid}:${vtxo.vout} script mismatch: expected ${key.script}, got ${vtxo.script}`);
-            }
-        }
-        return this.saveVtxos(key.address, vtxos);
-    }
-    async deleteVtxosForScript(script) {
-        await this.ensureInit();
-        await this.db.run(`DELETE FROM ${this.tables.vtxos} WHERE script = ?`, [
-            script,
-        ]);
-    }
-    // ── UTXO management ────────────────────────────────────────────────
-    async getUtxos(address) {
-        await this.ensureInit();
-        const rows = await this.db.all(`SELECT * FROM ${this.tables.utxos} WHERE address = ?`, [address]);
-        return rows.map(utxoRowToDomain);
-    }
-    async saveUtxos(address, utxos) {
-        await this.ensureInit();
-        for (const utxo of utxos) {
-            const s = serializeUtxo(utxo);
-            await this.db.run(`INSERT OR REPLACE INTO ${this.tables.utxos}
-                    (txid, vout, value, address,
-                     tap_tree, forfeit_cb, forfeit_s, intent_cb, intent_s,
-                     status_json, extra_witness_json)
-                 VALUES (?, ?, ?, ?,
-                         ?, ?, ?, ?, ?,
-                         ?, ?)`, [
-                s.txid,
-                s.vout,
-                s.value,
-                address,
-                s.tapTree,
-                s.forfeitTapLeafScript.cb,
-                s.forfeitTapLeafScript.s,
-                s.intentTapLeafScript.cb,
-                s.intentTapLeafScript.s,
-                JSON.stringify(s.status),
-                s.extraWitness ? JSON.stringify(s.extraWitness) : null,
-            ]);
-        }
-    }
-    async deleteUtxos(address) {
-        await this.ensureInit();
-        await this.db.run(`DELETE FROM ${this.tables.utxos} WHERE address = ?`, [address]);
-    }
-    // ── Transaction history ────────────────────────────────────────────
-    async getTransactionHistory(address) {
-        await this.ensureInit();
-        const rows = await this.db.all(`SELECT * FROM ${this.tables.transactions} WHERE address = ? ORDER BY created_at ASC`, [address]);
-        return rows.map(txRowToDomain);
-    }
-    async saveTransactions(address, txs) {
-        await this.ensureInit();
-        for (const tx of txs) {
-            await this.db.run(`INSERT OR REPLACE INTO ${this.tables.transactions}
-                    (address, boarding_txid, commitment_txid, ark_txid,
-                     type, amount, settled, created_at, assets_json)
-                 VALUES (?, ?, ?, ?,
-                         ?, ?, ?, ?, ?)`, [
-                address,
-                tx.key.boardingTxid,
-                tx.key.commitmentTxid,
-                tx.key.arkTxid,
-                tx.type,
-                tx.amount,
-                tx.settled ? 1 : 0,
-                tx.createdAt,
-                tx.assets
-                    ? JSON.stringify(serializeAssets(tx.assets))
-                    : null,
-            ]);
-        }
-    }
-    async deleteTransactions(address) {
-        await this.ensureInit();
-        await this.db.run(`DELETE FROM ${this.tables.transactions} WHERE address = ?`, [address]);
-    }
-    // ── Wallet state ───────────────────────────────────────────────────
-    async getWalletState() {
-        await this.ensureInit();
-        const row = await this.db.get(`SELECT * FROM ${this.tables.walletState} WHERE key = ?`, ["state"]);
-        if (!row)
-            return null;
-        const state = {};
-        if (row.settings_json) {
-            state.settings = JSON.parse(row.settings_json);
-        }
-        state.lastSyncTime = row.last_sync_time ?? undefined;
-        return state;
-    }
-    async saveWalletState(state) {
-        await this.ensureInit();
-        await this.db.run(`INSERT OR REPLACE INTO ${this.tables.walletState}
-                (key, settings_json, last_sync_time)
-             VALUES (?, ?, ?)`, [
-            "state",
-            state.settings ? JSON.stringify(state.settings) : null,
-            state.lastSyncTime ?? null,
-        ]);
-    }
-}
-const SAFE_PREFIX = /^[a-zA-Z0-9_]+$/;
-function sanitizePrefix(prefix) {
-    if (!SAFE_PREFIX.test(prefix)) {
-        throw new Error(`Invalid table prefix "${prefix}": only letters, digits, and underscores are allowed`);
-    }
-    return prefix;
-}
-// ── Row → Domain converters ────────────────────────────────────────────
-function vtxoRowToDomain(row) {
-    const serialized = {
-        txid: row.txid,
-        vout: row.vout,
-        value: row.value,
-        tapTree: row.tap_tree,
-        forfeitTapLeafScript: {
-            cb: row.forfeit_cb,
-            s: row.forfeit_s,
-        },
-        intentTapLeafScript: {
-            cb: row.intent_cb,
-            s: row.intent_s,
-        },
-        status: JSON.parse(row.status_json),
-        virtualStatus: JSON.parse(row.virtual_status_json),
-        createdAt: new Date(row.created_at),
-        isUnrolled: row.is_unrolled === 1,
-        isSpent: row.is_spent === null ? undefined : row.is_spent === 1,
-        spentBy: row.spent_by ?? undefined,
-        settledBy: row.settled_by ?? undefined,
-        arkTxId: row.ark_tx_id ?? undefined,
-        extraWitness: row.extra_witness_json
-            ? JSON.parse(row.extra_witness_json)
-            : undefined,
-        assets: row.assets_json ? JSON.parse(row.assets_json) : undefined,
-        // Post-migration every row has `script`, but the backfill is
-        // idempotent: derive from `address` if the legacy column is still
-        // null (e.g. the migration hasn't run yet on this handle).
-        script: row.script ?? scriptFromArkAddress(row.address),
-    };
-    return deserializeVtxo(serialized);
-}
-function utxoRowToDomain(row) {
-    const serialized = {
-        txid: row.txid,
-        vout: row.vout,
-        value: row.value,
-        tapTree: row.tap_tree,
-        forfeitTapLeafScript: {
-            cb: row.forfeit_cb,
-            s: row.forfeit_s,
-        },
-        intentTapLeafScript: {
-            cb: row.intent_cb,
-            s: row.intent_s,
-        },
-        status: JSON.parse(row.status_json),
-        extraWitness: row.extra_witness_json
-            ? JSON.parse(row.extra_witness_json)
-            : undefined,
-    };
-    return deserializeUtxo(serialized);
-}
-function txRowToDomain(row) {
-    const tx = {
-        key: {
-            boardingTxid: row.boarding_txid,
-            commitmentTxid: row.commitment_txid,
-            arkTxid: row.ark_txid,
-        },
-        type: row.type,
-        amount: row.amount,
-        settled: row.settled === 1,
-        createdAt: row.created_at,
-    };
-    if (row.assets_json) {
-        tx.assets = deserializeAssets(JSON.parse(row.assets_json));
-    }
-    return tx;
-}

package/dist/esm/repositories/walletRepository.js

@@ -1 +0,0 @@
-export {};

package/dist/esm/script/address.js

@@ -1,104 +0,0 @@
-import { bech32m } from "@scure/base";
-import { Script } from "@scure/btc-signer/script.js";
-import { DEFAULT_ARKADE_HRP } from "../wallet/index.js";
-/**
- * ArkAddress allows creating and decoding bech32m-encoded Arkade addresses.
- *
- * An Arkade address is composed of:
- * - a human readable prefix (hrp)
- * - a version byte (1 byte)
- * - a server public key (32 bytes)
- * - a vtxo taproot public key (32 bytes)
- *
- * @remarks
- * This is an Arkade-specific address format.
- * It is distinct from the Taproot onchain address returned by `VtxoScript.onchainAddress`.
- *
- * @see VtxoScript
- *
- * @example
- * ```typescript
- * const address = new ArkAddress(
- *     new Uint8Array(32), // server public key
- *     new Uint8Array(32), // vtxo taproot public key
- *     "ark"
- * );
- *
- * const encoded = address.encode();
- * console.log("address: ", encoded);
- *
- * const decoded = ArkAddress.decode(encoded);
- * ```
- */
-export class ArkAddress {
-    /**
-     * Create an Arkade address from its server public key, Taproot output key, and prefix.
-     *
-     * @param serverPubKey - 32-byte Arkade server public key
-     * @param vtxoTaprootKey - 32-byte Taproot output key (a.k.a. tweaked public key)
-     * @param hrp - Bech32 human-readable prefix
-     * @param version - Address version byte
-     * @defaultValue `version = 0`
-     * @throws Error if either public key is not 32 bytes long
-     */
-    constructor(serverPubKey, vtxoTaprootKey, hrp = DEFAULT_ARKADE_HRP, version = 0) {
-        this.serverPubKey = serverPubKey;
-        this.vtxoTaprootKey = vtxoTaprootKey;
-        this.hrp = hrp;
-        this.version = version;
-        if (serverPubKey.length !== 32) {
-            throw new Error("Invalid server public key length, expected 32 bytes, got " +
-                serverPubKey.length);
-        }
-        if (vtxoTaprootKey.length !== 32) {
-            throw new Error("Invalid vtxo taproot public key length, expected 32 bytes, got " +
-                vtxoTaprootKey.length);
-        }
-    }
-    /**
-     * Decode an Arkade address from its bech32m string form.
-     *
-     * @param address - Bech32m-encoded Arkade address
-     * @returns Decoded Arkade address
-     * @throws Error if the address is malformed or has an invalid payload length
-     * @see encode
-     */
-    static decode(address) {
-        const decoded = bech32m.decodeUnsafe(address, 1023);
-        if (!decoded) {
-            throw new Error("Invalid address");
-        }
-        const data = new Uint8Array(bech32m.fromWords(decoded.words));
-        // First the version byte, then 32 bytes server pubkey, then 32 bytes vtxo taproot public key.
-        if (data.length !== 1 + 32 + 32) {
-            throw new Error("Invalid data length, expected 65 bytes, got " + data.length);
-        }
-        const version = data[0];
-        const serverPubKey = data.slice(1, 33);
-        const vtxoTaprootPubKey = data.slice(33, 65);
-        return new ArkAddress(serverPubKey, vtxoTaprootPubKey, decoded.prefix, version);
-    }
-    /**
-     * Encode the address to its bech32m string form.
-     *
-     * @returns Bech32m-encoded Arkade address
-     * @see decode
-     */
-    encode() {
-        // Combine version byte, server pubkey, and vtxo taproot public key.
-        const data = new Uint8Array(1 + 32 + 32);
-        data[0] = this.version;
-        data.set(this.serverPubKey, 1);
-        data.set(this.vtxoTaprootKey, 33);
-        const words = bech32m.toWords(data);
-        return bech32m.encode(this.hrp, words, 1023);
-    }
-    /** ScriptPubKey used to send non-dust funds to the address. */
-    get pkScript() {
-        return Script.encode(["OP_1", this.vtxoTaprootKey]);
-    }
-    /** ScriptPubKey used to send sub-dust funds to the address. */
-    get subdustPkScript() {
-        return Script.encode(["RETURN", this.vtxoTaprootKey]);
-    }
-}