@arkade-os/sdk 0.4.64 → 0.4.66

package/dist/{index-CFOMyVMt.d.ts → index-uUE_uQPn.d.ts}

@@ -290,6 +290,11 @@ type PaginationOptions = {
     pageIndex?: number;
     pageSize?: number;
 };
+/**
+ * Page size {@link RestIndexerProvider.getVtxos} uses when the caller named no
+ * pagination of its own and it pages the query out itself.
+ */
+declare const DEFAULT_VTXO_PAGE_SIZE = 500;
 declare enum IndexerTxType {
     INDEXER_TX_TYPE_UNSPECIFIED = 0,
     INDEXER_TX_TYPE_RECEIVED = 1,
@@ -586,6 +591,12 @@ declare class RestIndexerProvider implements IndexerProvider {
         vtxos: VirtualCoin[];
         page?: PageResponse;
     }>;
+    /**
+     * Fetch a single page of vtxos. Callers paging to exhaustion get no
+     * deliberate inter-page backoff here: `indexerFetch` already enforces
+     * politeness through the rate gate, so don't add a redundant sleep.
+     */
+    private fetchVtxosPage;
     getAssetDetails(assetId: string): Promise<AssetDetails>;
     subscribeForScripts(scripts: string[], subscriptionId?: string): Promise<string>;
     unsubscribeForScripts(subscriptionId: string, scripts?: string[]): Promise<void>;
@@ -836,6 +847,23 @@ interface ArkInfo {
      * satisfy any floor comparison.
      */
     vtxoTreeExpiry?: bigint;
+    /**
+     * Weight budget an ark transaction must stay under; the server answers
+     * `TX_TOO_LARGE` past it.
+     *
+     * `undefined` when not advertised — a server that omits the field and one
+     * that sends `0` both mean "no limit stated". Never `0n`, which would read
+     * as a server that accepts no transaction at all.
+     */
+    maxTxWeight?: bigint;
+    /**
+     * Maximum OP_RETURN outputs the server accepts per transaction.
+     *
+     * `undefined` when not advertised — a server that omits the field and one
+     * that sends `0` both mean "no limit stated". Never `0n`, which would read
+     * as a server that forbids them outright.
+     */
+    maxOpReturnOutputs?: bigint;
     /**
      * Maximum boarding input amount.
      *
@@ -877,6 +905,28 @@ interface TxNotification {
         tx: string;
     }>;
 }
+/**
+ * A `sweepTx` notification. Only a sweep carries swept outpoints, so only this
+ * arm declares them: reading `sweptVtxos` off another arm is a type error, and
+ * a sweep handler never has to narrow the field it came for.
+ */
+interface SweepTxNotification extends TxNotification {
+    /**
+     * Outpoints the transaction swept — outpoints rather than virtual outputs,
+     * because a swept output is gone: the server has nothing left to describe
+     * beyond where it was. Empty when the sweep touched none of them.
+     */
+    sweptVtxos: Outpoint[];
+}
+/**
+ * One frame of {@link ArkProvider.getTransactionsStream}. Exactly one arm is
+ * set; an unrecognized frame is dropped rather than yielded.
+ */
+interface TxNotificationEvent {
+    commitmentTx?: TxNotification;
+    arkTx?: TxNotification;
+    sweepTx?: SweepTxNotification;
+}
 interface ArkProvider {
     /** Fetch Arkade server configuration and fee settings. */
     getInfo(): Promise<ArkInfo>;
@@ -903,10 +953,7 @@ interface ArkProvider {
     /** Open the settlement event stream for the given topics. */
     getEventStream(signal: AbortSignal, topics: string[]): AsyncIterableIterator<SettlementEvent>;
     /** Stream transaction notifications emitted by the Arkade server. */
-    getTransactionsStream(signal: AbortSignal): AsyncIterableIterator<{
-        commitmentTx?: TxNotification;
-        arkTx?: TxNotification;
-    }>;
+    getTransactionsStream(signal: AbortSignal): AsyncIterableIterator<TxNotificationEvent>;
     /** Fetch pending transactions for a signed get-pending-tx intent. */
     getPendingTxs(intent: SignedIntent<Intent.GetPendingTxMessage>): Promise<PendingTx[]>;
 }
@@ -965,16 +1012,10 @@ declare class RestArkProvider implements ArkProvider {
     submitTreeSignatures(batchId: string, pubkey: string, signatures: TreePartialSigs): Promise<void>;
     submitSignedForfeitTxs(signedForfeitTxs: string[], signedCommitmentTx?: string): Promise<void>;
     getEventStream(signal: AbortSignal, topics: string[]): AsyncIterableIterator<SettlementEvent>;
-    getTransactionsStream(signal: AbortSignal): AsyncIterableIterator<{
-        commitmentTx?: TxNotification;
-        arkTx?: TxNotification;
-    }>;
+    getTransactionsStream(signal: AbortSignal): AsyncIterableIterator<TxNotificationEvent>;
     getPendingTxs(intent: SignedIntent<Intent.GetPendingTxMessage>): Promise<PendingTx[]>;
     protected parseSettlementEvent(data: ProtoTypes.GetEventStreamResponse): SettlementEvent | null;
-    protected parseTransactionNotification(data: ProtoTypes.GetTransactionsStreamResponse): {
-        commitmentTx?: TxNotification;
-        arkTx?: TxNotification;
-    } | null;
+    protected parseTransactionNotification(data: ProtoTypes.GetTransactionsStreamResponse): TxNotificationEvent | null;
 }
 declare namespace ProtoTypes {
     interface BatchStartedEvent {
@@ -1060,27 +1101,24 @@ declare namespace ProtoTypes {
         streamStarted?: StreamStartedEvent;
         heartbeat?: Heartbeat;
     }
-    export interface GetTransactionsStreamResponse {
-        commitmentTx?: {
+    export interface TxNotificationData {
+        txid: string;
+        tx: string;
+        spentVtxos: VtxoData[];
+        spendableVtxos: VtxoData[];
+        checkpointTxs?: Record<string, {
             txid: string;
             tx: string;
-            spentVtxos: VtxoData[];
-            spendableVtxos: VtxoData[];
-            checkpointTxs?: Record<string, {
-                txid: string;
-                tx: string;
-            }>;
-        };
-        arkTx?: {
+        }>;
+        sweptVtxos?: {
             txid: string;
-            tx: string;
-            spentVtxos: VtxoData[];
-            spendableVtxos: VtxoData[];
-            checkpointTxs?: Record<string, {
-                txid: string;
-                tx: string;
-            }>;
-        };
+            vout: number;
+        }[];
+    }
+    export interface GetTransactionsStreamResponse {
+        commitmentTx?: TxNotificationData;
+        arkTx?: TxNotificationData;
+        sweepTx?: TxNotificationData;
         heartbeat?: Heartbeat;
     }
     export interface EventData {
@@ -1873,8 +1911,7 @@ interface SignerSet {
 /**
  * Normalize a server signer pubkey hex to the x-only (32-byte) form contract
  * scripts and `params.serverPubKey` use. A 33-byte compressed key drops its
- * parity prefix; a 32-byte key is canonicalized to lowercase. Mirrors the
- * wallet's `hex.decode(info.signerPubkey).slice(1)` setup path so the active
+ * parity prefix; a 32-byte key is canonicalized to lowercase. The active
  * signer and the deprecated signers (which arkd may advertise compressed)
  * compare equal to the x-only `params.serverPubKey` persisted on contracts.
  */
@@ -5935,4 +5972,4 @@ interface IReadonlyWallet {
     clear(): Promise<void>;
 }
 
-export { type TreeTxEvent as $, type ArkTransaction as A, type IntentFilter as B, type ContractRepository as C, type VirtualTxRepository as D, type ExtendedCoin as E, type VirtualTx as F, type GetVtxosFilter as G, type VtxoBranch as H, type IWallet as I, ChainedTxType as J, type DescriptorProvider as K, type Network as L, CSVMultisigTapscript as M, type NormalizedExtendedVirtualCoin as N, type Outpoint as O, type BatchStartedEvent as P, type TreeSigningStartedEvent as Q, type Recipient as R, type SendBitcoinParams as S, type TxNotification as T, TxTree as U, VtxoScript as V, type WalletRepository as W, type TreeNoncesEvent as X, type BatchFinalizationEvent as Y, type BatchFinalizedEvent as Z, type BatchFailedEvent as _, type Identity as a, BITCOIN_EMULATOR_PUBKEY as a$, type TreeSignatureEvent as a0, type IReadonlyWallet as a1, type ReadonlyIdentity as a2, type OnchainProvider as a3, type DelegateProvider as a4, type ReadonlyWalletConfig as a5, type ExitCaptureMode as a6, type ExitDataSource as a7, type IReadonlyAssetManager as a8, type ContractSyncState as a9, type GetContractsFilter as aA, type GetSpendablePathsOptions as aB, type GetAllSpendingPathsOptions as aC, type IssuanceParams as aD, type ReissuanceParams as aE, type BurnParams as aF, type RenewVtxosOptions as aG, type PathSelection as aH, type ContractEvent as aI, type AssetDetails as aJ, type IssuanceResult as aK, type DelegateInfo as aL, type MigrationGlobalSkipReason as aM, type MigrationLegSkipReason as aN, type SignerStatus as aO, type StorageConfig as aP, type IVtxoManager as aQ, type ExplorerTransaction as aR, type EncodedVtxoScript as aS, type Status as aT, type ChainTx as aU, type PathContext as aV, type ActivityIntent as aW, type ActivityResolver as aX, type ArkIntentState as aY, type ArkTapscript as aZ, type AssetMetadata as a_, type RecipientAddressContext as aa, type NetworkName as ab, type ArkInfo as ac, ArkAddress as ad, type ContractWithVtxos as ae, selectPendingRecoveryOutpoints as af, type Coin as ag, ContractManager as ah, type ContractManagerConfig as ai, type SettlementConfig as aj, VtxoManager as ak, type SignerSession as al, type SignedIntent as am, Intent as an, type TimeHeight as ao, type DescriptorSigningRequest as ap, Transaction as aq, type IntentFeeConfig as ar, type OffchainInput as as, FeeAmount as at, type OnchainInput as au, type FeeOutput as av, type ContractWatcherConfig as aw, type Asset as ax, type FeeInfo as ay, type CreateContractParams as az, type WalletConfig as b, TapTreeCoder as b$, type BaseWalletConfig as b0, type BatchInfo as b1, type BatchSignableIdentity as b2, CLTVMultisigTapscript as b3, type CandidateDeps as b4, ChainTxType as b5, type CommitmentTx as b6, ConditionCSVMultisigTapscript as b7, ConditionMultisigTapscript as b8, type ContractBalance as b9, INTENT_TERMINAL_STATES as bA, IndexerTxType as bB, type KnownMetadata as bC, MUTINYNET_EMULATOR_PUBKEY as bD, type MigrateDeprecatedSignerOptions as bE, type MigrationLegReport as bF, type MigrationVtxoRef as bG, MultisigTapscript as bH, type Nonces as bI, type Output as bJ, type PageResponse as bK, type PaginationOptions as bL, PartialSig as bM, type ProviderClass as bN, REGTEST_EMULATOR_PUBKEY as bO, RestDelegateProvider as bP, RestDelegatorProvider as bQ, type ScanContractsOptions as bR, type ScanResult as bS, type ScheduledSession as bT, SettlementEventType as bU, type SignRequest as bV, type SignerClassification as bW, type SignerSet as bX, type SubscriptionEvent as bY, type SubscriptionHeartbeat as bZ, type TapLeaves as b_, type ContractEventCallback as ba, type ContractHandler as bb, type ContractState as bc, type ContractVtxo as bd, ContractWatcher as be, DelegateManagerImpl as bf, type DelegateOptions as bg, DelegatorManagerImpl as bh, type DelegatorProvider as bi, type DeprecatedSignerMigrationReport as bj, type DeprecatedSignerReport as bk, DigestMismatchError as bl, type Discoverable as bm, type DiscoveredContract as bn, type DiscoveryDeps as bo, ESPLORA_URL as bp, EsploraProvider as bq, type EventSourceCapable as br, type EventSourceFactory as bs, type EventSourceLike as bt, EventSourceUnavailableError as bu, type ExitChainResolver as bv, type ExtendedContractVtxo as bw, type GroupMembership as bx, type HandlerError as by, type IDelegatorManager as bz, type WalletBalance as c, TapscriptType as c0, type TreeNonces as c1, type TreePartialSigs as c2, type Tx as c3, type TxHistoryRecord as c4, type TxKey as c5, type TxTag as c6, type TxTreeNode as c7, TxType as c8, type VirtualStatus as c9, isExpired as cA, isPastExpiry as cB, isRecoverable as cC, isSigningIdentity as cD, isSpendable as cE, isSubdust as cF, isTerminalIntentState as cG, isVirtualCoin as cH, isVtxoExpiringSoon as cI, networks as cJ, resolveEmulatorPubkey as cK, resolveEventSource as cL, scriptFromTapLeafScript as cM, signerSetFromInfo as cN, toXOnlySignerHex as cO, type TapscriptDeriving as cP, type Vtxo as ca, type VtxoChain as cb, type VtxoType as cc, type WalletMode as cd, assetMintResolver as ce, boardingResolver as cf, canRecoverOnchain as cg, canSpendOffchain as ch, classifyAgainstSignerSet as ci, classifyContractSigner as cj, collabExitResolver as ck, configureEventSource as cl, createDefaultActivityRegistry as cm, createExitChainResolver as cn, decodeTapscript as co, defaultEmulatorPubkey as cp, getConfiguredEventSource as cq, getNetwork as cr, getRandomId as cs, getSequence as ct, hasCandidates as cu, hasTerminalSpend as cv, isBatchSignable as cw, isCooperativelyMigratable as cx, isDiscoverable as cy, isEventSourceUnavailableError as cz, ActivityRegistry as d, type Activity as e, type IContractManager as f, type IDelegateManager as g, type SettleParams as h, type SettlementEvent as i, type SendParams as j, type IAssetManager as k, RestArkProvider as l, RestIndexerProvider as m, type SubscriptionResponse as n, type ArkProvider as o, type IndexerProvider as p, type RelativeTimelock as q, type TapLeafScript as r, type VirtualCoin as s, type Contract as t, type ExtendedVirtualCoin as u, type VtxoRepositoryKey as v, type WalletState as w, type ContractFilter as x, type IntentRepository as y, type ArkIntent as z };
+export { type TreeTxEvent as $, type ArkTransaction as A, type IntentFilter as B, type ContractRepository as C, type VirtualTxRepository as D, type ExtendedCoin as E, type VirtualTx as F, type GetVtxosFilter as G, type VtxoBranch as H, type IWallet as I, ChainedTxType as J, type DescriptorProvider as K, type Network as L, CSVMultisigTapscript as M, type NormalizedExtendedVirtualCoin as N, type Outpoint as O, type BatchStartedEvent as P, type TreeSigningStartedEvent as Q, type Recipient as R, type SendBitcoinParams as S, type TxNotificationEvent as T, TxTree as U, VtxoScript as V, type WalletRepository as W, type TreeNoncesEvent as X, type BatchFinalizationEvent as Y, type BatchFinalizedEvent as Z, type BatchFailedEvent as _, type Identity as a, BITCOIN_EMULATOR_PUBKEY as a$, type TreeSignatureEvent as a0, type IReadonlyWallet as a1, type ReadonlyIdentity as a2, type OnchainProvider as a3, type DelegateProvider as a4, type ReadonlyWalletConfig as a5, type ExitCaptureMode as a6, type ExitDataSource as a7, type IReadonlyAssetManager as a8, type ContractSyncState as a9, type GetContractsFilter as aA, type GetSpendablePathsOptions as aB, type GetAllSpendingPathsOptions as aC, type IssuanceParams as aD, type ReissuanceParams as aE, type BurnParams as aF, type RenewVtxosOptions as aG, type PathSelection as aH, type ContractEvent as aI, type AssetDetails as aJ, type IssuanceResult as aK, type DelegateInfo as aL, type MigrationGlobalSkipReason as aM, type MigrationLegSkipReason as aN, type SignerStatus as aO, type StorageConfig as aP, type IVtxoManager as aQ, type ExplorerTransaction as aR, type EncodedVtxoScript as aS, type Status as aT, type ChainTx as aU, type PathContext as aV, type ActivityIntent as aW, type ActivityResolver as aX, type ArkIntentState as aY, type ArkTapscript as aZ, type AssetMetadata as a_, type RecipientAddressContext as aa, type NetworkName as ab, type ArkInfo as ac, ArkAddress as ad, type ContractWithVtxos as ae, selectPendingRecoveryOutpoints as af, type Coin as ag, ContractManager as ah, type ContractManagerConfig as ai, type SettlementConfig as aj, VtxoManager as ak, type SignerSession as al, type SignedIntent as am, Intent as an, type TimeHeight as ao, type DescriptorSigningRequest as ap, Transaction as aq, type IntentFeeConfig as ar, type OffchainInput as as, FeeAmount as at, type OnchainInput as au, type FeeOutput as av, type ContractWatcherConfig as aw, type Asset as ax, type FeeInfo as ay, type CreateContractParams as az, type WalletConfig as b, type SweepTxNotification as b$, type BaseWalletConfig as b0, type BatchInfo as b1, type BatchSignableIdentity as b2, CLTVMultisigTapscript as b3, type CandidateDeps as b4, ChainTxType as b5, type CommitmentTx as b6, ConditionCSVMultisigTapscript as b7, ConditionMultisigTapscript as b8, type ContractBalance as b9, type IDelegatorManager as bA, INTENT_TERMINAL_STATES as bB, IndexerTxType as bC, type KnownMetadata as bD, MUTINYNET_EMULATOR_PUBKEY as bE, type MigrateDeprecatedSignerOptions as bF, type MigrationLegReport as bG, type MigrationVtxoRef as bH, MultisigTapscript as bI, type Nonces as bJ, type Output as bK, type PageResponse as bL, type PaginationOptions as bM, PartialSig as bN, type ProviderClass as bO, REGTEST_EMULATOR_PUBKEY as bP, RestDelegateProvider as bQ, RestDelegatorProvider as bR, type ScanContractsOptions as bS, type ScanResult as bT, type ScheduledSession as bU, SettlementEventType as bV, type SignRequest as bW, type SignerClassification as bX, type SignerSet as bY, type SubscriptionEvent as bZ, type SubscriptionHeartbeat as b_, type ContractEventCallback as ba, type ContractHandler as bb, type ContractState as bc, type ContractVtxo as bd, ContractWatcher as be, DEFAULT_VTXO_PAGE_SIZE as bf, DelegateManagerImpl as bg, type DelegateOptions as bh, DelegatorManagerImpl as bi, type DelegatorProvider as bj, type DeprecatedSignerMigrationReport as bk, type DeprecatedSignerReport as bl, DigestMismatchError as bm, type Discoverable as bn, type DiscoveredContract as bo, type DiscoveryDeps as bp, ESPLORA_URL as bq, EsploraProvider as br, type EventSourceCapable as bs, type EventSourceFactory as bt, type EventSourceLike as bu, EventSourceUnavailableError as bv, type ExitChainResolver as bw, type ExtendedContractVtxo as bx, type GroupMembership as by, type HandlerError as bz, type WalletBalance as c, type TapLeaves as c0, TapTreeCoder as c1, TapscriptType as c2, type TreeNonces as c3, type TreePartialSigs as c4, type Tx as c5, type TxHistoryRecord as c6, type TxKey as c7, type TxNotification as c8, type TxTag as c9, isCooperativelyMigratable as cA, isDiscoverable as cB, isEventSourceUnavailableError as cC, isExpired as cD, isPastExpiry as cE, isRecoverable as cF, isSigningIdentity as cG, isSpendable as cH, isSubdust as cI, isTerminalIntentState as cJ, isVirtualCoin as cK, isVtxoExpiringSoon as cL, networks as cM, resolveEmulatorPubkey as cN, resolveEventSource as cO, scriptFromTapLeafScript as cP, signerSetFromInfo as cQ, toXOnlySignerHex as cR, type TapscriptDeriving as cS, type TxTreeNode as ca, TxType as cb, type VirtualStatus as cc, type Vtxo as cd, type VtxoChain as ce, type VtxoType as cf, type WalletMode as cg, assetMintResolver as ch, boardingResolver as ci, canRecoverOnchain as cj, canSpendOffchain as ck, classifyAgainstSignerSet as cl, classifyContractSigner as cm, collabExitResolver as cn, configureEventSource as co, createDefaultActivityRegistry as cp, createExitChainResolver as cq, decodeTapscript as cr, defaultEmulatorPubkey as cs, getConfiguredEventSource as ct, getNetwork as cu, getRandomId as cv, getSequence as cw, hasCandidates as cx, hasTerminalSpend as cy, isBatchSignable as cz, ActivityRegistry as d, type Activity as e, type IContractManager as f, type IDelegateManager as g, type SettleParams as h, type SettlementEvent as i, type SendParams as j, type IAssetManager as k, RestArkProvider as l, RestIndexerProvider as m, type SubscriptionResponse as n, type ArkProvider as o, type IndexerProvider as p, type RelativeTimelock as q, type TapLeafScript as r, type VirtualCoin as s, type Contract as t, type ExtendedVirtualCoin as u, type VtxoRepositoryKey as v, type WalletState as w, type ContractFilter as x, type IntentRepository as y, type ArkIntent as z };