@arkade-os/sdk 0.4.27 → 0.4.28

package/dist/types/repositories/indexedDB/websqlAdapter.d.ts

@@ -1,49 +0,0 @@
-/**
- * WebSQL adapter over expo-sqlite.
- *
- * Bridges the WebSQL API surface that indexeddbshim expects to the
- * synchronous expo-sqlite driver.  Only the subset actually called by
- * the shim is implemented:
- *
- *   openDatabase(name, version, displayName, estimatedSize) → WebSQLDatabase
- *   db.transaction(cb, errCb?, successCb?)
- *   tx.executeSql(sql, args?, successCb?, errorCb?)
- *   resultSet = { insertId, rowsAffected, rows: { length, item(i) } }
- */
-import { type SQLiteDatabase } from "expo-sqlite";
-export interface SQLResultSetRowList {
-    length: number;
-    item(index: number): any;
-}
-export interface SQLResultSet {
-    insertId: number;
-    rowsAffected: number;
-    rows: SQLResultSetRowList;
-}
-export interface SQLError {
-    code: number;
-    message: string;
-}
-type ExecuteSqlSuccessCb = (tx: WebSQLTransaction, resultSet: SQLResultSet) => void;
-type ExecuteSqlErrorCb = (tx: WebSQLTransaction, error: SQLError) => boolean | void;
-interface QueuedStatement {
-    sql: string;
-    args: any[];
-    successCb?: ExecuteSqlSuccessCb;
-    errorCb?: ExecuteSqlErrorCb;
-}
-export declare class WebSQLTransaction {
-    /** @internal */
-    _queue: QueuedStatement[];
-    executeSql(sql: string, args?: any[], successCb?: ExecuteSqlSuccessCb, errorCb?: ExecuteSqlErrorCb): void;
-}
-export declare class WebSQLDatabase {
-    /** @internal */
-    _db: SQLiteDatabase;
-    version: string;
-    constructor(db: SQLiteDatabase, version: string);
-    transaction(callback: (tx: WebSQLTransaction) => void, errorCb?: (error: SQLError) => void, successCb?: () => void): void;
-    readTransaction(callback: (tx: WebSQLTransaction) => void, errorCb?: (error: SQLError) => void, successCb?: () => void): void;
-}
-export declare function openDatabase(name: string, version: string, _displayName: string, _estimatedSize: number, _creationCallback?: (db: WebSQLDatabase) => void): WebSQLDatabase;
-export {};

package/dist/types/repositories/migrations/contractRepositoryImpl.d.ts

@@ -1,24 +0,0 @@
-import { StorageAdapter } from "../../storage/index.js";
-import { ContractFilter, ContractRepository } from "../contractRepository.js";
-import { Contract } from "../../contracts/types.js";
-export declare const getContractStorageKey: (id: string, key: string) => string;
-export declare const getCollectionStorageKey: (type: string) => string;
-/**
- * @deprecated This is only to be used in migration from storage V1
- */
-export declare class ContractRepositoryImpl implements ContractRepository {
-    readonly version: 1;
-    private storage;
-    constructor(storage: StorageAdapter);
-    getContractData<T>(contractId: string, key: string): Promise<T | null>;
-    setContractData<T>(contractId: string, key: string, data: T): Promise<void>;
-    deleteContractData(contractId: string, key: string): Promise<void>;
-    getContractCollection<T>(contractType: string): Promise<ReadonlyArray<T>>;
-    saveToContractCollection<T, K extends keyof T>(contractType: string, item: T, idField: K): Promise<void>;
-    removeFromContractCollection<T, K extends keyof T>(contractType: string, id: T[K], idField: K): Promise<void>;
-    getContracts(_?: ContractFilter): Promise<Contract[]>;
-    saveContract(_: Contract): Promise<void>;
-    deleteContract(_: string): Promise<void>;
-    clear(): Promise<void>;
-    [Symbol.asyncDispose](): Promise<void>;
-}

package/dist/types/repositories/migrations/fromStorageAdapter.d.ts

