@arkade-os/sdk 0.4.14 → 0.4.16

package/dist/types/utils/transactionHistory.d.ts

@@ -3,13 +3,13 @@ type ExtendedArkTransaction = ArkTransaction & {
     tag: "offchain" | "boarding" | "exit" | "batch";
 };
 /**
- * Builds the transaction history by analyzing virtual coins (VTXOs), boarding transactions, and ignored commitments.
+ * Builds the transaction history by analyzing virtual outputs, boarding transactions, and ignored commitments.
  * History is sorted from newest to oldest and is composed only of SENT and RECEIVED transactions.
  *
- * @param {VirtualCoin[]} vtxos - An array of virtual coins representing the user's transactions and balances.
+ * @param {VirtualCoin[]} vtxos - An array of virtual outputs representing the user's transactions and balances.
  * @param {ArkTransaction[]} allBoardingTxs - An array of boarding transactions to include in the history.
  * @param {Set<string>} commitmentsToIgnore - A set of commitment IDs that should be excluded from processing.
- * @return {ExtendedArkTransaction[]} A sorted array of extended Ark transactions, representing the transaction history.
+ * @return {ExtendedArkTransaction[]} A sorted array of extended Arkade transactions, representing the transaction history.
  */
 export declare function buildTransactionHistory(vtxos: VirtualCoin[], allBoardingTxs: ArkTransaction[], commitmentsToIgnore: Set<string>, getTxCreatedAt?: (txid: string) => Promise<number | undefined>): Promise<ExtendedArkTransaction[]>;
 export {};

package/dist/types/utils/unknownFields.d.ts

