@arkade-os/sdk 0.5.0-rc.2 → 0.5.0-rc.4

package/README.md

@@ -591,7 +591,6 @@ Access the `VtxoManager` from the wallet after configuring `settlementConfig`:
 const manager = await wallet.getVtxoManager()
 ```
 
-> **Migration from `renewalConfig`:** Directly initializing a `VtxoManager` with `renewalConfig` is still supported but deprecated. Prefer `settlementConfig` where `vtxoThreshold` is expressed in **seconds** instead of milliseconds.
 
 #### Renewal: Prevent Expiration
 
@@ -1109,72 +1108,17 @@ examples.
 
 ### Repositories (Storage)
 
-The `StorageAdapter` API is deprecated. Use repositories instead. If you omit `storage`, the SDK uses IndexedDB repositories with the default database name.
-
-#### Migration from v1 StorageAdapter
-
-> [!WARNING]
-> If you previously used the v1 `StorageAdapter`-based repositories, migrate
-> data into the new IndexedDB repositories before use:
->
-> ```typescript
-> import {
->   IndexedDBWalletRepository,
->   IndexedDBContractRepository,
->   getMigrationStatus,
->   migrateWalletRepository,
->   rollbackMigration,
-> } from '@arkade-os/sdk'
-> import { IndexedDBStorageAdapter } from '@arkade-os/sdk/adapters/indexedDB'
->
-> const oldStorage = new IndexedDBStorageAdapter('legacy-wallet', 1)
-> const newDbName = 'my-app-db'
-> const walletRepository = new IndexedDBWalletRepository(newDbName)
->
-> // Check migration status before running
-> const status = await getMigrationStatus('wallet', oldStorage)
-> // status: "not-needed" | "pending" | "in-progress" | "done"
->
-> if (status === 'pending' || status === 'in-progress') {
->   try {
->     await migrateWalletRepository(oldStorage, walletRepository, {
->       onchain: [ 'address-1', 'address-2' ],
->       offchain: [ 'onboarding-address-1' ],
->     })
->   } catch (err) {
->     // Reset migration flag so the next attempt starts clean
->     await rollbackMigration('wallet', oldStorage)
->     throw err
->   }
-> }
-> ```
->
-> **Migration status helpers:**
->
-> | Helper | Description |
-> |--------|-------------|
-> | `getMigrationStatus(repoType, adapter)` | Returns `"not-needed"` (no legacy DB), `"pending"`, `"in-progress"` (interrupted), or `"done"` |
-> | `requiresMigration(repoType, adapter)` | Returns `true` if status is `"pending"` or `"in-progress"` |
-> | `rollbackMigration(repoType, adapter)` | Removes the migration flag so migration can re-run from scratch |
-> | `MIGRATION_KEY(repoType)` | Returns the storage key used for the migration flag |
->
-> `migrateWalletRepository` sets an `"in-progress"` flag before copying data.
-> If the process crashes mid-way, the flag remains as `"in-progress"` so the
-> next call to `getMigrationStatus` can detect the partial migration. Old data
-> is never deleted — re-running migration after a rollback is safe.
->
-> Anything related to contract repository migration must be handled by the
-> package that created the contracts. The SDK doesn't manage external contracts
-> in V1; data persisted by other packages remains untouched in its original
-> location.
+Use repository implementations via `StorageConfig`. If you omit `storage`, the
+SDK uses IndexedDB repositories with the default database name.
 
 #### Repository Versioning
 
-`WalletRepository`, `ContractRepository`, and `AssetSwapRepository` (in
-`@arkade-os/swap`) each declare a `readonly version` field with a literal
-type. All built-in implementations set this to the current version. If you
-maintain a custom repository implementation, TypeScript will produce a compile
-error when the version is bumped, signaling that a semantic update is required:
+`WalletRepository`, `ContractRepository`, `IntentRepository`,
+`VirtualTxRepository`, and `AssetSwapRepository` (in `@arkade-os/swap`) each
+declare a `readonly version` field with a literal type. All built-in
+implementations set this to the current version. If you maintain a custom
+repository implementation, TypeScript will produce a compile error when the
+version is bumped, signaling that a semantic update is required:
 
 ```typescript
 import { WalletRepository } from '@arkade-os/sdk'