@@ -1,19 +0,0 @@
-import { StorageAdapter } from "../../storage/index.js";
-import { WalletRepository } from "../walletRepository.js";
-export declare const MIGRATION_KEY: (repoType: "wallet" | "contract") => string;
-export type MigrationStatus = "pending" | "in-progress" | "done" | "not-needed";
-export declare function getMigrationStatus(repoType: "wallet" | "contract", storageAdapter: StorageAdapter): Promise<MigrationStatus>;
-export declare function requiresMigration(repoType: "wallet" | "contract", storageAdapter: StorageAdapter): Promise<boolean>;
-export declare function rollbackMigration(repoType: "wallet" | "contract", storageAdapter: StorageAdapter): Promise<void>;
-/**
- * Migrate wallet data from the legacy storage adapter to the new one.
- * It accepts both onchain and offchain addresses, make sure to pass both.
- *
- * @param storageAdapter
- * @param fresh
- * @param addresses
- */
-export declare function migrateWalletRepository(storageAdapter: StorageAdapter, fresh: WalletRepository, addresses: {
-    onchain: string[];
-    offchain: string[];
-}): Promise<void>;

package/dist/types/repositories/migrations/walletRepositoryImpl.d.ts

@@ -1,27 +0,0 @@
-import { WalletRepository, WalletState } from "../walletRepository.js";
-import { StorageAdapter } from "../../storage/index.js";
-import { ArkTransaction, ExtendedCoin, ExtendedVirtualCoin } from "../../wallet/index.js";
-/**
- * @deprecated This is only to be used in migration from storage V1
- */
-export declare class WalletRepositoryImpl implements WalletRepository {
-    readonly version: 1;
-    private storage;
-    constructor(storage: StorageAdapter);
-    getVtxos(address: string): Promise<ExtendedVirtualCoin[]>;
-    saveVtxos(address: string, vtxos: ExtendedVirtualCoin[]): Promise<void>;
-    clearVtxos(address: string): Promise<void>;
-    deleteVtxos(address: string): Promise<void>;
-    getUtxos(address: string): Promise<ExtendedCoin[]>;
-    saveUtxos(address: string, utxos: ExtendedCoin[]): Promise<void>;
-    clearUtxos(address: string): Promise<void>;
-    deleteUtxos(address: string): Promise<void>;
-    getTransactionHistory(address: string): Promise<ArkTransaction[]>;
-    saveTransactions(address: string, txs: ArkTransaction[]): Promise<void>;
-    clearTransactions(address: string): Promise<void>;
-    deleteTransactions(address: string): Promise<void>;
-    getWalletState(): Promise<WalletState | null>;
-    saveWalletState(state: WalletState): Promise<void>;
-    clear(): Promise<void>;
-    [Symbol.asyncDispose](): Promise<void>;
-}

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

@@ -1,24 +0,0 @@
-import { Contract } from "../../contracts/types.js";
-import { ContractFilter, ContractRepository } from "../contractRepository.js";
-import { RealmLike } from "./types.js";
-/**
- * Realm-based implementation of ContractRepository.
- *
- * 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 RealmContractRepository implements ContractRepository {
-    private readonly realm;
-    readonly version: 1;
-    constructor(realm: RealmLike);
-    private ensureInit;
-    [Symbol.asyncDispose](): Promise<void>;
-    clear(): Promise<void>;
-    getContracts(filter?: ContractFilter): Promise<Contract[]>;
-    saveContract(contract: Contract): Promise<void>;
-    deleteContract(script: string): Promise<void>;
-    private addFilterCondition;
-}

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

@@ -1,4 +0,0 @@
-export { RealmWalletRepository } from "./walletRepository.js";
-export { RealmContractRepository } from "./contractRepository.js";
-export { ArkRealmSchemas, ARK_REALM_SCHEMA_VERSION, runArkRealmMigrations, } from "./schemas.js";
-export type { RealmLike, RealmResults } from "./types.js";

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

@@ -1,16 +0,0 @@
-/**
- * Minimal interface for the subset of the Realm API used by the
- * Arkade 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 Arkade 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

@@ -1,34 +0,0 @@
-import { ArkTransaction, ExtendedCoin, ExtendedVirtualCoin } from "../../wallet/index.js";
-import { WalletRepository, WalletState, VtxoRepositoryKey } from "../walletRepository.js";
-import { RealmLike } from "./types.js";
-/**
- * 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>;
-    getVtxosForScript(script: string): Promise<ExtendedVirtualCoin[]>;
-    saveVtxosForScript(key: VtxoRepositoryKey, vtxos: ExtendedVirtualCoin[]): Promise<void>;
-    deleteVtxosForScript(script: 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/scriptFromAddress.d.ts

@@ -1,9 +0,0 @@
-/**
- * Compute the hex-encoded `scriptPubKey` locking a VTXO from its owning Ark
- * address. Used by repository-layer migrations to backfill `script` on legacy
- * rows that pre-date the column (the indexer now guarantees the field, so new
- * rows never go through this path). The `script` field is required by the
- * domain type, so backfill must produce the same value the indexer would
- * have returned — which is the hex of the address's `pkScript`.
- */
-export declare function scriptFromArkAddress(address: string): string;

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