@@ -1,7 +1,7 @@
 import { Transaction } from "@scure/btc-signer";
 import { TransactionInputUpdate } from "@scure/btc-signer/psbt.js";
 /**
- * ArkPsbtFieldKey is the key values for ark psbt fields.
+ * ArkPsbtFieldKey are the available key names for the Arkade PSBT custom fields.
  */
 export declare enum ArkPsbtFieldKey {
     VtxoTaprootTree = "taptree",
@@ -10,13 +10,13 @@ export declare enum ArkPsbtFieldKey {
     ConditionWitness = "condition"
 }
 /**
- * ArkPsbtFieldKeyType is the type of the ark psbt field key.
- * Every ark psbt field has key type 222.
+ * ArkPsbtFieldKeyType is the key type of the Arkade PSBT custom field.
+ * Every Arkade PSBT field has key type 222.
  */
 export declare const ArkPsbtFieldKeyType = 222;
 /**
- * ArkPsbtFieldCoder is the coder for the ark psbt fields.
- * each type has its own coder.
+ * ArkPsbtFieldCoder is the coder for the Arkade PSBT custom fields.
+ * Each type has its own coder.
  */
 export interface ArkPsbtFieldCoder<T> {
     key: ArkPsbtFieldKey;

package/dist/types/wallet/asset-manager.d.ts

@@ -15,7 +15,7 @@ export declare class AssetManager extends ReadonlyAssetManager implements IAsset
      * @param params.amount - Amount of asset units to issue
      * @param params.controlAssetId - Optional control asset ID (for reissuable assets)
      * @param params.metadata - Optional metadata to attach to the asset
-     * @returns Promise resolving to the ark transaction ID and asset ID
+     * @returns Promise resolving to the Arkade transaction ID and asset ID
      *
      * @example
      * ```typescript
@@ -39,7 +39,7 @@ export declare class AssetManager extends ReadonlyAssetManager implements IAsset
      * @param params - Parameters for asset reissuance
      * @param params.assetId - The asset ID to reissue (control asset ID is resolved via getAssetDetails)
      * @param params.amount - Amount of additional units to issue
-     * @returns Promise resolving to the ark transaction ID
+     * @returns Promise resolving to the Arkade transaction ID
      *
      * @example
      * ```typescript
@@ -55,7 +55,7 @@ export declare class AssetManager extends ReadonlyAssetManager implements IAsset
      * @param params - Parameters for burning
      * @param params.assetId - The asset ID to burn
      * @param params.amount - Amount of units to burn
-     * @returns Promise resolving to the ark transaction ID
+     * @returns Promise resolving to the Arkade transaction ID
      *
      * @example
      * ```typescript

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

@@ -10,7 +10,7 @@ import { TxTree } from "../tree/txTree";
  * const handler = wallet.createBatchHandler(intentId, inputs, expectedRecipients, musig2session);
  *
  * const abortController = new AbortController();
- * // Get event stream from Ark provider
+ * // Get event stream from the Arkade provider
  * const eventStream = arkProvider.getEventStream(
  *   abortController.signal,
  *   ['your-topic-1', 'your-topic-2']
@@ -39,7 +39,7 @@ export declare namespace Batch {
         /**
          * Called when tree signing starts.
          * @param event The tree signing started event.
-         * @param vtxoTree The unsigned VTXO tree, reconstructed from the TreeTxEvent events.
+         * @param vtxoTree The unsigned virtual output tree, reconstructed from the TreeTxEvent events.
          * @returns Promise resolving to a boolean indicating whether to continue processing.
          */
         onTreeSigningStarted(event: TreeSigningStartedEvent, vtxoTree: TxTree): Promise<{
@@ -56,21 +56,41 @@ export declare namespace Batch {
         /**
          * Called during batch finalization.
          * @param event The batch finalization event.
-         * @param vtxoTree The signed VTXO tree, reconstructed from the TreeTxEvent events.
+         * @param vtxoTree The signed virtual output tree, reconstructed from the TreeTxEvent events.
          * @param connectorTree The connector transaction tree, reconstructed from the TreeTxEvent events.
          */
         onBatchFinalization(event: BatchFinalizationEvent, vtxoTree?: TxTree, connectorTree?: TxTree): Promise<void>;
+        /**
+         * Called when batch finalization completes successfully.
+         *
+         * @param event - Batch finalized event
+         */
         onBatchFinalized?(event: BatchFinalizedEvent): Promise<void>;
+        /**
+         * Called when batch processing fails.
+         *
+         * @param event - Batch failed event
+         */
         onBatchFailed?(event: BatchFailedEvent): Promise<void>;
+        /**
+         * Called for each virtual output tree transaction chunk received during batch processing.
+         *
+         * @param event - Tree transaction event
+         */
         onTreeTxEvent?(event: TreeTxEvent): Promise<void>;
+        /**
+         * Called for each tree signature event received during batch processing.
+         *
+         * @param event - Tree signature event
+         */
         onTreeSignatureEvent?(event: TreeSignatureEvent): Promise<void>;
     }
     /**
      * Options for the join function.
-     * @param @optional abortController - The abort controller to use to abort the operation.
-     * @param @optional skipVtxoTreeSigning - ignore events related to vtxo tree musig2 signing session.
-     * @param @optional eventCallback - A callback to be called for each event.
-     * @param eventCallback - A callback to be called for each event.
+     *
+     * @property abortController - Abort controller used to cancel batch processing.
+     * @property skipVtxoTreeSigning - Ignore events related to the virtual output tree musig2 signing session.
+     * @property eventCallback - Callback invoked for each settlement event received while joining the batch.
      */
     type JoinOptions = Partial<{
         abortController: AbortController;

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

@@ -3,6 +3,14 @@ import { ArkProvider, DelegateInfo, ExtendedVirtualCoin, Identity, Outpoint } fr
 import { DelegatorProvider } from "../providers/delegator";
 import { Bytes } from "@scure/btc-signer/utils";
 export interface IDelegatorManager {
+    /**
+     * Delegate virtual outputs to the remote delegation service.
+     *
+     * @param vtxos - Virtual outputs to delegate
+     * @param destination - Arkade address that should receive renewed funds
+     * @param delegateAt - Optional timestamp to force a specific delegation time
+     * @returns Successfully delegated and failed outpoint groups
+     */
     delegate(vtxos: ExtendedVirtualCoin[], destination: string, delegateAt?: Date): Promise<{
         delegated: Outpoint[];
         failed: {
@@ -10,12 +18,14 @@ export interface IDelegatorManager {
             error: unknown;
         }[];
     }>;
+    /** Fetch delegate metadata such as pubkey, fee, and delegate address. */
     getDelegateInfo(): Promise<DelegateInfo>;
 }
 export declare class DelegatorManagerImpl implements IDelegatorManager {
     readonly delegatorProvider: DelegatorProvider;
     readonly arkInfoProvider: Pick<ArkProvider, "getInfo">;
     readonly identity: Identity;
+    /** Create a delegator manager from the configured provider, Arkade info source, and wallet identity. */
     constructor(delegatorProvider: DelegatorProvider, arkInfoProvider: Pick<ArkProvider, "getInfo">, identity: Identity);
     getDelegateInfo(): Promise<DelegateInfo>;
     delegate(vtxos: ExtendedVirtualCoin[], destination: string, delegateAt?: Date): Promise<{

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

@@ -3,7 +3,7 @@ import type { ContractRepository } from "../../repositories/contractRepository";
 import type { AsyncStorageTaskQueue } from "../../worker/expo/asyncStorageTaskQueue";
 import type { TaskProcessor } from "../../worker/expo/taskRunner";
 /**
- * Wallet parameters persisted by {@link ExpoWallet.setup} and read
+ * Wallet parameters persisted by @see ExpoWallet.setup and read
  * by the background handler to reconstruct providers and `extendVtxo`
  * without a network call.
  */
@@ -15,7 +15,7 @@ export interface PersistedBackgroundConfig {
     exitTimelockType: "blocks" | "seconds";
 }
 /**
- * Options for {@link defineExpoBackgroundTask}.
+ * Options for @see defineExpoBackgroundTask.
  */
 export interface DefineBackgroundTaskOptions {
     /** AsyncStorage-backed queue (must match the one passed to ExpoWallet.setup). */
@@ -52,8 +52,8 @@ export declare function defineExpoBackgroundTask(taskName: string, options: Defi
 /**
  * Activate the OS-level background task scheduler.
  *
- * Call this after {@link defineExpoBackgroundTask} (typically inside
- * {@link ExpoWallet.setup} or in a React component after wallet init).
+ * 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).
  */

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

@@ -7,7 +7,7 @@ import type { IDelegatorManager } from "../delegator";
 import type { TaskQueue } from "../../worker/expo/taskQueue";
 import type { TaskProcessor } from "../../worker/expo/taskRunner";
 /**
- * Background processing configuration for {@link ExpoWallet}.
+ * Background processing configuration for @see ExpoWallet.
  */
 export interface ExpoBackgroundConfig {
     /** Identifier registered with expo-background-task. */
@@ -22,7 +22,7 @@ export interface ExpoBackgroundConfig {
     minimumBackgroundInterval?: number;
 }
 /**
- * Configuration for {@link ExpoWallet.setup}.
+ * Configuration for @see ExpoWallet.setup.
  */
 export interface ExpoWalletConfig extends WalletConfig {
     background: ExpoBackgroundConfig;
@@ -30,7 +30,7 @@ export interface ExpoWalletConfig extends WalletConfig {
 /**
  * Expo/React Native wallet with built-in background task processing.
  *
- * Wraps a standard {@link Wallet} and adds a lightweight task queue
+ * Wraps a standard @see Wallet and adds a lightweight task queue
  * for keeping contract/VTXO state fresh while the app is active and
  * across Expo BackgroundTask wakes.
  *
@@ -40,10 +40,10 @@ export interface ExpoWalletConfig extends WalletConfig {
  * import { AsyncStorageTaskQueue } from "@arkade-os/sdk/worker/expo";
  *
  * const wallet = await ExpoWallet.setup({
- *     identity: SingleKey.fromHex(privateKey),
- *     arkServerUrl,
- *     esploraUrl,
- *     storage: { walletRepository, contractRepository },
+ *     identity: MnemonicIdentity.fromMnemonic('abandon abandon...'),
+ *     arkServerUrl: 'https://arkade.computer',
+ *     esploraUrl: 'https://mempool.space/api',
+ *     storage: { ... },
  *     background: {
  *         taskName: "ark-background-poll",
  *         taskQueue: new AsyncStorageTaskQueue(AsyncStorage),
@@ -69,8 +69,8 @@ export declare class ExpoWallet implements IWallet {
     /**
      * Create an ExpoWallet with background task support.
      *
-     * 1. Creates the inner {@link Wallet} via `Wallet.create()`.
-     * 2. Wires up processors (defaults to {@link contractPollProcessor}).
+     * 1. Creates the inner @see Wallet via `Wallet.create()`.
+     * 2. Wires up processors (defaults to @see contractPollProcessor).
      * 3. Persists background config for the background handler (if the queue supports it).
      * 4. Seeds the task queue with a `contract-poll` task.
      * 5. Registers the background task with the OS scheduler (if `minimumBackgroundInterval` is set).
@@ -94,6 +94,6 @@ export declare class ExpoWallet implements IWallet {
     getDelegatorManager(): Promise<IDelegatorManager | undefined>;
     sendBitcoin(params: SendBitcoinParams): Promise<string>;
     settle(params?: SettleParams, eventCallback?: (event: SettlementEvent) => void): Promise<string>;
-    send(...recipients: Recipient[]): Promise<string>;
+    send(...recipients: [Recipient, ...Recipient[]]): Promise<string>;
     get assetManager(): IAssetManager;
 }