@@ -1283,6 +1227,7 @@ const wallet = await Wallet.create({
 })
 ```
 
+### Using with Node.js
 ### Using with Node.js
 
 Node.js does not provide a global `EventSource` implementation (24.x has one behind `--experimental-eventsource`). The SDK relies on `EventSource` for Server-Sent Events during settlement (onboarding/offboarding) and contract watching, so tell it which one to use:
@@ -1406,7 +1351,7 @@ When you call `wallet.notifyIncomingFunds()` or use `waitForIncomingFunds()`, it
 
 HD wallets (`walletMode: 'hd'`, or an explicit HD `DescriptorProvider`) also watch a band of *unused* offchain receive scripts around their allocation watermark, so a payment to an address that some other party issued from the same seed — a merchant backend such as BTCPay Server, or the .NET SDK driving the same wallet — arrives without the user calling `restore()`. `lookAheadWindow` (default `20`) is the per-side width of that band: the wallet watches `[watermark - N, watermark + N]`. Speculative entries are subscription-only; they become contract rows, and enter balances, only once funded.
 
-The issuer, not the wallet, picks the contract shape, so each index is watched at *every* variant the wallet could own there: `default` and `delegate`, crossed with the unilateral-exit timelock matrix and the operator's current plus deprecated signers. That is the candidate set `restore()` probes too, so watching and restoring cover identical scripts.
+The issuer, not the wallet, picks the contract shape, so each index is watched at *every* variant the wallet could own there: `default` and `delegate`, crossed with the unilateral-exit timelock matrix and the operator's active plus retired signers. That is the candidate set `restore()` probes too, so watching and restoring cover identical scripts.
 
 ```typescript
 const wallet = await Wallet.create({
@@ -1471,7 +1416,7 @@ const paths = manager.getSpendablePaths({
   contractScript: contract.script,
   vtxo,
   collaborative: true,
-  walletPubKey: myPubKey,
+  walletDescriptor: myDescriptor,
 })
 if (paths.length > 0) {
   console.log('Contract is spendable via:', paths[0].leaf)
@@ -1481,7 +1426,7 @@ if (paths.length > 0) {
 const allPaths = await manager.getAllSpendingPaths({
   contractScript: contract.script,
   collaborative: true,
-  walletPubKey: myPubKey,
+  walletDescriptor: myDescriptor,
 })
 
 // Fetch contracts together with their current virtual outputs

package/dist/adapters/expo.cjs

@@ -1,19 +1,18 @@
 'use strict';
 
-var chunkHLCGYOIH_cjs = require('../chunk-HLCGYOIH.cjs');
-require('../chunk-NVZJSKZS.cjs');
-require('../chunk-JZWLXNHV.cjs');
-require('../chunk-5BLDMQED.cjs');
+var chunkGPJSGLWM_cjs = require('../chunk-GPJSGLWM.cjs');
+require('../chunk-SYRQJS5N.cjs');
+require('../chunk-C5Y2R63Z.cjs');
 
 
 
 Object.defineProperty(exports, "ExpoArkProvider", {
   enumerable: true,
-  get: function () { return chunkHLCGYOIH_cjs.ExpoArkProvider; }
+  get: function () { return chunkGPJSGLWM_cjs.ExpoArkProvider; }
 });
 Object.defineProperty(exports, "ExpoIndexerProvider", {
   enumerable: true,
-  get: function () { return chunkHLCGYOIH_cjs.ExpoIndexerProvider; }
+  get: function () { return chunkGPJSGLWM_cjs.ExpoIndexerProvider; }
 });
 //# sourceMappingURL=expo.cjs.map
 //# sourceMappingURL=expo.cjs.map

package/dist/adapters/expo.d.cts

@@ -1,5 +1,5 @@
-import { r as RestArkProvider, o as SettlementEvent, T as TxNotificationEvent, s as RestIndexerProvider, t as SubscriptionResponse } from '../index-DUxufw76.cjs';
-export { u as ArkProvider, v as IndexerProvider } from '../index-DUxufw76.cjs';
+import { q as RestArkProvider, n as SettlementEvent, T as TxNotificationEvent, r as RestIndexerProvider, s as SubscriptionResponse } from '../index-Czz9HSqE.cjs';
+export { t as ArkProvider, u as IndexerProvider } from '../index-Czz9HSqE.cjs';
 import '@scure/btc-signer/utils.js';
 import '@scure/btc-signer/transaction.js';
 import '@scure/btc-signer';

package/dist/adapters/expo.d.ts

@@ -1,5 +1,5 @@
-import { r as RestArkProvider, o as SettlementEvent, T as TxNotificationEvent, s as RestIndexerProvider, t as SubscriptionResponse } from '../index-DUxufw76.js';
-export { u as ArkProvider, v as IndexerProvider } from '../index-DUxufw76.js';
+import { q as RestArkProvider, n as SettlementEvent, T as TxNotificationEvent, r as RestIndexerProvider, s as SubscriptionResponse } from '../index-Czz9HSqE.js';
+export { t as ArkProvider, u as IndexerProvider } from '../index-Czz9HSqE.js';
 import '@scure/btc-signer/utils.js';
 import '@scure/btc-signer/transaction.js';
 import '@scure/btc-signer';

package/dist/adapters/expo.js

@@ -1,6 +1,5 @@
-export { ExpoArkProvider, ExpoIndexerProvider } from '../chunk-ZOTXDOS5.js';
-import '../chunk-4PKLULWT.js';
-import '../chunk-ISO4TI5J.js';
-import '../chunk-NSBPE2FW.js';
+export { ExpoArkProvider, ExpoIndexerProvider } from '../chunk-MOWSLXGO.js';
+import '../chunk-XHASFSDU.js';
+import '../chunk-GLZNJFAT.js';
 //# sourceMappingURL=expo.js.map
 //# sourceMappingURL=expo.js.map

package/dist/{asyncStorageTaskQueue-C5rBYlru.d.ts → asyncStorageTaskQueue-BCiOgs5x.d.ts}

@@ -1,4 +1,4 @@
-import { a as TaskQueue, c as TaskItem, d as TaskResult } from './taskRunner-D_iPiZIi.js';
+import { c as TaskQueue, a as TaskItem, b as TaskResult } from './taskRunner-DUId1UJ8.js';
 
 /**
  * Minimal async key-value storage interface.
@@ -46,4 +46,4 @@ declare class AsyncStorageTaskQueue implements TaskQueue {
     private writeList;
 }
 
-export { AsyncStorageTaskQueue as A, type AsyncStorageLike as a };
+export { type AsyncStorageLike as A, AsyncStorageTaskQueue as a };

package/dist/{asyncStorageTaskQueue-BuDvgWh6.d.cts → asyncStorageTaskQueue-CTIwKrt5.d.cts}

@@ -1,4 +1,4 @@
-import { a as TaskQueue, c as TaskItem, d as TaskResult } from './taskRunner-Dr3NStc0.cjs';
+import { c as TaskQueue, a as TaskItem, b as TaskResult } from './taskRunner-7E_Rx8bD.cjs';
 
 /**
  * Minimal async key-value storage interface.
@@ -46,4 +46,4 @@ declare class AsyncStorageTaskQueue implements TaskQueue {
     private writeList;
 }
 
-export { AsyncStorageTaskQueue as A, type AsyncStorageLike as a };
+export { type AsyncStorageLike as A, AsyncStorageTaskQueue as a };

package/dist/{chunk-3R476TDV.js → chunk-4EZOMPAO.js}

@@ -1,5 +1,4 @@
-import { VtxoScript, MultisigTapscript, CSVMultisigTapscript, timelockToSequence, sequenceToTimelock, ConditionMultisigTapscript, CLTVMultisigTapscript, ConditionCSVMultisigTapscript, SCRIPT_QUERY_CHUNK_SIZE, getNormalizedVtxos, DEFAULT_PAGE_SIZE } from './chunk-ISO4TI5J.js';
-import { __export } from './chunk-NSBPE2FW.js';
+import { __export, VtxoScript, MultisigTapscript, CSVMultisigTapscript, timelockToSequence, sequenceToTimelock, ConditionMultisigTapscript, CLTVMultisigTapscript, ConditionCSVMultisigTapscript, SCRIPT_QUERY_CHUNK_SIZE, getNormalizedVtxos, DEFAULT_PAGE_SIZE } from './chunk-GLZNJFAT.js';
 import { hex } from '@scure/base';
 import { networks, expand } from '@bitcoinerlab/descriptors-scure';
 import { ScriptNum, OP, Script } from '@scure/btc-signer';
@@ -266,21 +265,8 @@ function resolveRole(contract, context) {
     }
     return void 0;
   };
-  if (context.walletDescriptor) {
-    const walletDescriptorKey = extractRawPubKey(context.walletDescriptor);
-    const matchedRole = matchRole(walletDescriptorKey);
-    if (matchedRole) {
-      return matchedRole;
-    }
-    if (!walletDescriptorKey && context.walletPubKey) {
-      return matchRole(extractRawPubKey(context.walletPubKey));
-    }
-    return void 0;
-  }
-  if (context.walletPubKey) {
-    return matchRole(extractRawPubKey(context.walletPubKey));
-  }
-  return void 0;
+  if (!context.walletDescriptor) return void 0;
+  return matchRole(extractRawPubKey(context.walletDescriptor));
 }
 function extractPubKeyBytes(value) {
   return hex.decode(extractPubKey(normalizeToDescriptor(value)));
@@ -1867,7 +1853,7 @@ var VHTLCContractHandler = {
    * Select spending path based on context.
    *
    * Role is determined from `context.role` or by matching
-   * `context.walletDescriptor` (preferred) / `context.walletPubKey`
+   * `context.walletDescriptor`
    * against sender/receiver in contract params.
    */
   selectPath(script, contract, context) {
@@ -1914,7 +1900,7 @@ var VHTLCContractHandler = {
    * Get all possible spending paths (no timelock checks).
    *
    * Role is determined from `context.role` or by matching
-   * `context.walletDescriptor` (preferred) / `context.walletPubKey`
+   * `context.walletDescriptor`
    * against sender/receiver in contract params.
    */
   getAllSpendingPaths(script, contract, context) {
@@ -2229,7 +2215,7 @@ var VHTLCV2ContractHandler = {
    * Select spending path based on context.
    *
    * Role is determined from `context.role` or by matching
-   * `context.walletDescriptor` (preferred) / `context.walletPubKey`
+   * `context.walletDescriptor`
    * against sender/receiver in contract params.
    */
   selectPath(script, contract, context) {
@@ -2276,7 +2262,7 @@ var VHTLCV2ContractHandler = {
    * Get all possible spending paths (no timelock checks).
    *
    * Role is determined from `context.role` or by matching
-   * `context.walletDescriptor` (preferred) / `context.walletPubKey`
+   * `context.walletDescriptor`
    * against sender/receiver in contract params.
    */
   getAllSpendingPaths(script, contract, context) {
@@ -2850,22 +2836,12 @@ function deserializeArkadeContractParams(params) {
 
 // src/contracts/handlers/arkade.ts
 function walletKeyFrom(context) {
-  const extract = (value) => {
-    if (!isDescriptor(value)) return value.toLowerCase();
-    try {
-      return extractPubKey(value).toLowerCase();
-    } catch {
-      return void 0;
-    }
-  };
-  if (context.walletDescriptor) {
-    const key = extract(context.walletDescriptor);
-    if (key) return key;
-  }
-  if (context.walletPubKey) {
-    return extract(context.walletPubKey);
+  if (!context.walletDescriptor) return void 0;
+  try {
+    return extractPubKey(context.walletDescriptor).toLowerCase();
+  } catch {
+    return void 0;
   }
-  return void 0;
 }
 function staticWitness(fn, script) {
   const refs = fn.def.tapscript.witness ?? [];
@@ -2987,5 +2963,5 @@ contractHandlers.register(BoardingContractHandler);
 contractHandlers.register(ArkadeContractHandler);
 
 export { ARKADE_OP, ARKADE_OPCODES, ARKADE_OPCODE_NAMES, ARKADE_OPCODE_VALUES, ARKADE_OPS, ArkadeContractHandler, ArkadeProgramScript, ArkadeScript, BoardingContractHandler, DefaultContractHandler, DefaultVtxo, DelegateContractHandler, DelegateVtxo, OPCODE_NAMES, OPCODE_VALUES, SUPPORTED_PROGRAM_VERSION, VHTLC, VHTLCContractHandler, VHTLCV2ContractHandler, WALLET_RECEIVE_SOURCE, arkadeScriptHash, arkadeWitnessHash, asmToBytes, bignum_exports, bytesToASM, computeArkadeScriptPublicKey, contractHandlers, deriveDescriptorLeafCompressedPubKey, deriveDescriptorLeafPubKey, descriptorIsOurs, deserializeArkadeContractParams, fromASM, getOpcodeName, getOpcodeValue, identityDescriptor, inputName, isCltvSatisfied, isCsvSpendable, isMainnetDescriptor, normalizeToDescriptor, parseArtifact, parseHDDescriptor, resolveAsm, serializeArkadeContractParams, speculativeReceiveMetadata, stringifyArtifact, toASM, toXOnly, validateProgram, witnessRefToBytes };
-//# sourceMappingURL=chunk-3R476TDV.js.map
-//# sourceMappingURL=chunk-3R476TDV.js.map
+//# sourceMappingURL=chunk-4EZOMPAO.js.map
+//# sourceMappingURL=chunk-4EZOMPAO.js.map