@arkade-os/sdk 0.4.26 → 0.4.28

package/dist/types/wallet/serviceWorker/wallet-message-handler.d.ts

@@ -1,543 +0,0 @@
-import { SettlementEvent } from "../../providers/ark.js";
-import type { Contract, ContractEvent, ContractWithVtxos, GetContractsFilter, PathSelection } from "../../contracts/index.js";
-import type { CreateContractParams, GetAllSpendingPathsOptions, GetSpendablePathsOptions } from "../../contracts/contractManager.js";
-import { ArkTransaction, AssetDetails, BurnParams, ExtendedCoin, ExtendedVirtualCoin, GetVtxosFilter, IssuanceParams, IssuanceResult, IWallet, Recipient, ReissuanceParams, SendBitcoinParams, SettleParams, VirtualCoin, WalletBalance } from "../index.js";
-import { DelegateInfo } from "../../providers/delegator.js";
-import { MessageHandler, RequestEnvelope, ResponseEnvelope } from "../../worker/messageBus.js";
-import { Transaction } from "../../utils/transaction.js";
-export declare class WalletNotInitializedError extends Error {
-    constructor();
-}
-export declare class ReadonlyWalletError extends Error {
-    constructor();
-}
-export declare class DelegatorNotConfiguredError extends Error {
-    constructor();
-}
-export declare const DEFAULT_MESSAGE_TAG = "WALLET_UPDATER";
-export type RequestInitWallet = RequestEnvelope & {
-    type: "INIT_WALLET";
-    payload: {
-        /**
-         * Legacy per-request key material. Ignored by the current handler —
-         * identity hydration happens during INITIALIZE_MESSAGE_BUS. Retained
-         * for wire compatibility with older workers that may still read it.
-         * Slated for removal in the next major.
-         *
-         * @deprecated Identity is now carried by INITIALIZE_MESSAGE_BUS.
-         */
-        key?: {
-            privateKey: string;
-        } | {
-            publicKey: string;
-        } | {};
-        arkServerUrl: string;
-        arkServerPublicKey?: string;
-    };
-};
-export type ResponseInitWallet = ResponseEnvelope & {
-    type: "WALLET_INITIALIZED";
-};
-export type RequestSettle = RequestEnvelope & {
-    type: "SETTLE";
-    payload: {
-        params?: SettleParams;
-    };
-};
-export type ResponseSettle = ResponseEnvelope & {
-    type: "SETTLE_SUCCESS";
-    payload: {
-        txid: string;
-    };
-};
-export type RequestSendBitcoin = RequestEnvelope & {
-    type: "SEND_BITCOIN";
-    payload: SendBitcoinParams;
-};
-export type ResponseSendBitcoin = ResponseEnvelope & {
-    type: "SEND_BITCOIN_SUCCESS";
-    payload: {
-        txid: string;
-    };
-};
-export type RequestGetAddress = RequestEnvelope & {
-    type: "GET_ADDRESS";
-};
-export type ResponseGetAddress = ResponseEnvelope & {
-    type: "ADDRESS";
-    payload: {
-        address: string;
-    };
-};
-export type RequestGetBoardingAddress = RequestEnvelope & {
-    type: "GET_BOARDING_ADDRESS";
-};
-export type ResponseGetBoardingAddress = ResponseEnvelope & {
-    type: "BOARDING_ADDRESS";
-    payload: {
-        address: string;
-    };
-};
-export type RequestGetBalance = RequestEnvelope & {
-    type: "GET_BALANCE";
-};
-export type ResponseGetBalance = ResponseEnvelope & {
-    type: "BALANCE";
-    payload: WalletBalance;
-};
-export type RequestGetVtxos = RequestEnvelope & {
-    type: "GET_VTXOS";
-    payload: {
-        filter?: GetVtxosFilter;
-    };
-};
-export type ResponseGetVtxos = ResponseEnvelope & {
-    type: "VTXOS";
-    payload: {
-        vtxos: Awaited<ReturnType<IWallet["getVtxos"]>>;
-    };
-};
-export type RequestGetBoardingUtxos = RequestEnvelope & {
-    type: "GET_BOARDING_UTXOS";
-};
-export type ResponseGetBoardingUtxos = ResponseEnvelope & {
-    type: "BOARDING_UTXOS";
-    payload: {
-        utxos: ExtendedCoin[];
-    };
-};
-export type RequestGetTransactionHistory = RequestEnvelope & {
-    type: "GET_TRANSACTION_HISTORY";
-};
-export type ResponseGetTransactionHistory = ResponseEnvelope & {
-    type: "TRANSACTION_HISTORY";
-    payload: {
-        transactions: ArkTransaction[];
-    };
-};
-export type RequestGetStatus = RequestEnvelope & {
-    type: "GET_STATUS";
-};
-export type ResponseGetStatus = ResponseEnvelope & {
-    type: "WALLET_STATUS";
-    payload: {
-        walletInitialized: boolean;
-        xOnlyPublicKey: Uint8Array | undefined;
-    };
-};
-export type RequestClear = RequestEnvelope & {
-    type: "CLEAR";
-};
-export type ResponseClear = ResponseEnvelope & {
-    type: "CLEAR_SUCCESS";
-    payload: {
-        cleared: boolean;
-    };
-};
-export type RequestSignTransaction = RequestEnvelope & {
-    type: "SIGN_TRANSACTION";
-    payload: {
-        tx: Transaction;
-        inputIndexes?: number[];
-    };
-};
-export type ResponseSignTransaction = ResponseEnvelope & {
-    type: "SIGN_TRANSACTION";
-    payload: {
-        tx: Transaction;
-    };
-};
-export type RequestReloadWallet = RequestEnvelope & {
-    type: "RELOAD_WALLET";
-};
-export type ResponseReloadWallet = ResponseEnvelope & {
-    type: "RELOAD_SUCCESS";
-    payload: {
-        reloaded: boolean;
-    };
-};
-export type RequestCreateContract = RequestEnvelope & {
-    type: "CREATE_CONTRACT";
-    payload: CreateContractParams;
-};
-export type ResponseCreateContract = ResponseEnvelope & {
-    type: "CONTRACT_CREATED";
-    payload: {
-        contract: Contract;
-    };
-};
-export type RequestGetContracts = RequestEnvelope & {
-    type: "GET_CONTRACTS";
-    payload: {
-        filter?: GetContractsFilter;
-    };
-};
-export type ResponseGetContracts = ResponseEnvelope & {
-    type: "CONTRACTS";
-    payload: {
-        contracts: Contract[];
-    };
-};
-export type RequestGetContractsWithVtxos = RequestEnvelope & {
-    type: "GET_CONTRACTS_WITH_VTXOS";
-    payload: {
-        filter?: GetContractsFilter;
-    };
-};
-export type ResponseGetContractsWithVtxos = ResponseEnvelope & {
-    type: "CONTRACTS_WITH_VTXOS";
-    payload: {
-        contracts: ContractWithVtxos[];
-    };
-};
-export type RequestAnnotateVtxos = RequestEnvelope & {
-    type: "ANNOTATE_VTXOS";
-    payload: {
-        vtxos: VirtualCoin[];
-    };
-};
-export type ResponseAnnotateVtxos = ResponseEnvelope & {
-    type: "ANNOTATED_VTXOS";
-    payload: {
-        vtxos: ExtendedVirtualCoin[];
-    };
-};
-export type RequestUpdateContract = RequestEnvelope & {
-    type: "UPDATE_CONTRACT";
-    payload: {
-        script: string;
-        updates: Partial<Omit<Contract, "id" | "createdAt">>;
-    };
-};
-export type ResponseUpdateContract = ResponseEnvelope & {
-    type: "CONTRACT_UPDATED";
-    payload: {
-        contract: Contract;
-    };
-};
-export type RequestDeleteContract = RequestEnvelope & {
-    type: "DELETE_CONTRACT";
-    payload: {
-        script: string;
-    };
-};
-export type ResponseDeleteContract = ResponseEnvelope & {
-    type: "CONTRACT_DELETED";
-    payload: {
-        deleted: boolean;
-    };
-};
-export type RequestGetSpendablePaths = RequestEnvelope & {
-    type: "GET_SPENDABLE_PATHS";
-    payload: {
-        options: GetSpendablePathsOptions;
-    };
-};
-export type ResponseGetSpendablePaths = ResponseEnvelope & {
-    type: "SPENDABLE_PATHS";
-    payload: {
-        paths: PathSelection[];
-    };
-};
-export type RequestIsContractManagerWatching = RequestEnvelope & {
-    type: "IS_CONTRACT_MANAGER_WATCHING";
-};
-export type ResponseIsContractManagerWatching = ResponseEnvelope & {
-    type: "CONTRACT_WATCHING";
-    payload: {
-        isWatching: boolean;
-    };
-};
-export type RequestRefreshVtxos = RequestEnvelope & {
-    type: "REFRESH_VTXOS";
-    payload?: {
-        scripts?: string[];
-        after?: number;
-        before?: number;
-    };
-};
-export type ResponseRefreshVtxos = ResponseEnvelope & {
-    type: "REFRESH_VTXOS_SUCCESS";
-};
-export type RequestRefreshOutpoints = RequestEnvelope & {
-    type: "REFRESH_OUTPOINTS";
-    payload: {
-        outpoints: {
-            txid: string;
-            vout: number;
-        }[];
-    };
-};
-export type ResponseRefreshOutpoints = ResponseEnvelope & {
-    type: "REFRESH_OUTPOINTS_SUCCESS";
-};
-export type RequestGetAllSpendingPaths = RequestEnvelope & {
-    type: "GET_ALL_SPENDING_PATHS";
-    payload: {
-        options: GetAllSpendingPathsOptions;
-    };
-};
-export type ResponseGetAllSpendingPaths = ResponseEnvelope & {
-    type: "ALL_SPENDING_PATHS";
-    payload: {
-        paths: PathSelection[];
-    };
-};
-export type ResponseSettleEvent = ResponseEnvelope & {
-    broadcast: true;
-    type: "SETTLE_EVENT";
-    payload: SettlementEvent;
-};
-export type ResponseRecoverVtxosEvent = ResponseEnvelope & {
-    type: "RECOVER_VTXOS_EVENT";
-    payload: SettlementEvent;
-};
-export type ResponseRenewVtxosEvent = ResponseEnvelope & {
-    type: "RENEW_VTXOS_EVENT";
-    payload: SettlementEvent;
-};
-export type ResponseUtxoUpdate = ResponseEnvelope & {
-    broadcast: true;
-    type: "UTXO_UPDATE";
-    payload: {
-        coins: ExtendedCoin[];
-    };
-};
-export type ResponseVtxoUpdate = ResponseEnvelope & {
-    broadcast: true;
-    type: "VTXO_UPDATE";
-    payload: {
-        newVtxos: ExtendedCoin[];
-        spentVtxos: ExtendedCoin[];
-    };
-};
-export type ResponseContractEvent = ResponseEnvelope & {
-    tag: string;
-    broadcast: true;
-    type: "CONTRACT_EVENT";
-    payload: {
-        event: ContractEvent;
-    };
-};
-export type RequestSend = RequestEnvelope & {
-    type: "SEND";
-    payload: {
-        recipients: [Recipient, ...Recipient[]];
-    };
-};
-export type ResponseSend = ResponseEnvelope & {
-    type: "SEND_SUCCESS";
-    payload: {
-        txid: string;
-    };
-};
-export type RequestGetAssetDetails = RequestEnvelope & {
-    type: "GET_ASSET_DETAILS";
-    payload: {
-        assetId: string;
-    };
-};
-export type ResponseGetAssetDetails = ResponseEnvelope & {
-    type: "ASSET_DETAILS";
-    payload: {
-        assetDetails: AssetDetails;
-    };
-};
-export type RequestIssue = RequestEnvelope & {
-    type: "ISSUE";
-    payload: {
-        params: IssuanceParams;
-    };
-};
-export type ResponseIssue = ResponseEnvelope & {
-    type: "ISSUE_SUCCESS";
-    payload: {
-        result: IssuanceResult;
-    };
-};
-export type RequestReissue = RequestEnvelope & {
-    type: "REISSUE";
-    payload: {
-        params: ReissuanceParams;
-    };
-};
-export type ResponseReissue = ResponseEnvelope & {
-    type: "REISSUE_SUCCESS";
-    payload: {
-        txid: string;
-    };
-};
-export type RequestBurn = RequestEnvelope & {
-    type: "BURN";
-    payload: {
-        params: BurnParams;
-    };
-};
-export type ResponseBurn = ResponseEnvelope & {
-    type: "BURN_SUCCESS";
-    payload: {
-        txid: string;
-    };
-};
-export type RequestDelegate = RequestEnvelope & {
-    type: "DELEGATE";
-    payload: {
-        vtxoOutpoints: {
-            txid: string;
-            vout: number;
-        }[];
-        destination: string;
-        delegateAt?: number;
-    };
-};
-export type ResponseDelegate = ResponseEnvelope & {
-    type: "DELEGATE_SUCCESS";
-    payload: {
-        delegated: {
-            txid: string;
-            vout: number;
-        }[];
-        failed: {
-            outpoints: {
-                txid: string;
-                vout: number;
-            }[];
-            error: string;
-        }[];
-    };
-};
-export type RequestGetDelegateInfo = RequestEnvelope & {
-    type: "GET_DELEGATE_INFO";
-};
-export type ResponseGetDelegateInfo = ResponseEnvelope & {
-    type: "DELEGATE_INFO";
-    payload: {
-        info: DelegateInfo;
-    };
-};
-export type RequestRecoverVtxos = RequestEnvelope & {
-    type: "RECOVER_VTXOS";
-};
-export type ResponseRecoverVtxos = ResponseEnvelope & {
-    type: "RECOVER_VTXOS_SUCCESS";
-    payload: {
-        txid: string;
-    };
-};
-export type RequestGetRecoverableBalance = RequestEnvelope & {
-    type: "GET_RECOVERABLE_BALANCE";
-};
-export type ResponseGetRecoverableBalance = ResponseEnvelope & {
-    type: "RECOVERABLE_BALANCE";
-    payload: {
-        recoverable: string;
-        subdust: string;
-        includesSubdust: boolean;
-        vtxoCount: number;
-    };
-};
-export type RequestGetExpiringVtxos = RequestEnvelope & {
-    type: "GET_EXPIRING_VTXOS";
-    payload: {
-        thresholdMs?: number;
-    };
-};
-export type ResponseGetExpiringVtxos = ResponseEnvelope & {
-    type: "EXPIRING_VTXOS";
-    payload: {
-        vtxos: ExtendedVirtualCoin[];
-    };
-};
-export type RequestRenewVtxos = RequestEnvelope & {
-    type: "RENEW_VTXOS";
-};
-export type ResponseRenewVtxos = ResponseEnvelope & {
-    type: "RENEW_VTXOS_SUCCESS";
-    payload: {
-        txid: string;
-    };
-};
-export type RequestGetExpiredBoardingUtxos = RequestEnvelope & {
-    type: "GET_EXPIRED_BOARDING_UTXOS";
-};
-export type ResponseGetExpiredBoardingUtxos = ResponseEnvelope & {
-    type: "EXPIRED_BOARDING_UTXOS";
-    payload: {
-        utxos: ExtendedCoin[];
-    };
-};
-export type RequestSweepExpiredBoardingUtxos = RequestEnvelope & {
-    type: "SWEEP_EXPIRED_BOARDING_UTXOS";
-};
-export type ResponseSweepExpiredBoardingUtxos = ResponseEnvelope & {
-    type: "SWEEP_EXPIRED_BOARDING_UTXOS_SUCCESS";
-    payload: {
-        txid: string;
-    };
-};
-export type WalletUpdaterRequest = RequestInitWallet | RequestSettle | RequestSendBitcoin | RequestGetAddress | RequestGetBoardingAddress | RequestGetBalance | RequestGetVtxos | RequestGetBoardingUtxos | RequestGetTransactionHistory | RequestGetStatus | RequestClear | RequestReloadWallet | RequestSignTransaction | RequestCreateContract | RequestGetContracts | RequestGetContractsWithVtxos | RequestAnnotateVtxos | RequestUpdateContract | RequestDeleteContract | RequestGetSpendablePaths | RequestGetAllSpendingPaths | RequestIsContractManagerWatching | RequestRefreshVtxos | RequestRefreshOutpoints | RequestSend | RequestGetAssetDetails | RequestIssue | RequestReissue | RequestBurn | RequestDelegate | RequestGetDelegateInfo | RequestRecoverVtxos | RequestGetRecoverableBalance | RequestGetExpiringVtxos | RequestRenewVtxos | RequestGetExpiredBoardingUtxos | RequestSweepExpiredBoardingUtxos;
-export type WalletUpdaterResponse = ResponseEnvelope & (ResponseInitWallet | ResponseSettle | ResponseSettleEvent | ResponseSendBitcoin | ResponseGetAddress | ResponseGetBoardingAddress | ResponseGetBalance | ResponseGetVtxos | ResponseGetBoardingUtxos | ResponseGetTransactionHistory | ResponseGetStatus | ResponseClear | ResponseReloadWallet | ResponseUtxoUpdate | ResponseVtxoUpdate | ResponseSignTransaction | ResponseCreateContract | ResponseGetContracts | ResponseGetContractsWithVtxos | ResponseAnnotateVtxos | ResponseUpdateContract | ResponseDeleteContract | ResponseGetSpendablePaths | ResponseGetAllSpendingPaths | ResponseIsContractManagerWatching | ResponseRefreshVtxos | ResponseRefreshOutpoints | ResponseContractEvent | ResponseSend | ResponseGetAssetDetails | ResponseIssue | ResponseReissue | ResponseBurn | ResponseDelegate | ResponseGetDelegateInfo | ResponseRecoverVtxos | ResponseRecoverVtxosEvent | ResponseGetRecoverableBalance | ResponseGetExpiringVtxos | ResponseRenewVtxos | ResponseRenewVtxosEvent | ResponseGetExpiredBoardingUtxos | ResponseSweepExpiredBoardingUtxos);
-export declare class WalletMessageHandler implements MessageHandler<WalletUpdaterRequest, WalletUpdaterResponse> {
-    readonly messageTag: string;
-    private wallet;
-    private readonlyWallet;
-    private arkProvider;
-    private indexerProvider;
-    private walletRepository;
-    private incomingFundsSubscription;
-    private contractEventsSubscription;
-    private onNextTick;
-    /**
-     * Instantiate a new WalletUpdater.
-     * Can override the default `messageTag` allowing more than one updater to run in parallel.
-     * Note that the default ServiceWorkerWallet sends messages to the default WalletUpdater tag.
-     */
-    constructor(options?: {
-        messageTag?: string;
-    });
-    start(...params: Parameters<MessageHandler["start"]>): Promise<void>;
-    stop(): Promise<void>;
-    tick(_now: number): Promise<WalletUpdaterResponse[]>;
-    private scheduleForNextTick;
-    private requireWallet;
-    private tagged;
-    isLongRunning(message: WalletUpdaterRequest): boolean;
-    handleMessage(message: WalletUpdaterRequest): Promise<WalletUpdaterResponse>;
-    private handleInitWallet;
-    private handleGetBalance;
-    private getAllBoardingUtxos;
-    /**
-     * Get spendable vtxos from the repository
-     */
-    private getSpendableVtxos;
-    private onWalletInitialized;
-    /**
-     * Refresh virtual outputs, boarding inputs, and transaction history from cache.
-     * Shared by onWalletInitialized (full bootstrap) and reloadWallet
-     * (post-refresh), avoiding duplicate subscriptions and VtxoManager restarts.
-     */
-    private refreshCachedData;
-    /**
-     * Force a full VTXO refresh from the indexer, then refresh cached data.
-     * Used by RELOAD_WALLET to ensure fresh data without re-subscribing
-     * to incoming funds or restarting the VtxoManager.
-     */
-    private reloadWallet;
-    private handleSettle;
-    private handleSendBitcoin;
-    private handleSignTransaction;
-    private handleDelegate;
-    private handleGetVtxos;
-    private clear;
-    /**
-     * Read all virtual outputs from the repository, aggregated across all contract
-     * addresses and the wallet's primary address, with deduplication.
-     */
-    private getVtxosFromRepo;
-    /**
-     * Build transaction history from cached virtual outputs without hitting the indexer.
-     * Falls back to indexer only for uncached transaction timestamps.
-     */
-    private buildTransactionHistoryFromCache;
-    private ensureContractEventBroadcasting;
-}