@@ -1,65 +0,0 @@
-import { TapLeafScript } from "../script/base.js";
-import { ArkTransaction, Asset, ExtendedCoin, ExtendedVirtualCoin } from "../wallet/index.js";
-export type SerializedTapLeaf = {
-    cb: string;
-    s: string;
-};
-export type SerializedVtxo = ReturnType<typeof serializeVtxo>;
-export type SerializedUtxo = ReturnType<typeof serializeUtxo>;
-export type SerializedTransaction = ReturnType<typeof serializeTransaction>;
-export type SerializedAsset = {
-    assetId: string;
-    amount: string;
-};
-export declare const serializeTapLeaf: ([cb, s,]: TapLeafScript) => SerializedTapLeaf;
-export declare const serializeAsset: (a: Asset) => SerializedAsset;
-export declare const deserializeAsset: (a: {
-    assetId: string;
-    amount: string | number | bigint;
-}) => Asset;
-export declare const serializeAssets: (assets: Asset[] | undefined) => SerializedAsset[] | undefined;
-export declare const deserializeAssets: (assets: Array<{
-    assetId: string;
-    amount: string | number | bigint;
-}> | undefined) => Asset[] | undefined;
-export declare const serializeVtxo: (v: ExtendedVirtualCoin) => {
-    tapTree: string;
-    forfeitTapLeafScript: SerializedTapLeaf;
-    intentTapLeafScript: SerializedTapLeaf;
-    extraWitness: string[] | undefined;
-    assets: SerializedAsset[] | undefined;
-    createdAt: Date;
-    script: string;
-    isUnrolled: boolean;
-    isSpent?: boolean;
-    settledBy?: string;
-    spentBy?: string;
-    arkTxId?: string;
-    virtualStatus: import("../wallet/index.js").VirtualStatus;
-    value: number;
-    status: import("../wallet/index.js").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/index.js").Status;
-    txid: string;
-    vout: number;
-};
-export declare const serializeTransaction: (t: ArkTransaction) => {
-    assets: SerializedAsset[] | undefined;
-    key: import("../wallet/index.js").TxKey;
-    type: import("../wallet/index.js").TxType;
-    amount: number;
-    settled: boolean;
-    createdAt: number;
-};
-export declare const deserializeTapLeaf: (t: SerializedTapLeaf) => TapLeafScript;
-export declare const deserializeVtxo: (o: SerializedVtxo) => ExtendedVirtualCoin;
-export declare const deserializeUtxo: (o: SerializedUtxo) => ExtendedCoin;
-export declare const deserializeTransaction: (o: SerializedTransaction) => ArkTransaction;

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

@@ -1,33 +0,0 @@
-import { Contract } from "../../contracts/types.js";
-import { ContractFilter, ContractRepository } from "../contractRepository.js";
-import { SQLExecutor } from "./types.js";
-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

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

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

