@arkade-os/sdk 0.4.14 → 0.4.16

package/dist/cjs/wallet/serviceWorker/wallet.js

@@ -182,6 +182,13 @@ class ServiceWorkerReadonlyWallet {
     getTimeoutForRequest(request) {
         return this.messageTimeouts[request.type] ?? 30000;
     }
+    /**
+     * Create a readonly service-worker wallet bound to an already-registered worker.
+     *
+     * @param options - Service worker, identity, and backend configuration
+     * @returns Initialized readonly service-worker wallet
+     * @throws Error if service-worker initialization fails
+     */
     static async create(options) {
         const walletRepository = options.storage?.walletRepository ??
             new repositories_1.IndexedDBWalletRepository();
@@ -242,23 +249,17 @@ class ServiceWorkerReadonlyWallet {
         return wallet;
     }
     /**
-     * Simplified setup method that handles service worker registration,
-     * identity creation, and wallet initialization automatically.
+     * Simplified setup method that handles service worker registration
+     * and wallet initialization automatically.
+     *
+     * @see ServiceWorkerReadonlyWallet.create
      *
      * @example
      * ```typescript
-     * // One-liner setup - handles everything automatically!
      * const wallet = await ServiceWorkerReadonlyWallet.setup({
      *   serviceWorkerPath: '/service-worker.js',
-     *   arkServerUrl: 'https://mutinynet.arkade.sh'
-     * });
-     *
-     * // With custom readonly identity
-     * const identity = ReadonlySingleKey.fromPublicKey('your_public_key_hex');
-     * const wallet = await ServiceWorkerReadonlyWallet.setup({
-     *   serviceWorkerPath: '/service-worker.js',
-     *   arkServerUrl: 'https://mutinynet.arkade.sh',
-     *   identity
+     *   arkServerUrl: 'https://arkade.computer',
+     *   identity: ReadonlySingleKey.fromPublicKey('your_public_key_hex')
      * });
      * ```
      */
@@ -460,6 +461,7 @@ class ServiceWorkerReadonlyWallet {
         });
         return this.reinitPromise;
     }
