@arkade-os/sdk 0.1.1 → 0.1.2

package/README.md

@@ -117,18 +117,26 @@ new Worker().start()
 ```typescript
 // specify the path to the service worker file
 // this will automatically register the service worker
-const wallet = await ServiceWorkerWallet.create('/service-worker.js')
+const serviceWorker = await setupServiceWorker('/service-worker.js')
+const wallet = new ServiceWorkerWallet(serviceWorker)
 
 // initialize the wallet
 await wallet.init({
   network: 'mutinynet',  // 'bitcoin', 'testnet', 'regtest', 'signet' or 'mutinynet'
-  identity: identity,
+  privateKey: 'your_private_key_hex',
   // Esplora API, can be left empty mempool.space API will be used
   esploraUrl: 'https://mutinynet.com/api', 
   // OPTIONAL Ark Server connection information
   arkServerUrl: 'https://mutinynet.arkade.sh',
   arkServerPublicKey: 'fa73c6e4876ffb2dfc961d763cca9abc73d4b88efcb8f5e7ff92dc55e9aa553d'
 })
+
+// check service worker status
+const status = await wallet.getStatus()
+console.log('Service worker status:', status.walletInitialized)
+
+// clear wallet data stored in the service worker memory
+await wallet.clear()
 ```
 
 ## API Reference
