@arkade-os/sdk 0.3.8 → 0.3.9

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

@@ -5,12 +5,16 @@ import { DefaultVtxo } from "../script/default";
 import { Network, NetworkName } from "../networks";
 import { OnchainProvider } from "../providers/onchain";
 import { SettlementEvent, ArkProvider, SignedIntent } from "../providers/ark";
-import { Identity } from "../identity";
-import { ArkTransaction, Coin, ExtendedCoin, ExtendedVirtualCoin, GetVtxosFilter, IWallet, SendBitcoinParams, SettleParams, WalletBalance, WalletConfig } from ".";
+import { SignerSession } from "../tree/signingSession";
+import { Identity, ReadonlyIdentity } from "../identity";
+import { ArkTransaction, Coin, ExtendedCoin, ExtendedVirtualCoin, GetVtxosFilter, IReadonlyWallet, IWallet, ReadonlyWalletConfig, SendBitcoinParams, SettleParams, VirtualCoin, WalletBalance, WalletConfig } from ".";
+import { TapLeafScript } from "../script/base";
 import { CSVMultisigTapscript } from "../script/tapscript";
+import { Intent } from "../intent";
 import { IndexerProvider } from "../providers/indexer";
-import { WalletRepository } from "../repositories/walletRepository";
-import { ContractRepository } from "../repositories/contractRepository";
+import { WalletRepository, WalletRepositoryImpl } from "../repositories/walletRepository";
+import { ContractRepository, ContractRepositoryImpl } from "../repositories/contractRepository";
+import { Batch } from "./batch";
 export type IncomingFunds = {
     type: "utxo";
     coins: Coin[];
@@ -19,6 +23,52 @@ export type IncomingFunds = {
     newVtxos: ExtendedVirtualCoin[];
     spentVtxos: ExtendedVirtualCoin[];
 };
+export declare class ReadonlyWallet implements IReadonlyWallet {
+    readonly identity: ReadonlyIdentity;
+    readonly network: Network;
+    readonly onchainProvider: OnchainProvider;
+    readonly indexerProvider: IndexerProvider;
+    readonly arkServerPublicKey: Bytes;
+    readonly offchainTapscript: DefaultVtxo.Script;
+    readonly boardingTapscript: DefaultVtxo.Script;
+    readonly dustAmount: bigint;
+    readonly walletRepository: WalletRepository;
+    readonly contractRepository: ContractRepository;
+    protected constructor(identity: ReadonlyIdentity, network: Network, onchainProvider: OnchainProvider, indexerProvider: IndexerProvider, arkServerPublicKey: Bytes, offchainTapscript: DefaultVtxo.Script, boardingTapscript: DefaultVtxo.Script, dustAmount: bigint, walletRepository: WalletRepository, contractRepository: ContractRepository);
+    /**
+     * Protected helper to set up shared wallet configuration.
+     * Extracts common logic used by both ReadonlyWallet.create() and Wallet.create().
+     */
+    protected static setupWalletConfig(config: ReadonlyWalletConfig, pubkey: Uint8Array): Promise<{
+        arkProvider: ArkProvider;
+        indexerProvider: IndexerProvider;
+        onchainProvider: OnchainProvider;
+        network: Network;
+        networkName: NetworkName;
+        serverPubKey: Uint8Array<ArrayBuffer>;
+        offchainTapscript: DefaultVtxo.Script;
+        boardingTapscript: DefaultVtxo.Script;
+        dustAmount: bigint;
+        walletRepository: WalletRepositoryImpl;
+        contractRepository: ContractRepositoryImpl;
+        info: import("../providers/ark").ArkInfo;
+    }>;
+    static create(config: ReadonlyWalletConfig): Promise<ReadonlyWallet>;
+    get arkAddress(): ArkAddress;
+    getAddress(): Promise<string>;
+    getBoardingAddress(): Promise<string>;
+    getBalance(): Promise<WalletBalance>;
+    getVtxos(filter?: GetVtxosFilter): Promise<ExtendedVirtualCoin[]>;
+    protected getVirtualCoins(filter?: GetVtxosFilter): Promise<VirtualCoin[]>;
+    getTransactionHistory(): Promise<ArkTransaction[]>;
+    getBoardingTxs(): Promise<{
+        boardingTxs: ArkTransaction[];
+        commitmentsToIgnore: Set<string>;
+    }>;
+    getBoardingUtxos(): Promise<ExtendedCoin[]>;
+    notifyIncomingFunds(eventCallback: (coins: IncomingFunds) => void): Promise<() => void>;
+    fetchPendingTxs(): Promise<string[]>;
+}
 /**
  * Main wallet implementation for Bitcoin transactions with Ark protocol support.
  * The wallet does not store any data locally and relies on Ark and onchain
@@ -52,52 +102,52 @@ export type IncomingFunds = {
  * });
  * ```
  */
-export declare class Wallet implements IWallet {
-    readonly identity: Identity;
-    readonly network: Network;
+export declare class Wallet extends ReadonlyWallet implements IWallet {
     readonly networkName: NetworkName;
-    readonly onchainProvider: OnchainProvider;
     readonly arkProvider: ArkProvider;
-    readonly indexerProvider: IndexerProvider;
-    readonly arkServerPublicKey: Bytes;
-    readonly offchainTapscript: DefaultVtxo.Script;
-    readonly boardingTapscript: DefaultVtxo.Script;
     readonly serverUnrollScript: CSVMultisigTapscript.Type;
     readonly forfeitOutputScript: Bytes;
     readonly forfeitPubkey: Bytes;
-    readonly dustAmount: bigint;
     static MIN_FEE_RATE: number;
-    readonly walletRepository: WalletRepository;
-    readonly contractRepository: ContractRepository;
+    readonly identity: Identity;
     readonly renewalConfig: Required<Omit<WalletConfig["renewalConfig"], "enabled">> & {
         enabled: boolean;
         thresholdMs: number;
     };
-    private constructor();
+    protected constructor(identity: Identity, network: Network, networkName: NetworkName, onchainProvider: OnchainProvider, arkProvider: ArkProvider, indexerProvider: IndexerProvider, arkServerPublicKey: Bytes, offchainTapscript: DefaultVtxo.Script, boardingTapscript: DefaultVtxo.Script, serverUnrollScript: CSVMultisigTapscript.Type, forfeitOutputScript: Bytes, forfeitPubkey: Bytes, dustAmount: bigint, walletRepository: WalletRepository, contractRepository: ContractRepository, renewalConfig?: WalletConfig["renewalConfig"]);
     static create(config: WalletConfig): Promise<Wallet>;
-    get arkAddress(): ArkAddress;
-    getAddress(): Promise<string>;
-    getBoardingAddress(): Promise<string>;
-    getBalance(): Promise<WalletBalance>;
-    getVtxos(filter?: GetVtxosFilter): Promise<ExtendedVirtualCoin[]>;
-    private getVirtualCoins;
-    getTransactionHistory(): Promise<ArkTransaction[]>;
-    getBoardingTxs(): Promise<{
-        boardingTxs: ArkTransaction[];
-        commitmentsToIgnore: Set<string>;
-    }>;
-    getBoardingUtxos(): Promise<ExtendedCoin[]>;
+    /**
+     * Convert this wallet to a readonly wallet.
+     *
+     * @returns A readonly wallet with the same configuration but readonly identity
+     * @example
+     * ```typescript
+     * const wallet = await Wallet.create({ identity: SingleKey.fromHex('...'), ... });
+     * const readonlyWallet = await wallet.toReadonly();
+     *
+     * // Can query balance and addresses
+     * const balance = await readonlyWallet.getBalance();
+     * const address = await readonlyWallet.getAddress();
+     *
+     * // But cannot send transactions (type error)
+     * // readonlyWallet.sendBitcoin(...); // TypeScript error
+     * ```
+     */
+    toReadonly(): Promise<ReadonlyWallet>;
     sendBitcoin(params: SendBitcoinParams): Promise<string>;
     settle(params?: SettleParams, eventCallback?: (event: SettlementEvent) => void): Promise<string>;
-    notifyIncomingFunds(eventCallback: (coins: IncomingFunds) => void): Promise<() => void>;
-    private handleBatchStartedEvent;
-    private handleSettlementSigningEvent;
-    private handleSettlementTreeNoncesEvent;
     private handleSettlementFinalizationEvent;
-    safeRegisterIntent(intent: SignedIntent): Promise<string>;
-    makeRegisterIntentSignature(coins: ExtendedCoin[], outputs: TransactionOutput[], onchainOutputsIndexes: number[], cosignerPubKeys: string[]): Promise<SignedIntent>;
-    makeDeleteIntentSignature(coins: ExtendedCoin[]): Promise<SignedIntent>;
-    makeGetPendingTxIntentSignature(vtxos: ExtendedVirtualCoin[]): Promise<SignedIntent>;
+    /**
+     * @implements Batch.Handler interface.
+     * @param intentId - The intent ID.
+     * @param inputs - The inputs of the intent.
+     * @param session - The musig2 signing session, if not provided, the signing will be skipped.
+     */
+    createBatchHandler(intentId: string, inputs: ExtendedCoin[], session?: SignerSession): Batch.Handler;
+    safeRegisterIntent(intent: SignedIntent<Intent.RegisterMessage>): Promise<string>;
+    makeRegisterIntentSignature(coins: ExtendedCoin[], outputs: TransactionOutput[], onchainOutputsIndexes: number[], cosignerPubKeys: string[]): Promise<SignedIntent<Intent.RegisterMessage>>;
+    makeDeleteIntentSignature(coins: ExtendedCoin[]): Promise<SignedIntent<Intent.DeleteMessage>>;
+    makeGetPendingTxIntentSignature(vtxos: ExtendedVirtualCoin[]): Promise<SignedIntent<Intent.GetPendingTxMessage>>;
     /**
      * Finalizes pending transactions by retrieving them from the server and finalizing each one.
      * @param vtxos - Optional list of VTXOs to use instead of retrieving them from the server
@@ -109,6 +159,7 @@ export declare class Wallet implements IWallet {
     }>;
     private prepareIntentProofInputs;
 }
+export declare function getSequence(tapLeafScript: TapLeafScript): number | undefined;
 /**
  * Wait for incoming funds to the wallet
  * @param wallet - The wallet to wait for incoming funds

package/package.json

@@ -1,120 +1,130 @@
 {
-  "name": "@arkade-os/sdk",
-  "version": "0.3.8",
-  "description": "Bitcoin wallet SDK with Taproot and Ark integration",
-  "type": "module",
-  "main": "./dist/cjs/index.js",
-  "module": "./dist/esm/index.js",
-  "types": "./dist/types/index.d.ts",
-  "sideEffects": false,
-  "exports": {
-    ".": {
-      "types": "./dist/types/index.d.ts",
-      "import": "./dist/esm/index.js",
-      "require": "./dist/cjs/index.js",
-      "default": "./dist/esm/index.js"
+    "name": "@arkade-os/sdk",
+    "version": "0.3.9",
+    "description": "Bitcoin wallet SDK with Taproot and Ark integration",
+    "type": "module",
+    "main": "./dist/cjs/index.js",
+    "module": "./dist/esm/index.js",
+    "types": "./dist/types/index.d.ts",
+    "sideEffects": false,
+    "exports": {
+        ".": {
+            "types": "./dist/types/index.d.ts",
+            "import": "./dist/esm/index.js",
+            "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",
+            "require": "./dist/cjs/adapters/localStorage.js",
+            "default": "./dist/esm/adapters/localStorage.js"
+        },
+        "./adapters/fileSystem": {
+            "types": "./dist/types/adapters/fileSystem.d.ts",
+            "import": "./dist/esm/adapters/fileSystem.js",
+            "require": "./dist/cjs/adapters/fileSystem.js",
+            "default": "./dist/esm/adapters/fileSystem.js"
+        },
+        "./adapters/indexedDB": {
+            "types": "./dist/types/adapters/indexedDB.d.ts",
+            "import": "./dist/esm/adapters/indexedDB.js",
+            "require": "./dist/cjs/adapters/indexedDB.js",
+            "default": "./dist/esm/adapters/indexedDB.js"
+        },
+        "./adapters/asyncStorage": {
+            "types": "./dist/types/adapters/asyncStorage.d.ts",
+            "import": "./dist/esm/adapters/asyncStorage.js",
+            "require": "./dist/cjs/adapters/asyncStorage.js",
+            "default": "./dist/esm/adapters/asyncStorage.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"
+    "files": [
+        "dist"
+    ],
+    "publishConfig": {
+        "access": "public",
+        "registry": "https://registry.npmjs.org/"
     },
-    "./adapters/localStorage": {
-      "types": "./dist/types/adapters/localStorage.d.ts",
-      "import": "./dist/esm/adapters/localStorage.js",
-      "require": "./dist/cjs/adapters/localStorage.js",
-      "default": "./dist/esm/adapters/localStorage.js"
+    "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",
+        "build:esm": "tsc -p tsconfig.esm.json --outDir dist/esm",
+        "build:cjs": "tsc -p tsconfig.cjs.json --outDir dist/cjs",
+        "build:types": "tsc -p tsconfig.json --outDir dist/types --emitDeclarationOnly",
+        "build:browser": "node scripts/build-browser.js",
+        "docs:build": "pnpm run build:types && pnpm typedoc",
+        "docs:open": "open ./docs/index.html",
+        "test": "vitest run",
+        "test:master": "ARK_ENV=master vitest run",
+        "test:unit": "vitest run --exclude test/e2e",
+        "test:setup": "node test/setup.js",
+        "test:setup-docker": "node test/setup.js docker",
+        "test:build-docker": "docker compose -f docker-compose.yml build --no-cache",
+        "test:up-docker": "docker compose -f docker-compose.yml up -d",
+        "test:down-docker": "docker compose -f docker-compose.yml down",
+        "test:integration": "vitest run test/e2e/**",
+        "test:integration-docker": "ARK_ENV=docker vitest run test/e2e/**",
+        "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",
+        "preinstall": "npx only-allow pnpm",
+        "prepare": "husky",
+        "prepublishOnly": "pnpm run build",
+        "release": "bash scripts/release.sh",
+        "release:dry-run": "bash scripts/release.sh --dry-run",
+        "release:cleanup": "bash scripts/release.sh --cleanup"
     },
-    "./adapters/fileSystem": {
-      "types": "./dist/types/adapters/fileSystem.d.ts",
-      "import": "./dist/esm/adapters/fileSystem.js",
-      "require": "./dist/cjs/adapters/fileSystem.js",
-      "default": "./dist/esm/adapters/fileSystem.js"
+    "dependencies": {
+        "@noble/curves": "2.0.0",
+        "@noble/secp256k1": "3.0.0",
+        "@scure/base": "2.0.0",
+        "@scure/btc-signer": "2.0.1",
+        "bip68": "1.0.4"
     },
-    "./adapters/indexedDB": {
-      "types": "./dist/types/adapters/indexedDB.d.ts",
-      "import": "./dist/esm/adapters/indexedDB.js",
-      "require": "./dist/cjs/adapters/indexedDB.js",
-      "default": "./dist/esm/adapters/indexedDB.js"
+    "devDependencies": {
+        "@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",
+        "prettier": "3.6.2",
+        "rimraf": "^6.0.1",
+        "typedoc": "^0.28.12",
+        "typescript": "5.9.2",
+        "vitest": "3.2.4"
     },
-    "./adapters/asyncStorage": {
-      "types": "./dist/types/adapters/asyncStorage.d.ts",
-      "import": "./dist/esm/adapters/asyncStorage.js",
-      "require": "./dist/cjs/adapters/asyncStorage.js",
-      "default": "./dist/esm/adapters/asyncStorage.js"
+    "keywords": [
+        "bitcoin",
+        "wallet",
+        "taproot",
+        "ark",
+        "sdk",
+        "arkade"
+    ],
+    "author": "Ark Labs",
+    "license": "MIT",
+    "packageManager": "pnpm@10.20.0",
+    "engines": {
+        "node": ">=20.0.0"
+    },
+    "pnpm": {
+        "overrides": {
+            "esbuild": ">=0.25.0",
+            "brace-expansion": ">=2.0.2",
+            "minimatch": "9.0.3"
+        }
     }
-  },
-  "files": [
-    "dist"
-  ],
-  "publishConfig": {
-    "access": "public",
-    "registry": "https://registry.npmjs.org/"
-  },
-  "dependencies": {
-    "@noble/curves": "2.0.0",
-    "@noble/secp256k1": "3.0.0",
-    "@scure/base": "2.0.0",
-    "@scure/btc-signer": "2.0.1",
-    "bip68": "1.0.4"
-  },
-  "devDependencies": {
-    "@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",
-    "prettier": "3.6.2",
-    "rimraf": "^6.0.1",
-    "typedoc": "^0.28.12",
-    "typescript": "5.9.2",
-    "vitest": "3.2.4"
-  },
-  "keywords": [
-    "bitcoin",
-    "wallet",
-    "taproot",
-    "ark",
-    "sdk",
-    "arkade"
-  ],
-  "author": "Ark Labs",
-  "license": "MIT",
-  "engines": {
-    "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",
-    "build:esm": "tsc -p tsconfig.esm.json --outDir dist/esm",
-    "build:cjs": "tsc -p tsconfig.cjs.json --outDir dist/cjs",
-    "build:types": "tsc -p tsconfig.json --outDir dist/types --emitDeclarationOnly",
-    "build:browser": "node scripts/build-browser.js",
-    "docs:build": "pnpm run build:types && pnpm typedoc",
-    "docs:open": "open ./docs/index.html",
-    "test": "vitest run",
-    "test:master": "ARK_ENV=master vitest run",
-    "test:unit": "vitest run --exclude test/e2e",
-    "test:setup": "node test/setup.js",
-    "test:setup-docker": "node test/setup.js docker",
-    "test:build-docker": "docker compose -f docker-compose.yml build --no-cache",
-    "test:up-docker": "docker compose -f docker-compose.yml up -d",
-    "test:down-docker": "docker compose -f docker-compose.yml down",
-    "test:integration": "vitest run test/e2e/**",
-    "test:integration-docker": "ARK_ENV=docker vitest run test/e2e/**",
-    "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",
-    "preinstall": "npx only-allow pnpm",
-    "release": "bash scripts/release.sh",
-    "release:dry-run": "bash scripts/release.sh --dry-run",
-    "release:cleanup": "bash scripts/release.sh --cleanup"
-  }
-}
+}