+    /** Clear cached wallet state from both the page and service worker storage. */
     async clear() {
         const message = {
             id: (0, utils_2.getRandomId)(),
@@ -532,6 +534,11 @@ class ServiceWorkerReadonlyWallet {
             throw new Error(`Failed to get boarding UTXOs: ${error}`);
         }
     }
+    /**
+     * Return service-worker wallet status, including connectivity and sync state.
+     *
+     * @returns Current service-worker wallet status payload including `walletInitalized` and `xOnlyPublicKey`
+     */
     async getStatus() {
         const message = {
             id: (0, utils_2.getRandomId)(),
@@ -576,6 +583,11 @@ class ServiceWorkerReadonlyWallet {
             throw new Error(`Failed to get vtxos: ${error}`);
         }
     }
+    /**
+     * Trigger a wallet reload inside the service worker.
+     *
+     * @returns `true` when the wallet was reloaded
+     */
     async reload() {
         const message = {
             id: (0, utils_2.getRandomId)(),
@@ -855,23 +867,15 @@ class ServiceWorkerWallet extends ServiceWorkerReadonlyWallet {
         return wallet;
     }
     /**
-     * Simplified setup method that handles service worker registration,
-     * identity creation, and wallet initialization automatically.
+     * Simplified setup method that handles service worker registration
+     * and wallet initialization automatically.
      *
      * @example
      * ```typescript
-     * // One-liner setup - handles everything automatically!
-     * const wallet = await ServiceWorkerWallet.setup({
-     *   serviceWorkerPath: '/service-worker.js',
-     *   arkServerUrl: 'https://mutinynet.arkade.sh'
-     * });
-     *
-     * // With custom identity
-     * const identity = SingleKey.fromHex('your_private_key_hex');
      * const wallet = await ServiceWorkerWallet.setup({
      *   serviceWorkerPath: '/service-worker.js',
-     *   arkServerUrl: 'https://mutinynet.arkade.sh',
-     *   identity
+     *   arkServerUrl: 'https://arkade.computer',
+     *   identity: MnemonicIdentity.fromMnemonic('abandon abandon...')
      * });
      * ```
      */

package/dist/cjs/wallet/unroll.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Unroll = void 0;
 const base_1 = require("@scure/base");
 const btc_signer_1 = require("@scure/btc-signer");
+const helpers_1 = require("../contracts/handlers/helpers");
 const indexer_1 = require("../providers/indexer");
 const base_2 = require("../script/base");
 const txSizeEstimator_1 = require("../utils/txSizeEstimator");
@@ -18,7 +19,7 @@ var Unroll;
         StepType[StepType["DONE"] = 2] = "DONE";
     })(StepType = Unroll.StepType || (Unroll.StepType = {}));
     /**
-     * Manages the unrolling process of a VTXO back to the Bitcoin blockchain.
+     * Manages the unrolling process of a virtual output back to the Bitcoin blockchain.
      *
      * The Session class implements an async iterator that processes the unrolling steps:
      * 1. **WAIT**: Waits for a transaction to be confirmed onchain (if it's in mempool)
@@ -42,19 +43,21 @@ var Unroll;
      *       console.log(`Broadcasting transaction ${doneStep.tx.id}`);
      *       break;
      *     case Unroll.StepType.DONE:
-     *       console.log(`Unrolling complete for VTXO ${doneStep.vtxoTxid}`);
+     *       console.log(`Unrolling complete for virtual output ${doneStep.vtxoTxid}`);
      *       break;
      *   }
      * }
      * ```
      **/
     class Session {
+        /** Create an unroll session from a virtual output outpoint and its dependency chain. */
         constructor(toUnroll, bumper, explorer, indexer) {
             this.toUnroll = toUnroll;
             this.bumper = bumper;
             this.explorer = explorer;
             this.indexer = indexer;
         }
+        /** Create an unroll session by loading the virtual output chain from the indexer. */
         static async create(toUnroll, bumper, explorer, indexer) {
             const { chain } = await indexer.getVtxoChain(toUnroll);
             return new Session({ ...toUnroll, chain }, bumper, explorer, indexer);
@@ -123,7 +126,7 @@ var Unroll;
                 });
             }
             else {
-                // finalize ark transaction
+                // finalize Arkade transaction
                 tx.finalize();
             }
             return {
@@ -153,11 +156,11 @@ var Unroll;
     }
     Unroll.Session = Session;
     /**
-     * Complete the unroll of a VTXO by broadcasting the transaction that spends the CSV path.
-     * @param wallet the wallet owning the VTXO(s)
-     * @param vtxoTxids the txids of the VTXO(s) to complete unroll
+     * Complete the unroll of a virtual output by broadcasting the transaction that spends the CSV path.
+     * @param wallet the wallet owning the virtual output(s)
+     * @param vtxoTxids the txids of the virtual output(s) to complete unroll
      * @param outputAddress the address to send the unrolled funds to
-     * @throws if the VTXO(s) are not fully unrolled, if the txids are not found, if the tx is not confirmed, if no exit path is found or not available
+     * @throws if the virtual output(s) are not fully unrolled, if the txids are not found, if the tx is not confirmed, if no exit path is found or not available
      * @returns the txid of the transaction spending the unrolled funds
      */
     async function completeUnroll(wallet, vtxoTxids, outputAddress) {
@@ -187,11 +190,12 @@ var Unroll;
                 throw new Error(`spending leaf not found for vtxo ${vtxo.txid}:${vtxo.vout}`);
             }
             totalAmount += BigInt(vtxo.value);
+            const sequence = (0, helpers_1.timelockToSequence)(exit.params.timelock);
             inputs.push({
                 txid: vtxo.txid,
                 index: vtxo.vout,
                 tapLeafScript: [spendingLeaf],
-                sequence: 0xffffffff - 1,
+                sequence,
                 witnessUtxo: {
                     amount: BigInt(vtxo.value),
                     script: base_2.VtxoScript.decode(vtxo.tapTree).pkScript,

package/dist/cjs/wallet/utils.js

@@ -61,7 +61,7 @@ function validateRecipients(recipients, dustAmount) {
             address = __1.ArkAddress.decode(recipient.address);
         }
         catch (e) {
-            throw new Error(`Invalid Ark address: ${recipient.address}`);
+            throw new Error(`Invalid Arkade address: ${recipient.address}`);
         }
         const amount = recipient.amount || dustAmount;
         if (amount <= 0) {