@arkade-os/sdk 0.3.0-alpha.7 → 0.3.0-alpha.8

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

@@ -1,4 +1,6 @@
-import { Output, SettlementEvent } from "../providers/ark";
+import { Output, SettlementEvent, ArkProvider } from "../providers/ark";
+import { IndexerProvider } from "../providers/indexer";
+import { OnchainProvider } from "../providers/onchain";
 import { Identity } from "../identity";
 import { RelativeTimelock } from "../script/tapscript";
 import { EncodedVtxoScript, TapLeafScript } from "../script/base";
@@ -7,19 +9,54 @@ import { StorageAdapter } from "../storage";
 /**
  * Configuration options for wallet initialization.
  *
- * Defines the parameters required to create and configure a wallet instance,
- * including identity, server URLs, and optional timelock settings.
- * If optional parameters are not provided, the wallet will fetch them from the
- * Ark server.
+ * Supports two configuration modes:
+ * 1. URL-based: Provide arkServerUrl, indexerUrl (optional), and esploraUrl
+ * 2. Provider-based: Provide arkProvider, indexerProvider, and onchainProvider instances
+ *
+ * At least one of the following must be provided:
+ * - arkServerUrl OR arkProvider
+ *
+ * The wallet will use provided URLs to create default providers if custom provider
+ * instances are not supplied. If optional parameters are not provided, the wallet
+ * will fetch configuration from the Ark server.
+ *
+ * @example
+ * ```typescript
+ * // URL-based configuration
+ * const wallet = await Wallet.create({
+ *   identity: SingleKey.fromHex('...'),
+ *   arkServerUrl: 'https://ark.example.com',
+ *   esploraUrl: 'https://mempool.space/api'
+ * });
+ *
+ * // Provider-based configuration (e.g., for Expo/React Native)
+ * const wallet = await Wallet.create({
+ *   identity: SingleKey.fromHex('...'),
+ *   arkProvider: new ExpoArkProvider('https://ark.example.com'),
+ *   indexerProvider: new ExpoIndexerProvider('https://ark.example.com'),
+ *   onchainProvider: new EsploraProvider('https://mempool.space/api')
+ * });
+ * ```
  */
 export interface WalletConfig {
     identity: Identity;
-    arkServerUrl: string;
+    arkServerUrl?: string;
+    indexerUrl?: string;
     esploraUrl?: string;
     arkServerPublicKey?: string;
     boardingTimelock?: RelativeTimelock;
     exitTimelock?: RelativeTimelock;
     storage?: StorageAdapter;
+    arkProvider?: ArkProvider;
+    indexerProvider?: IndexerProvider;
+    onchainProvider?: OnchainProvider;
+}
+/**
+ * Provider class constructor interface for dependency injection.
+ * Ensures provider classes follow the consistent constructor pattern.
+ */
+export interface ProviderClass<T> {
+    new (serverUrl: string): T;
 }
 export interface WalletBalance {
     boarding: {
@@ -73,6 +110,7 @@ export interface VirtualCoin extends Coin {
     arkTxId?: string;
     createdAt: Date;
     isUnrolled: boolean;
+    isSpent?: boolean;
 }
 export declare enum TxType {
     TxSent = "SENT",

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

@@ -1,4 +1,3 @@
-import { ExtendedVirtualCoin, VirtualCoin, Wallet } from "../..";
 /**
  * setupServiceWorker sets up the service worker.
  * @param path - the path to the service worker script
@@ -8,4 +7,3 @@ import { ExtendedVirtualCoin, VirtualCoin, Wallet } from "../..";
  * ```
  */
 export declare function setupServiceWorker(path: string): Promise<ServiceWorker>;
-export declare function extendVirtualCoin(wallet: Wallet, vtxo: VirtualCoin): ExtendedVirtualCoin;

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

@@ -0,0 +1,2 @@
+import type { ExtendedVirtualCoin, VirtualCoin, Wallet } from "..";
+export declare function extendVirtualCoin(wallet: Wallet, vtxo: VirtualCoin): ExtendedVirtualCoin;

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

@@ -25,13 +25,21 @@ export type IncomingFunds = {
  *
  * @example
  * ```typescript
- * // Create a wallet
+ * // Create a wallet with URL configuration
  * const wallet = await Wallet.create({
  *   identity: SingleKey.fromHex('your_private_key'),
  *   arkServerUrl: 'https://ark.example.com',
  *   esploraUrl: 'https://mempool.space/api'
  * });
  *
+ * // Or with custom provider instances (e.g., for Expo/React Native)
+ * const wallet = await Wallet.create({
+ *   identity: SingleKey.fromHex('your_private_key'),
+ *   arkProvider: new ExpoArkProvider('https://ark.example.com'),
+ *   indexerProvider: new ExpoIndexerProvider('https://ark.example.com'),
+ *   esploraUrl: 'https://mempool.space/api'
+ * });
+ *
  * // Get addresses
  * const arkAddress = await wallet.getAddress();
  * const boardingAddress = await wallet.getBoardingAddress();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arkade-os/sdk",
-  "version": "0.3.0-alpha.7",
+  "version": "0.3.0-alpha.8",
   "description": "Bitcoin wallet SDK with Taproot and Ark integration",
   "type": "module",
   "main": "./dist/cjs/index.js",
@@ -14,6 +14,12 @@
       "require": "./dist/cjs/index.js",
       "default": "./dist/esm/index.js"
     },
+    "./adapters/expo": {
+      "types": "./dist/types/adapters/expo.d.ts",
+      "import": "./dist/esm/adapters/expo.js",
+      "require": "./dist/cjs/adapters/expo.js",
+      "default": "./dist/esm/adapters/expo.js"
+    },
     "./adapters/localStorage": {
       "types": "./dist/types/adapters/localStorage.d.ts",
       "import": "./dist/esm/adapters/localStorage.js",
@@ -58,6 +64,7 @@
     "@types/node": "24.3.1",
     "@vitest/coverage-v8": "3.2.4",
     "esbuild": "^0.25.9",
+    "expo": "~52.0.47",
     "eventsource": "4.0.0",
     "glob": "11.0.3",
     "husky": "9.1.7",
@@ -78,7 +85,7 @@
   "author": "Ark Labs",
   "license": "MIT",
   "engines": {
-    "node": "^14.17.0 || ^16.13.0 || >=18.0.0"
+    "node": ">=20.0.0"
   },
   "scripts": {
     "build": "rimraf dist && pnpm run build:esm && node scripts/add-extensions.js && pnpm run build:cjs && pnpm run build:types && node scripts/generate-package-files.js",
@@ -101,6 +108,8 @@
     "test:watch": "vitest",
     "test:coverage": "vitest run --coverage",
     "test:sw": "pnpm run build:browser && node test/serviceWorker/serve.js",
+    "expo:web:install": "cd examples/expo-demo && pnpm install",
+    "expo:web": "cd examples/expo-demo && pnpm start",
     "format": "prettier --write src test examples",
     "lint": "prettier --check src test examples",
     "audit": "pnpm audit",