@arkade-os/sdk 0.4.26 → 0.4.28

package/dist/types/wallet/expo/background.d.ts

@@ -1,66 +0,0 @@
-import type { WalletRepository } from "../../repositories/walletRepository.js";
-import type { ContractRepository } from "../../repositories/contractRepository.js";
-import type { AsyncStorageTaskQueue } from "../../worker/expo/asyncStorageTaskQueue.js";
-import type { TaskProcessor } from "../../worker/expo/taskRunner.js";
-/**
- * Wallet parameters persisted by @see ExpoWallet.setup and read
- * by the background handler to reconstruct providers and `extendVtxo`
- * without a network call.
- */
-export interface PersistedBackgroundConfig {
-    arkServerUrl: string;
-    pubkeyHex: string;
-    serverPubKeyHex: string;
-    exitTimelockValue: string;
-    exitTimelockType: "blocks" | "seconds";
-}
-/**
- * Options for @see defineExpoBackgroundTask.
- */
-export interface DefineBackgroundTaskOptions {
-    /** AsyncStorage-backed queue (must match the one passed to ExpoWallet.setup). */
-    taskQueue: AsyncStorageTaskQueue;
-    /** Wallet repository (fresh instance is fine — connects to the same DB). */
-    walletRepository: WalletRepository;
-    /** Contract repository (fresh instance is fine — connects to the same DB). */
-    contractRepository: ContractRepository;
-    /** Processors to run. Defaults to `[contractPollProcessor]`. */
-    processors?: TaskProcessor[];
-}
-/**
- * Define the Expo background task handler.
- *
- * **Must be called at module/global scope** (before React mounts).
- * Internally calls `TaskManager.defineTask()`.
- *
- * @example
- * ```ts
- * // At the top of your app entry file
- * import { defineExpoBackgroundTask } from "@arkade-os/sdk/wallet/expo";
- * import { AsyncStorageTaskQueue } from "@arkade-os/sdk/worker/expo";
- * import AsyncStorage from "@react-native-async-storage/async-storage";
- *
- * const taskQueue = new AsyncStorageTaskQueue(AsyncStorage);
- * defineExpoBackgroundTask("ark-background-poll", {
- *     taskQueue,
- *     walletRepository: new IndexedDBWalletRepository(),
- *     contractRepository: new IndexedDBContractRepository(),
- * });
- * ```
- */
-export declare function defineExpoBackgroundTask(taskName: string, options: DefineBackgroundTaskOptions): void;
-/**
- * Activate the OS-level background task scheduler.
- *
- * Call this after @see defineExpoBackgroundTask (typically inside
- * @see ExpoWallet.setup or in a React component after wallet init).
- *
- * @param minimumInterval - Minimum interval in minutes (default 15).
- */
-export declare function registerExpoBackgroundTask(taskName: string, options?: {
-    minimumInterval?: number;
-}): Promise<void>;
-/**
- * Unregister the background task from the OS scheduler.
- */
-export declare function unregisterExpoBackgroundTask(taskName: string): Promise<void>;

package/dist/types/wallet/expo/index.d.ts

@@ -1,4 +0,0 @@
-export { ExpoWallet } from "./wallet.js";
-export type { ExpoWalletConfig, ExpoBackgroundConfig } from "./wallet.js";
-export { defineExpoBackgroundTask, registerExpoBackgroundTask, unregisterExpoBackgroundTask, } from "./background.js";
-export type { DefineBackgroundTaskOptions, PersistedBackgroundConfig, } from "./background.js";

package/dist/types/wallet/hdDescriptorProvider.d.ts