@@ -1,18 +0,0 @@
-/**
- * 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/walletRepository.d.ts

@@ -1,72 +0,0 @@
-import { ArkTransaction, ExtendedCoin, ExtendedVirtualCoin } from "../wallet/index.js";
-export interface WalletState {
-    /** Arbitrary stored wallet settings. */
-    settings?: Record<string, any>;
-    /**
-     * High-water mark for VTXO indexer syncs, in milliseconds.
-     *
-     * Reused the legacy `lastSyncTime` column name to avoid an
-     * `ALTER TABLE` migration; the value is interpreted as the new
-     * "max indexer `updatedAt`" cursor only after `settings.vtxoCursorMigrated`
-     * is set, so pre-existing values written by the buggy pre-PR sync
-     * are ignored and force a one-shot re-bootstrap on upgrade.
-     */
-    lastSyncTime?: number;
-}
-/** Stored commitment transaction metadata. */
-export type CommitmentTxRecord = {
-    /** Commitment transaction id. */
-    txid: string;
-    /** Creation timestamp in milliseconds. */
-    createdAt: number;
-};
-export interface VtxoRepositoryKey {
-    /** Authoritative ownership key. */
-    script: string;
-    /** Legacy storage bucket. Required by all current backends; throw if absent. */
-    address?: string;
-}
-export interface WalletRepository extends AsyncDisposable {
-    readonly version: 1;
-    /**
-     * Clear all data from storage.
-     */
-    clear(): Promise<void>;
-    /** Fetch stored virtual outputs for an address. */
-    getVtxos(address: string): Promise<ExtendedVirtualCoin[]>;
-    /** Save virtual outputs for an address. */
-    saveVtxos(address: string, vtxos: ExtendedVirtualCoin[]): Promise<void>;
-    /** Delete stored virtual outputs for an address. */
-    deleteVtxos(address: string): Promise<void>;
-    /**
-     * Fetch stored virtual outputs for a script.
-     * @optional SDK backends implement this; custom backends fall back to Tier 1.
-     */
-    getVtxosForScript?(script: string): Promise<ExtendedVirtualCoin[]>;
-    /**
-     * Save virtual outputs for a script.
-     * @optional SDK backends implement this; custom backends fall back to Tier 1.
-     */
-    saveVtxosForScript?(key: VtxoRepositoryKey, vtxos: ExtendedVirtualCoin[]): Promise<void>;
-    /**
-     * Delete stored virtual outputs for a script.
-     * @optional SDK backends implement this; custom backends fall back to Tier 1.
-     */
-    deleteVtxosForScript?(script: string): Promise<void>;
-    /** Fetch stored boarding inputs for an address. */
-    getUtxos(address: string): Promise<ExtendedCoin[]>;
-    /** Save boarding inputs for an address. */
-    saveUtxos(address: string, utxos: ExtendedCoin[]): Promise<void>;
-    /** Delete stored boarding inputs for an address. */
-    deleteUtxos(address: string): Promise<void>;
-    /** Fetch stored transaction history for an address. */
-    getTransactionHistory(address: string): Promise<ArkTransaction[]>;
-    /** Save transaction history for an address. */
-    saveTransactions(address: string, txs: ArkTransaction[]): Promise<void>;
-    /** Delete stored transaction history for an address. */
-    deleteTransactions(address: string): Promise<void>;
-    /** Fetch stored wallet state. */
-    getWalletState(): Promise<WalletState | null>;
-    /** Save wallet state. */
-    saveWalletState(state: WalletState): Promise<void>;
-}

package/dist/types/script/address.d.ts

@@ -1,67 +0,0 @@
-import { Bytes } from "@scure/btc-signer/utils.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 declare class ArkAddress {
-    readonly serverPubKey: Bytes;
-    readonly vtxoTaprootKey: Bytes;
-    readonly hrp: string;
-    readonly version: number;
-    /**
-     * 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: Bytes, vtxoTaprootKey: Bytes, hrp?: string, version?: number);
-    /**
-     * 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: string): ArkAddress;
-    /**
-     * Encode the address to its bech32m string form.
-     *
-     * @returns Bech32m-encoded Arkade address
-     * @see decode
-     */
-    encode(): string;
-    /** ScriptPubKey used to send non-dust funds to the address. */
-    get pkScript(): Bytes;
-    /** ScriptPubKey used to send sub-dust funds to the address. */
-    get subdustPkScript(): Bytes;
-}

package/dist/types/script/base.d.ts