@@ -149,6 +157,10 @@ interface WalletConfig {
   arkServerUrl?: string;
   /** Ark server public key (optional) */
   arkServerPublicKey?: string;
+  /** Optional boarding timelock configuration */
+  boardingTimelock?: RelativeTimelock;
+  /** Optional exit timelock configuration */
+  exitTimelock?: RelativeTimelock;
 }
 ```
 
@@ -175,7 +187,9 @@ interface IWallet {
       total: number;
       settled: number;
       pending: number;
+      swept: number;
     };
+    total: number;
   }>;
 
   /** Send bitcoin (on-chain or off-chain) */
@@ -183,7 +197,8 @@ interface IWallet {
     address: string;
     amount: number;
     feeRate?: number;
-  }, onchain?: boolean): Promise<string>;
+    memo?: string;
+  }, zeroFee?: boolean): Promise<string>;
 
   /** Get virtual UTXOs */
   getVtxos(): Promise<VirtualCoin[]>;
@@ -228,6 +243,8 @@ interface VirtualCoin {
   virtualStatus: {
     state: 'pending' | 'settled';
   };
+  spentBy?: string;
+  createdAt: Date;
 }
 
 /** Boarding UTXO */

package/dist/cjs/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.IndexedDBVtxoRepository = exports.networks = exports.ArkNoteData = exports.ArkNote = exports.createVirtualTx = exports.CONDITION_WITNESS_KEY_PREFIX = exports.addConditionWitness = exports.CLTVMultisigTapscript = exports.ConditionMultisigTapscript = exports.ConditionCSVMultisigTapscript = exports.CSVMultisigTapscript = exports.MultisigTapscript = exports.decodeTapscript = exports.Response = exports.Request = exports.Worker = exports.TxType = exports.VHTLC = exports.VtxoScript = exports.DefaultVtxo = exports.ArkAddress = exports.RestArkProvider = exports.EsploraProvider = exports.ESPLORA_URL = exports.InMemoryKey = exports.ServiceWorkerWallet = exports.Wallet = void 0;
+exports.IndexedDBVtxoRepository = exports.networks = exports.ArkNoteData = exports.ArkNote = exports.createVirtualTx = exports.CONDITION_WITNESS_KEY_PREFIX = exports.addConditionWitness = exports.CLTVMultisigTapscript = exports.ConditionMultisigTapscript = exports.ConditionCSVMultisigTapscript = exports.CSVMultisigTapscript = exports.MultisigTapscript = exports.decodeTapscript = exports.Response = exports.Request = exports.ServiceWorkerWallet = exports.Worker = exports.setupServiceWorker = exports.TxType = exports.VHTLC = exports.VtxoScript = exports.DefaultVtxo = exports.ArkAddress = exports.RestArkProvider = exports.EsploraProvider = exports.ESPLORA_URL = exports.InMemoryKey = exports.Wallet = void 0;
 const inMemoryKey_1 = require("./identity/inMemoryKey");
 Object.defineProperty(exports, "InMemoryKey", { enumerable: true, get: function () { return inMemoryKey_1.InMemoryKey; } });
 const address_1 = require("./script/address");
@@ -17,6 +17,8 @@ const wallet_1 = require("./wallet/wallet");
 Object.defineProperty(exports, "Wallet", { enumerable: true, get: function () { return wallet_1.Wallet; } });
 const wallet_2 = require("./wallet/serviceWorker/wallet");
 Object.defineProperty(exports, "ServiceWorkerWallet", { enumerable: true, get: function () { return wallet_2.ServiceWorkerWallet; } });
+const utils_1 = require("./wallet/serviceWorker/utils");
+Object.defineProperty(exports, "setupServiceWorker", { enumerable: true, get: function () { return utils_1.setupServiceWorker; } });
 const worker_1 = require("./wallet/serviceWorker/worker");
 Object.defineProperty(exports, "Worker", { enumerable: true, get: function () { return worker_1.Worker; } });
 const request_1 = require("./wallet/serviceWorker/request");

package/dist/cjs/providers/ark.js

@@ -368,6 +368,12 @@ class RestArkProvider {
                 }
             }
             catch (error) {
+                // ignore timeout errors, they're expected when the server is not sending anything for 5 min
+                // these timeouts are set by builtin fetch function
+                if (isFetchTimeoutError(error)) {
+                    console.debug("Timeout error ignored");
+                    continue;
+                }
                 console.error("Address subscription error:", error);
                 throw error;
             }
@@ -545,3 +551,13 @@ function convertVtxo(vtxo) {
         createdAt: new Date(vtxo.createdAt * 1000),
     };
 }
+function isFetchTimeoutError(err) {
+    const checkError = (error) => {
+        return (error instanceof Error &&
+            (error.name === "HeadersTimeoutError" ||
+                error.name === "BodyTimeoutError" ||
+                error.code === "UND_ERR_HEADERS_TIMEOUT" ||
+                error.code === "UND_ERR_BODY_TIMEOUT"));
+    };
+    return checkError(err) || checkError(err.cause);
+}

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

@@ -0,0 +1,48 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setupServiceWorker = setupServiceWorker;
+async function setupServiceWorker(path) {
+    // check if service workers are supported
+    if (!("serviceWorker" in navigator)) {
+        throw new Error("Service workers are not supported in this browser");
+    }
+    // check for existing registration
+    const existingRegistration = await navigator.serviceWorker.getRegistration(path);
+    let registration;
+    if (existingRegistration) {
+        registration = existingRegistration;
+        // Force unregister and re-register to ensure we get the latest version
+        await existingRegistration.unregister();
+    }
+    registration = await navigator.serviceWorker.register(path);
+    // Handle updates
+    registration.addEventListener("updatefound", () => {
+        const newWorker = registration.installing;
+        if (!newWorker)
+            return;
+        newWorker.addEventListener("statechange", () => {
+            if (newWorker.state === "activated" &&
+                navigator.serviceWorker.controller) {
+                console.info("Service worker activated, reloading...");
+                window.location.reload();
+            }
+        });
+    });
+    const serviceWorker = registration.active || registration.waiting || registration.installing;
+    if (!serviceWorker) {
+        throw new Error("Failed to get service worker instance");
+    }
+    // wait for the service worker to be ready
+    if (serviceWorker.state !== "activated") {
+        await new Promise((resolve) => {
+            if (!serviceWorker)
+                return resolve();
+            serviceWorker.addEventListener("statechange", () => {
+                if (serviceWorker.state === "activated") {
+                    resolve();
+                }
+            });
+        });
+    }
+    return serviceWorker;
+}

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

@@ -11,15 +11,8 @@ class UnexpectedResponseError extends Error {
 }
 // ServiceWorkerWallet is a wallet that uses a service worker as "backend" to handle the wallet logic
 class ServiceWorkerWallet {
-    static async create(svcWorkerPath) {
-        try {
-            const wallet = new ServiceWorkerWallet();
-            await wallet.setupServiceWorker(svcWorkerPath);
-            return wallet;
-        }
-        catch (error) {
-            throw new Error(`Failed to initialize service worker wallet: ${error}`);
-        }
+    constructor(serviceWorker) {
+        this.serviceWorker = serviceWorker;
     }
     async getStatus() {
         const message = {
@@ -64,64 +57,8 @@ class ServiceWorkerWallet {
         };
         await this.sendMessage(message);
     }
-    // register the service worker
-    async setupServiceWorker(path) {
-        // check if service workers are supported
-        if (!("serviceWorker" in navigator)) {
-            throw new Error("Service workers are not supported in this browser");
-        }
-        try {
-            // check for existing registration
-            const existingRegistration = await navigator.serviceWorker.getRegistration(path);
-            let registration;
-            if (existingRegistration) {
-                registration = existingRegistration;
-                // Force unregister and re-register to ensure we get the latest version
-                await existingRegistration.unregister();
-            }
-            registration = await navigator.serviceWorker.register(path);
-            // Handle updates
-            registration.addEventListener("updatefound", () => {
-                const newWorker = registration.installing;
-                if (!newWorker)
-                    return;
-                newWorker.addEventListener("statechange", () => {
-                    if (newWorker.state === "activated" &&
-                        navigator.serviceWorker.controller) {
-                        console.info("Service worker activated, reloading...");
-                        window.location.reload();
-                    }
-                });
-            });
-            const sw = registration.active ||
-                registration.waiting ||
-                registration.installing;
-            if (!sw) {
-                throw new Error("Failed to get service worker instance");
-            }
-            this.serviceWorker = sw;
-            // wait for the service worker to be ready
-            if (this.serviceWorker?.state !== "activated") {
-                await new Promise((resolve) => {
-                    if (!this.serviceWorker)
-                        return resolve();
-                    this.serviceWorker.addEventListener("statechange", () => {
-                        if (this.serviceWorker?.state === "activated") {
-                            resolve();
-                        }
-                    });
-                });
-            }
-        }
-        catch (error) {
-            throw new Error(`Failed to setup service worker: ${error}`);
-        }
-    }
     // send a message and wait for a response
     async sendMessage(message) {
-        if (!this.serviceWorker) {
-            throw new Error("Service worker not initialized");
-        }
         return new Promise((resolve, reject) => {
             const messageHandler = (event) => {
                 const response = event.data;
@@ -141,12 +78,7 @@ class ServiceWorkerWallet {
                 }
             };
             navigator.serviceWorker.addEventListener("message", messageHandler);
-            if (this.serviceWorker) {
-                this.serviceWorker.postMessage(message);
-            }
-            else {
-                reject(new Error("Service worker not initialized"));
-            }
+            this.serviceWorker.postMessage(message);
         });
     }
     async getAddress() {
@@ -293,12 +225,7 @@ class ServiceWorkerWallet {
                     }
                 };
                 navigator.serviceWorker.addEventListener("message", messageHandler);
-                if (this.serviceWorker) {
-                    this.serviceWorker.postMessage(message);
-                }
-                else {
-                    reject(new Error("Service worker not initialized"));
-                }
+                this.serviceWorker.postMessage(message);
             });
         }
         catch (error) {

package/dist/esm/index.js

@@ -6,6 +6,7 @@ import { VtxoScript } from './script/base.js';
 import { TxType, } from './wallet/index.js';
 import { Wallet } from './wallet/wallet.js';
 import { ServiceWorkerWallet } from './wallet/serviceWorker/wallet.js';
+import { setupServiceWorker } from './wallet/serviceWorker/utils.js';
 import { Worker } from './wallet/serviceWorker/worker.js';
 import { Request } from './wallet/serviceWorker/request.js';
 import { Response } from './wallet/serviceWorker/response.js';
@@ -16,9 +17,7 @@ import { addConditionWitness, CONDITION_WITNESS_KEY_PREFIX, createVirtualTx, } f
 import { ArkNote, ArkNoteData } from './arknote/index.js';
 import { IndexedDBVtxoRepository } from './wallet/serviceWorker/db/vtxo/idb.js';
 import { networks } from './networks.js';
-export { 
-// Classes
-Wallet, ServiceWorkerWallet, InMemoryKey, 
+export { Wallet, InMemoryKey, 
 // Providers
 ESPLORA_URL, EsploraProvider, RestArkProvider, 
 // Script-related
@@ -26,7 +25,7 @@ ArkAddress, DefaultVtxo, VtxoScript, VHTLC,
 // Enums
 TxType, 
 // Service Worker
-Worker, Request, Response, 
+setupServiceWorker, Worker, ServiceWorkerWallet, Request, Response, 
 // Tapscript
 decodeTapscript, MultisigTapscript, CSVMultisigTapscript, ConditionCSVMultisigTapscript, ConditionMultisigTapscript, CLTVMultisigTapscript, 
 // Utils

package/dist/esm/providers/ark.js

@@ -365,6 +365,12 @@ export class RestArkProvider {
                 }
             }
             catch (error) {
+                // ignore timeout errors, they're expected when the server is not sending anything for 5 min
+                // these timeouts are set by builtin fetch function
+                if (isFetchTimeoutError(error)) {
+                    console.debug("Timeout error ignored");
+                    continue;
+                }
                 console.error("Address subscription error:", error);
                 throw error;
             }
@@ -541,3 +547,13 @@ function convertVtxo(vtxo) {
         createdAt: new Date(vtxo.createdAt * 1000),
     };
 }
+function isFetchTimeoutError(err) {
+    const checkError = (error) => {
+        return (error instanceof Error &&
+            (error.name === "HeadersTimeoutError" ||
+                error.name === "BodyTimeoutError" ||
+                error.code === "UND_ERR_HEADERS_TIMEOUT" ||
+                error.code === "UND_ERR_BODY_TIMEOUT"));
+    };
+    return checkError(err) || checkError(err.cause);
+}

package/dist/esm/wallet/serviceWorker/utils.js

@@ -0,0 +1,45 @@
+export async function setupServiceWorker(path) {
+    // check if service workers are supported
+    if (!("serviceWorker" in navigator)) {
+        throw new Error("Service workers are not supported in this browser");
+    }
+    // check for existing registration
+    const existingRegistration = await navigator.serviceWorker.getRegistration(path);
+    let registration;
+    if (existingRegistration) {
+        registration = existingRegistration;
+        // Force unregister and re-register to ensure we get the latest version
+        await existingRegistration.unregister();
+    }
+    registration = await navigator.serviceWorker.register(path);
+    // Handle updates
+    registration.addEventListener("updatefound", () => {
+        const newWorker = registration.installing;
+        if (!newWorker)
+            return;
+        newWorker.addEventListener("statechange", () => {
+            if (newWorker.state === "activated" &&
+                navigator.serviceWorker.controller) {
+                console.info("Service worker activated, reloading...");
+                window.location.reload();
+            }
+        });
+    });
+    const serviceWorker = registration.active || registration.waiting || registration.installing;
+    if (!serviceWorker) {
+        throw new Error("Failed to get service worker instance");
+    }
+    // wait for the service worker to be ready
+    if (serviceWorker.state !== "activated") {
+        await new Promise((resolve) => {
+            if (!serviceWorker)
+                return resolve();
+            serviceWorker.addEventListener("statechange", () => {
+                if (serviceWorker.state === "activated") {
+                    resolve();
+                }
+            });
+        });
+    }
+    return serviceWorker;
+}

package/dist/esm/wallet/serviceWorker/wallet.js

@@ -8,15 +8,8 @@ class UnexpectedResponseError extends Error {
 }
 // ServiceWorkerWallet is a wallet that uses a service worker as "backend" to handle the wallet logic
 export class ServiceWorkerWallet {
-    static async create(svcWorkerPath) {
-        try {
-            const wallet = new ServiceWorkerWallet();
-            await wallet.setupServiceWorker(svcWorkerPath);
-            return wallet;
-        }
-        catch (error) {
-            throw new Error(`Failed to initialize service worker wallet: ${error}`);
-        }
+    constructor(serviceWorker) {
+        this.serviceWorker = serviceWorker;
     }
     async getStatus() {
         const message = {
@@ -61,64 +54,8 @@ export class ServiceWorkerWallet {
         };
         await this.sendMessage(message);
     }
-    // register the service worker
-    async setupServiceWorker(path) {
-        // check if service workers are supported
-        if (!("serviceWorker" in navigator)) {
-            throw new Error("Service workers are not supported in this browser");
-        }
-        try {
-            // check for existing registration
-            const existingRegistration = await navigator.serviceWorker.getRegistration(path);
-            let registration;
-            if (existingRegistration) {
-                registration = existingRegistration;
-                // Force unregister and re-register to ensure we get the latest version
-                await existingRegistration.unregister();
-            }
-            registration = await navigator.serviceWorker.register(path);
-            // Handle updates
-            registration.addEventListener("updatefound", () => {
-                const newWorker = registration.installing;
-                if (!newWorker)
-                    return;
-                newWorker.addEventListener("statechange", () => {
-                    if (newWorker.state === "activated" &&
-                        navigator.serviceWorker.controller) {
-                        console.info("Service worker activated, reloading...");
-                        window.location.reload();
-                    }
-                });
-            });
-            const sw = registration.active ||
-                registration.waiting ||
-                registration.installing;
-            if (!sw) {
-                throw new Error("Failed to get service worker instance");
-            }
-            this.serviceWorker = sw;
-            // wait for the service worker to be ready
-            if (this.serviceWorker?.state !== "activated") {
-                await new Promise((resolve) => {
-                    if (!this.serviceWorker)
-                        return resolve();
-                    this.serviceWorker.addEventListener("statechange", () => {
-                        if (this.serviceWorker?.state === "activated") {
-                            resolve();
-                        }
-                    });
-                });
-            }
-        }
-        catch (error) {
-            throw new Error(`Failed to setup service worker: ${error}`);
-        }
-    }
     // send a message and wait for a response
     async sendMessage(message) {
-        if (!this.serviceWorker) {
-            throw new Error("Service worker not initialized");
-        }
         return new Promise((resolve, reject) => {
             const messageHandler = (event) => {
                 const response = event.data;
@@ -138,12 +75,7 @@ export class ServiceWorkerWallet {
                 }
             };
             navigator.serviceWorker.addEventListener("message", messageHandler);
-            if (this.serviceWorker) {
-                this.serviceWorker.postMessage(message);
-            }
-            else {
-                reject(new Error("Service worker not initialized"));
-            }
+            this.serviceWorker.postMessage(message);
         });
     }
     async getAddress() {
@@ -290,12 +222,7 @@ export class ServiceWorkerWallet {
                     }
                 };
                 navigator.serviceWorker.addEventListener("message", messageHandler);
-                if (this.serviceWorker) {
-                    this.serviceWorker.postMessage(message);
-                }
-                else {
-                    reject(new Error("Service worker not initialized"));
-                }
+                this.serviceWorker.postMessage(message);
             });
         }
         catch (error) {

package/dist/types/index.d.ts

@@ -7,6 +7,7 @@ import { VtxoScript } from "./script/base";
 import { TxType, IWallet, WalletConfig, ArkTransaction, Coin, ExtendedCoin, ExtendedVirtualCoin, WalletBalance, SendBitcoinParams, Recipient, SettleParams, VtxoTaprootAddress, AddressInfo, TapscriptInfo, Status, VirtualStatus, Outpoint, VirtualCoin, TxKey, Addresses } from "./wallet/index";
 import { Wallet } from "./wallet/wallet";
 import { ServiceWorkerWallet } from "./wallet/serviceWorker/wallet";
+import { setupServiceWorker } from "./wallet/serviceWorker/utils";
 import { Worker } from "./wallet/serviceWorker/worker";
 import { Request } from "./wallet/serviceWorker/request";
 import { Response } from "./wallet/serviceWorker/response";
@@ -18,5 +19,5 @@ import { ArkNote, ArkNoteData } from "./arknote";
 import { IndexedDBVtxoRepository } from "./wallet/serviceWorker/db/vtxo/idb";
 import { VtxoRepository } from "./wallet/serviceWorker/db/vtxo";
 import { networks } from "./networks";
-export { Wallet, ServiceWorkerWallet, InMemoryKey, ESPLORA_URL, EsploraProvider, RestArkProvider, ArkAddress, DefaultVtxo, VtxoScript, VHTLC, TxType, Worker, Request, Response, decodeTapscript, MultisigTapscript, CSVMultisigTapscript, ConditionCSVMultisigTapscript, ConditionMultisigTapscript, CLTVMultisigTapscript, addConditionWitness, CONDITION_WITNESS_KEY_PREFIX, createVirtualTx, ArkNote, ArkNoteData, networks, IndexedDBVtxoRepository, };
+export { Wallet, InMemoryKey, ESPLORA_URL, EsploraProvider, RestArkProvider, ArkAddress, DefaultVtxo, VtxoScript, VHTLC, TxType, setupServiceWorker, Worker, ServiceWorkerWallet, Request, Response, decodeTapscript, MultisigTapscript, CSVMultisigTapscript, ConditionCSVMultisigTapscript, ConditionMultisigTapscript, CLTVMultisigTapscript, addConditionWitness, CONDITION_WITNESS_KEY_PREFIX, createVirtualTx, ArkNote, ArkNoteData, networks, IndexedDBVtxoRepository, };
 export type { Identity, IWallet, WalletConfig, ArkTransaction, Coin, ExtendedCoin, ExtendedVirtualCoin, WalletBalance, SendBitcoinParams, Recipient, SettleParams, VtxoTaprootAddress, AddressInfo, Addresses, TapscriptInfo, Status, VirtualStatus, Outpoint, VirtualCoin, TxKey, TapscriptType, VtxoRepository, };

package/dist/types/wallet/serviceWorker/utils.d.ts

@@ -0,0 +1 @@
+export declare function setupServiceWorker(path: string): Promise<ServiceWorker>;

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

@@ -2,14 +2,13 @@ import { IWallet, WalletBalance, SendBitcoinParams, SettleParams, AddressInfo, C
 import { Response } from "./response";
 import { SettlementEvent } from "../../providers/ark";
 export declare class ServiceWorkerWallet implements IWallet {
-    private serviceWorker?;
-    static create(svcWorkerPath: string): Promise<ServiceWorkerWallet>;
+    readonly serviceWorker: ServiceWorker;
+    constructor(serviceWorker: ServiceWorker);
     getStatus(): Promise<Response.WalletStatus["status"]>;
     init(config: Omit<WalletConfig, "identity"> & {
         privateKey: string;
     }, failIfInitialized?: boolean): Promise<void>;
     clear(): Promise<void>;
-    private setupServiceWorker;
     private sendMessage;
     getAddress(): Promise<Addresses>;
     getAddressInfo(): Promise<AddressInfo>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arkade-os/sdk",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "Bitcoin wallet SDK with Taproot and Ark integration",
   "type": "module",
   "main": "./dist/cjs/index.js",