@@ -1,93 +0,0 @@
-import { DescriptorProvider, DescriptorSigningRequest } from "../identity/descriptorProvider.js";
-import { HDCapableIdentity } from "../identity/hdCapableIdentity.js";
-import { WalletRepository } from "../repositories/walletRepository.js";
-import { Transaction } from "../utils/transaction.js";
-/**
- * HD-wallet {@link DescriptorProvider} that allocates a fresh signing
- * descriptor on every call. The provider holds no notion of "current" — it
- * is a pure rotating allocator. The question of "which descriptor is the
- * wallet currently bound to?" is answered by querying the contract
- * repository for active contracts, not by asking this provider.
- *
- * State is persisted under `WalletRepository.getWalletState().settings.hd` so
- * that no storage-schema migration is required when switching a wallet from
- * single-key to HD. The provider is backed by an {@link HDCapableIdentity},
- * which carries the wildcard account descriptor template (for derivation)
- * and the signing primitives.
- *
- * The read-modify-write of the persisted index runs inside the shared per-
- * repo `updateWalletState` mutex, so two `getNextSigningDescriptor` callers
- * — including those driving separate `HDDescriptorProvider` instances on
- * the same repo — can never observe the same index.
- *
- * @example
- * ```ts
- * const provider = await HDDescriptorProvider.create(identity, walletRepo);
- * const descriptor = await provider.getNextSigningDescriptor();
- * // descriptor: tr([fp/86'/0'/0']xpub/0/0)
- * const next = await provider.getNextSigningDescriptor();
- * // next: tr([fp/86'/0'/0']xpub/0/1)
- * ```
- */
-export declare class HDDescriptorProvider implements DescriptorProvider {
-    private readonly identity;
-    private readonly walletRepository;
-    private constructor();
-    /**
-     * Construct an HDDescriptorProvider. No I/O is performed here;
-     * persisted state is read lazily on the first call to
-     * `getNextSigningDescriptor`. A descriptor-mismatch error surfaces on
-     * first use rather than at boot.
-     */
-    static create(identity: HDCapableIdentity, walletRepository: WalletRepository): Promise<HDDescriptorProvider>;
-    /**
-     * Allocate the next descriptor and return it. The first call on a fresh
-     * wallet returns descriptor at index 0; subsequent calls return 1, 2, 3,
-     * ... in order. Each call is atomic with respect to other rotations on
-     * the same repo: two concurrent callers can never observe the same
-     * index.
-     */
-    getNextSigningDescriptor(): Promise<string>;
-    /**
-     * Returns true when the given descriptor is derivable from this wallet's
-     * seed. Delegates to the underlying identity, which handles both HD and
-     * simple `tr(pubkey)` descriptors.
-     */
-    isOurs(descriptor: string): boolean;
-    /**
-     * Signs each request with the key derived from its descriptor. Delegates
-     * to the identity's signing primitives — the identity, not the provider,
-     * holds the seed.
-     */
-    signWithDescriptor(requests: DescriptorSigningRequest[]): Promise<Transaction[]>;
-    /** Signs a message using the key derived from `descriptor`. */
-    signMessageWithDescriptor(descriptor: string, message: Uint8Array, signatureType?: "schnorr" | "ecdsa"): Promise<Uint8Array>;
-    /**
-     * Substitute the wildcard in the identity's account-descriptor template
-     * with a concrete index, going through the descriptors-scure parser
-     * rather than ad-hoc string substitution. The parser's `expand({ index })`
-     * call validates that the input is a ranged template AND produces a
-     * canonical materialized key expression at the given index.
-     */
-    private materializeAt;
-    /**
-     * Run the read-modify-write of HD settings inside the shared per-repo
-     * wallet-state mutex. The closure receives a freshly-validated settings
-     * snapshot, mutates it, and returns whatever value the caller wants to
-     * surface; the mutated settings are then persisted as part of the same
-     * atomic update.
-     *
-     * Doing the read inside the lock is what prevents two providers (or two
-     * concurrent callers on the same provider) from racing on a stale index.
-     */
-    private mutate;
-    /**
-     * Validate the persisted HD settings (or initialize a fresh record when
-     * absent) and return a clone safe for the caller to mutate.
-     *
-     * The cast to `HDWalletSettings` trusts storage; a corrupted or
-     * partially-migrated repo could otherwise produce `NaN` descriptors.
-     * Fail loud rather than silently derive garbage.
-     */
-    private parseSettings;
-}