@@ -1,105 +0,0 @@
-import { NETWORK } from "@scure/btc-signer";
-import { PSBTOutput } from "@scure/btc-signer/psbt.js";
-import { Bytes } from "@scure/btc-signer/utils.js";
-import { ArkAddress } from "./address.js";
-import { ConditionCSVMultisigTapscript, CSVMultisigTapscript } from "./tapscript.js";
-export type TapLeafScript = [
-    {
-        version: number;
-        internalKey: Bytes;
-        merklePath: Bytes[];
-    },
-    Bytes
-];
-export declare const TapTreeCoder: (typeof PSBTOutput.tapTree)[2];
-export declare function scriptFromTapLeafScript(leaf: TapLeafScript): Bytes;
-/**
- * VtxoScript is a script that contains a list of tapleaf scripts.
- * It is used to create virtual output scripts.
- *
- * @see ArkAddress
- *
- * @example
- * ```typescript
- * const vtxoScript = new VtxoScript([new Uint8Array(32), new Uint8Array(32)]);
- * ```
- */
-export declare class VtxoScript {
-    readonly scripts: Bytes[];
-    readonly leaves: TapLeafScript[];
-    readonly tweakedPublicKey: Bytes;
-    /**
-     * Decode a virtual output script from an encoded TapTree.
-     *
-     * @param tapTree - Encoded TapTree bytes
-     * @returns Decoded virtual output script
-     * @throws Error if the TapTree cannot be decoded into a valid script set
-     * @see encode
-     */
-    static decode(tapTree: Bytes): VtxoScript;
-    /**
-     * Create a virtual output script from its tapleaf scripts.
-     *
-     * @param scripts - Raw tapscript bytes for each leaf
-     * @throws Error if the provided leaves cannot produce a valid Taproot tree
-     */
-    constructor(scripts: Bytes[]);
-    /**
-     * Encode the virtual output script to a TapTree byte representation.
-     *
-     * @returns Encoded TapTree bytes
-     * @see decode
-     */
-    encode(): Bytes;
-    /**
-     * Build the Arkade address corresponding to this virtual output script.
-     *
-     * @param prefix - Bech32 human-readable prefix
-     * @param serverPubKey - 32-byte Arkade server public key
-     * @returns Arkade address for this script
-     * @see ArkAddress
-     */
-    address(prefix: string, serverPubKey: Bytes): ArkAddress;
-    get pkScript(): Bytes;
-    /**
-     * Build the Taproot onchain address corresponding to this virtual output script.
-     *
-     * @param network - Bitcoin network descriptor
-     * @returns Taproot onchain address
-     * @see address
-     */
-    onchainAddress(network: typeof NETWORK): string;
-    /**
-     * Look up a tapleaf script by its hex-encoded tapscript body.
-     *
-     * @param scriptHex - Hex-encoded tapscript body without the leaf version byte
-     * @returns Matching tapleaf script
-     * @throws Error if no matching leaf exists
-     */
-    findLeaf(scriptHex: string): TapLeafScript;
-    /**
-     * Return all unilateral exit paths embedded in the virtual output script.
-     *
-     * @returns CSV-based exit paths found in the leaves
-     * @see getSequence
-     */
-    exitPaths(): Array<CSVMultisigTapscript.Type | ConditionCSVMultisigTapscript.Type>;
-}
-export type EncodedVtxoScript = {
-    tapTree: Bytes;
-};
-/**
- * Extract the timelock value encoded in a timelocked tapleaf, if any.
- *
- * The return value is unit-ambiguous: for a CSV leaf it is a BIP-68
- * nSequence (relative timelock); for a CLTV leaf it is an absolute
- * nLockTime. Callers must know which leaf shape they are inspecting to
- * interpret the number correctly, and must not copy a CSV result into
- * `Transaction.lockTime` (or vice versa).
- *
- * @param tapLeafScript - Tapleaf script to inspect
- * @returns The encoded timelock value, or `undefined` when neither a CSV
- *          nor CLTV path is present
- * @see VtxoScript.exitPaths
- */
-export declare function getSequence(tapLeafScript: TapLeafScript): number | undefined;

package/dist/types/script/default.d.ts

@@ -1,44 +0,0 @@
-import { Bytes } from "@scure/btc-signer/utils.js";
-import { TapLeafScript, VtxoScript } from "./base.js";
-import { RelativeTimelock } from "./tapscript.js";
-/**
- * DefaultVtxo is the default implementation of a VtxoScript.
- * It contains 1 forfeit path and 1 exit path.
- * - forfeit = (Alice + Server)
- * - exit = (Alice) after csvTimelock
- */
-export declare namespace DefaultVtxo {
-    /**
-     * Options is the options for the DefaultVtxo.Script class.
-     * csvTimelock is the exit path timelock, default is 144 blocks (1 day).
-     */
-    interface Options {
-        pubKey: Bytes;
-        serverPubKey: Bytes;
-        csvTimelock?: RelativeTimelock;
-    }
-    /**
-     * DefaultVtxo.Script is the class letting to create the vtxo script.
-     * @example
-     * ```typescript
-     * const vtxoScript = new DefaultVtxo.Script({
-     *     pubKey: new Uint8Array(32),
-     *     serverPubKey: new Uint8Array(32),
-     * });
-     *
-     * console.log("script pub key:", vtxoScript.pkScript)
-     * ```
-     */
-    class Script extends VtxoScript {
-        readonly options: Options;
-        static readonly DEFAULT_TIMELOCK: RelativeTimelock;
-        readonly forfeitScript: string;
-        readonly exitScript: string;
-        /** Create the default virtual output script with one forfeit path and one exit path. */
-        constructor(options: Options);
-        /** Return the forfeit tapleaf script. */
-        forfeit(): TapLeafScript;
-        /** Return the unilateral exit tapleaf script. */
-        exit(): TapLeafScript;
-    }
-}