@meshconnect/uwc-bitcoin 0.2.2 → 0.2.3

package/dist/adapter.d.ts

@@ -0,0 +1,25 @@
+import type { BitcoinAccount, BitcoinSignMessageParams, SignatureType } from '@meshconnect/uwc-types';
+/**
+ * The seam between the Bitcoin namespace module and a single transport.
+ *
+ * A concrete adapter (Phase 3) is constructed by its transport bound to an
+ * already-connected provider/session — Wallet Standard `bitcoin:*` for the
+ * injected transport, WalletConnect bip122 for the WalletConnect transport —
+ * so the port carries no `connect`/provider argument: connecting is the
+ * transport's job. Each adapter converts between these transport-agnostic
+ * domain shapes and its wallet's native interface (e.g. hex ↔ `Uint8Array`).
+ *
+ * Phase 2 locks the grounded verify-flow methods. `signPsbt` (Path B, returns a
+ * signed PSBT the module then finalizes + broadcasts) and `sendTransfer`
+ * (Path A) are added alongside their concrete adapters in Phase 3 rather than
+ * guessed here.
+ */
+export interface BitcoinTransportAdapter {
+    /** Enumerate the bip122 accounts available on the connected session. */
+    getAccounts(): Promise<BitcoinAccount[]>;
+    /** Sign a message with the given account. */
+    signMessage(params: BitcoinSignMessageParams): Promise<SignatureType>;
+    /** Release any session resources the adapter holds. Optional. */
+    disconnect?(): Promise<void>;
+}
+//# sourceMappingURL=adapter.d.ts.map

package/dist/adapter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"adapter.d.ts","sourceRoot":"","sources":["../src/adapter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,cAAc,EACd,wBAAwB,EACxB,aAAa,EACd,MAAM,wBAAwB,CAAA;AAE/B;;;;;;;;;;;;;;GAcG;AACH,MAAM,WAAW,uBAAuB;IACtC,wEAAwE;IACxE,WAAW,IAAI,OAAO,CAAC,cAAc,EAAE,CAAC,CAAA;IAExC,6CAA6C;IAC7C,WAAW,CAAC,MAAM,EAAE,wBAAwB,GAAG,OAAO,CAAC,aAAa,CAAC,CAAA;IAErE,iEAAiE;IACjE,UAAU,CAAC,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;CAC7B"}

package/dist/adapter.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=adapter.js.map

package/dist/adapter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"adapter.js","sourceRoot":"","sources":["../src/adapter.ts"],"names":[],"mappings":""}

package/dist/bitcoin-namespace.d.ts

@@ -1,4 +1,5 @@
-import type { Namespace, Network } from '@meshconnect/uwc-types';
+import type { BitcoinAccount, BitcoinSignMessageParams, Namespace, Network, SignatureType } from '@meshconnect/uwc-types';
+import type { BitcoinTransportAdapter } from './adapter';
 /** CAIP-2 namespace this module serves. */
 export declare const BITCOIN_NAMESPACE: Namespace;
 /**
@@ -14,23 +15,30 @@ export declare function assertBitcoinNetwork(network: Network, method: string):
  * (`injected-connector`, `wallet-connect-connector`) own wallet discovery,
  * pairing, and the provider/session lifecycle. This module owns only
  * Bitcoin-specific operations performed against a transport-supplied
- * provider/session — enumerating bip122 accounts, signing messages,
- * building/signing/finalizing PSBTs, and broadcasting. Both transports
- * dispatch their `bip122` branch into the matching adapter here.
+ * provider/session, delegating each to the {@link BitcoinTransportAdapter} it
+ * was constructed with — the transport builds that adapter bound to the live
+ * session.
  *
- * Those operations, and the provider/session types they take, land on the
- * `BitcoinTransportAdapter` port in Phase 2 — deferred here so the scaffold
- * doesn't pre-commit signatures before those types exist.
- *
- * Phase 1 (scaffold): namespace identity + the shared network guard only.
+ * Phase 2 exposes the grounded verify-flow operations (account enumeration and
+ * message signing). PSBT signing (Path B) plus finalize/broadcast, and the
+ * high-level `sendTransfer` (Path A), land in Phase 3 alongside their concrete
+ * adapters.
  *
  * Phased build plan:
  * https://app.notion.com/p/3a5f862e950a8187b3d3f0e255d13f45
  */
 export declare class BitcoinNamespace {
+    private readonly adapter;
     /** CAIP-2 namespace this module serves. */
     readonly namespace: Namespace;
+    constructor(adapter: BitcoinTransportAdapter);
     /** Throws unless `network` is a bip122 network. */
     assertSupportedNetwork(network: Network): void;
+    /** Enumerate the bip122 accounts on the connected session. */
+    getAccounts(): Promise<BitcoinAccount[]>;
+    /** Sign a message with the given account. */
+    signMessage(params: BitcoinSignMessageParams): Promise<SignatureType>;
+    /** Release any session resources the adapter holds. */
+    disconnect(): Promise<void>;
 }
 //# sourceMappingURL=bitcoin-namespace.d.ts.map

package/dist/bitcoin-namespace.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"bitcoin-namespace.d.ts","sourceRoot":"","sources":["../src/bitcoin-namespace.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAA;AAGhE,2CAA2C;AAC3C,eAAO,MAAM,iBAAiB,EAAE,SAAoB,CAAA;AAEpD;;;GAGG;AACH,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,GAAG,IAAI,CAO3E;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,qBAAa,gBAAgB;IAC3B,2CAA2C;IAC3C,QAAQ,CAAC,SAAS,YAAoB;IAEtC,mDAAmD;IACnD,sBAAsB,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI;CAG/C"}
+{"version":3,"file":"bitcoin-namespace.d.ts","sourceRoot":"","sources":["../src/bitcoin-namespace.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,cAAc,EACd,wBAAwB,EACxB,SAAS,EACT,OAAO,EACP,aAAa,EACd,MAAM,wBAAwB,CAAA;AAE/B,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,WAAW,CAAA;AAExD,2CAA2C;AAC3C,eAAO,MAAM,iBAAiB,EAAE,SAAoB,CAAA;AAEpD;;;GAGG;AACH,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,GAAG,IAAI,CAO3E;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,qBAAa,gBAAgB;IAIf,OAAO,CAAC,QAAQ,CAAC,OAAO;IAHpC,2CAA2C;IAC3C,QAAQ,CAAC,SAAS,YAAoB;gBAET,OAAO,EAAE,uBAAuB;IAE7D,mDAAmD;IACnD,sBAAsB,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI;IAI9C,8DAA8D;IAC9D,WAAW,IAAI,OAAO,CAAC,cAAc,EAAE,CAAC;IAIxC,6CAA6C;IAC7C,WAAW,CAAC,MAAM,EAAE,wBAAwB,GAAG,OAAO,CAAC,aAAa,CAAC;IAIrE,uDAAuD;IACjD,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;CAGlC"}

package/dist/bitcoin-namespace.js

@@ -21,25 +21,40 @@ export function assertBitcoinNetwork(network, method) {
  * (`injected-connector`, `wallet-connect-connector`) own wallet discovery,
  * pairing, and the provider/session lifecycle. This module owns only
  * Bitcoin-specific operations performed against a transport-supplied
- * provider/session — enumerating bip122 accounts, signing messages,
- * building/signing/finalizing PSBTs, and broadcasting. Both transports
- * dispatch their `bip122` branch into the matching adapter here.
+ * provider/session, delegating each to the {@link BitcoinTransportAdapter} it
+ * was constructed with — the transport builds that adapter bound to the live
+ * session.
  *
- * Those operations, and the provider/session types they take, land on the
- * `BitcoinTransportAdapter` port in Phase 2 — deferred here so the scaffold
- * doesn't pre-commit signatures before those types exist.
- *
- * Phase 1 (scaffold): namespace identity + the shared network guard only.
+ * Phase 2 exposes the grounded verify-flow operations (account enumeration and
+ * message signing). PSBT signing (Path B) plus finalize/broadcast, and the
+ * high-level `sendTransfer` (Path A), land in Phase 3 alongside their concrete
+ * adapters.
  *
  * Phased build plan:
  * https://app.notion.com/p/3a5f862e950a8187b3d3f0e255d13f45
  */
 export class BitcoinNamespace {
+    adapter;
     /** CAIP-2 namespace this module serves. */
     namespace = BITCOIN_NAMESPACE;
+    constructor(adapter) {
+        this.adapter = adapter;
+    }
     /** Throws unless `network` is a bip122 network. */
     assertSupportedNetwork(network) {
         assertBitcoinNetwork(network, 'BitcoinNamespace.assertSupportedNetwork');
     }
+    /** Enumerate the bip122 accounts on the connected session. */
+    getAccounts() {
+        return this.adapter.getAccounts();
+    }
+    /** Sign a message with the given account. */
+    signMessage(params) {
+        return this.adapter.signMessage(params);
+    }
+    /** Release any session resources the adapter holds. */
+    async disconnect() {
+        await this.adapter.disconnect?.();
+    }
 }
 //# sourceMappingURL=bitcoin-namespace.js.map

package/dist/bitcoin-namespace.js.map

@@ -1 +1 @@
-{"version":3,"file":"bitcoin-namespace.js","sourceRoot":"","sources":["../src/bitcoin-namespace.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAA;AAE7D,2CAA2C;AAC3C,MAAM,CAAC,MAAM,iBAAiB,GAAc,QAAQ,CAAA;AAEpD;;;GAGG;AACH,MAAM,UAAU,oBAAoB,CAAC,OAAgB,EAAE,MAAc;IACnE,IAAI,OAAO,CAAC,SAAS,KAAK,iBAAiB,EAAE,CAAC;QAC5C,MAAM,IAAI,oBAAoB,CAAC;YAC7B,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,GAAG,MAAM,wCAAwC,OAAO,CAAC,EAAE,GAAG;SACxE,CAAC,CAAA;IACJ,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,OAAO,gBAAgB;IAC3B,2CAA2C;IAClC,SAAS,GAAG,iBAAiB,CAAA;IAEtC,mDAAmD;IACnD,sBAAsB,CAAC,OAAgB;QACrC,oBAAoB,CAAC,OAAO,EAAE,yCAAyC,CAAC,CAAA;IAC1E,CAAC;CACF"}
+{"version":3,"file":"bitcoin-namespace.js","sourceRoot":"","sources":["../src/bitcoin-namespace.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAA;AAG7D,2CAA2C;AAC3C,MAAM,CAAC,MAAM,iBAAiB,GAAc,QAAQ,CAAA;AAEpD;;;GAGG;AACH,MAAM,UAAU,oBAAoB,CAAC,OAAgB,EAAE,MAAc;IACnE,IAAI,OAAO,CAAC,SAAS,KAAK,iBAAiB,EAAE,CAAC;QAC5C,MAAM,IAAI,oBAAoB,CAAC;YAC7B,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,GAAG,MAAM,wCAAwC,OAAO,CAAC,EAAE,GAAG;SACxE,CAAC,CAAA;IACJ,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,OAAO,gBAAgB;IAIE;IAH7B,2CAA2C;IAClC,SAAS,GAAG,iBAAiB,CAAA;IAEtC,YAA6B,OAAgC;QAAhC,YAAO,GAAP,OAAO,CAAyB;IAAG,CAAC;IAEjE,mDAAmD;IACnD,sBAAsB,CAAC,OAAgB;QACrC,oBAAoB,CAAC,OAAO,EAAE,yCAAyC,CAAC,CAAA;IAC1E,CAAC;IAED,8DAA8D;IAC9D,WAAW;QACT,OAAO,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,CAAA;IACnC,CAAC;IAED,6CAA6C;IAC7C,WAAW,CAAC,MAAgC;QAC1C,OAAO,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,MAAM,CAAC,CAAA;IACzC,CAAC;IAED,uDAAuD;IACvD,KAAK,CAAC,UAAU;QACd,MAAM,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,CAAA;IACnC,CAAC;CACF"}

package/dist/index.d.ts

@@ -1,2 +1,3 @@
 export { BitcoinNamespace, assertBitcoinNetwork, BITCOIN_NAMESPACE } from './bitcoin-namespace';
+export type { BitcoinTransportAdapter } from './adapter';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,gBAAgB,EAChB,oBAAoB,EACpB,iBAAiB,EAClB,MAAM,qBAAqB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,gBAAgB,EAChB,oBAAoB,EACpB,iBAAiB,EAClB,MAAM,qBAAqB,CAAA;AAC5B,YAAY,EAAE,uBAAuB,EAAE,MAAM,WAAW,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@meshconnect/uwc-bitcoin",
-  "version": "0.2.2",
+  "version": "0.2.3",
   "description": "Mesh-owned Bitcoin (bip122) namespace module for Universal Wallet Connector — network-specific logic (PSBT, address/network handling, mempool broadcast) with pluggable transport adapters (Wallet Standard bitcoin:* and WalletConnect bip122), consumed by the injected and walletConnect transport connectors",
   "type": "module",
   "main": "dist/index.js",
@@ -16,7 +16,7 @@
     "src"
   ],
   "dependencies": {
-    "@meshconnect/uwc-types": "0.25.0"
+    "@meshconnect/uwc-types": "0.26.0"
   },
   "devDependencies": {
     "typescript": "^5.9.3"

package/src/adapter.ts

@@ -0,0 +1,31 @@
+import type {
+  BitcoinAccount,
+  BitcoinSignMessageParams,
+  SignatureType
+} from '@meshconnect/uwc-types'
+
+/**
+ * The seam between the Bitcoin namespace module and a single transport.
+ *
+ * A concrete adapter (Phase 3) is constructed by its transport bound to an
+ * already-connected provider/session — Wallet Standard `bitcoin:*` for the
+ * injected transport, WalletConnect bip122 for the WalletConnect transport —
+ * so the port carries no `connect`/provider argument: connecting is the
+ * transport's job. Each adapter converts between these transport-agnostic
+ * domain shapes and its wallet's native interface (e.g. hex ↔ `Uint8Array`).
+ *
+ * Phase 2 locks the grounded verify-flow methods. `signPsbt` (Path B, returns a
+ * signed PSBT the module then finalizes + broadcasts) and `sendTransfer`
+ * (Path A) are added alongside their concrete adapters in Phase 3 rather than
+ * guessed here.
+ */
+export interface BitcoinTransportAdapter {
+  /** Enumerate the bip122 accounts available on the connected session. */
+  getAccounts(): Promise<BitcoinAccount[]>
+
+  /** Sign a message with the given account. */
+  signMessage(params: BitcoinSignMessageParams): Promise<SignatureType>
+
+  /** Release any session resources the adapter holds. Optional. */
+  disconnect?(): Promise<void>
+}

package/src/bitcoin-namespace.test.ts

@@ -1,11 +1,17 @@
-import { describe, it, expect } from 'vitest'
-import type { Network } from '@meshconnect/uwc-types'
+import { describe, it, expect, vi } from 'vitest'
+import type {
+  BitcoinAccount,
+  BitcoinSignMessageParams,
+  Network,
+  SignatureType
+} from '@meshconnect/uwc-types'
 import { WalletConnectorError } from '@meshconnect/uwc-types'
 import {
   BitcoinNamespace,
   assertBitcoinNetwork,
   BITCOIN_NAMESPACE
 } from './bitcoin-namespace'
+import type { BitcoinTransportAdapter } from './adapter'
 
 const bitcoinNetwork: Network = {
   internalId: 0,
@@ -27,6 +33,21 @@ const ethereumNetwork: Network = {
   networkType: 'evm'
 }
 
+const account: BitcoinAccount = {
+  address: 'bc1qexampleaddress',
+  publicKey: '02aabbcc',
+  purpose: 'payment'
+}
+
+const signature: SignatureType = { type: 'standard', signature: 'deadbeef' }
+
+/** Minimal fake adapter so the namespace's delegation can be asserted. */
+const fakeAdapter = (): BitcoinTransportAdapter => ({
+  getAccounts: vi.fn().mockResolvedValue([account]),
+  signMessage: vi.fn().mockResolvedValue(signature),
+  disconnect: vi.fn().mockResolvedValue(undefined)
+})
+
 describe('assertBitcoinNetwork', () => {
   it('passes for a bip122 network', () => {
     expect(() => assertBitcoinNetwork(bitcoinNetwork, 'test')).not.toThrow()
@@ -48,18 +69,51 @@ describe('assertBitcoinNetwork', () => {
 describe('BitcoinNamespace', () => {
   it('serves the bip122 namespace', () => {
     expect(BITCOIN_NAMESPACE).toBe('bip122')
-    expect(new BitcoinNamespace().namespace).toBe(BITCOIN_NAMESPACE)
+    expect(new BitcoinNamespace(fakeAdapter()).namespace).toBe(
+      BITCOIN_NAMESPACE
+    )
   })
 
   it('assertSupportedNetwork accepts a bip122 network', () => {
     expect(() =>
-      new BitcoinNamespace().assertSupportedNetwork(bitcoinNetwork)
+      new BitcoinNamespace(fakeAdapter()).assertSupportedNetwork(bitcoinNetwork)
     ).not.toThrow()
   })
 
   it('assertSupportedNetwork rejects a non-bip122 network', () => {
     expect(() =>
-      new BitcoinNamespace().assertSupportedNetwork(ethereumNetwork)
+      new BitcoinNamespace(fakeAdapter()).assertSupportedNetwork(
+        ethereumNetwork
+      )
     ).toThrow(WalletConnectorError)
   })
+
+  it('delegates getAccounts to the adapter', async () => {
+    const adapter = fakeAdapter()
+    const result = await new BitcoinNamespace(adapter).getAccounts()
+    expect(adapter.getAccounts).toHaveBeenCalledOnce()
+    expect(result).toEqual([account])
+  })
+
+  it('delegates signMessage to the adapter with the same params', async () => {
+    const adapter = fakeAdapter()
+    const params: BitcoinSignMessageParams = { account, message: 'verify me' }
+    const result = await new BitcoinNamespace(adapter).signMessage(params)
+    expect(adapter.signMessage).toHaveBeenCalledWith(params)
+    expect(result).toBe(signature)
+  })
+
+  it('delegates disconnect and tolerates an adapter without one', async () => {
+    const adapter = fakeAdapter()
+    await new BitcoinNamespace(adapter).disconnect()
+    expect(adapter.disconnect).toHaveBeenCalledOnce()
+
+    const noDisconnect: BitcoinTransportAdapter = {
+      getAccounts: adapter.getAccounts,
+      signMessage: adapter.signMessage
+    }
+    await expect(
+      new BitcoinNamespace(noDisconnect).disconnect()
+    ).resolves.toBeUndefined()
+  })
 })

package/src/bitcoin-namespace.ts

@@ -1,5 +1,12 @@
-import type { Namespace, Network } from '@meshconnect/uwc-types'
+import type {
+  BitcoinAccount,
+  BitcoinSignMessageParams,
+  Namespace,
+  Network,
+  SignatureType
+} from '@meshconnect/uwc-types'
 import { WalletConnectorError } from '@meshconnect/uwc-types'
+import type { BitcoinTransportAdapter } from './adapter'
 
 /** CAIP-2 namespace this module serves. */
 export const BITCOIN_NAMESPACE: Namespace = 'bip122'
@@ -25,15 +32,14 @@ export function assertBitcoinNetwork(network: Network, method: string): void {
  * (`injected-connector`, `wallet-connect-connector`) own wallet discovery,
  * pairing, and the provider/session lifecycle. This module owns only
  * Bitcoin-specific operations performed against a transport-supplied
- * provider/session — enumerating bip122 accounts, signing messages,
- * building/signing/finalizing PSBTs, and broadcasting. Both transports
- * dispatch their `bip122` branch into the matching adapter here.
+ * provider/session, delegating each to the {@link BitcoinTransportAdapter} it
+ * was constructed with — the transport builds that adapter bound to the live
+ * session.
  *
- * Those operations, and the provider/session types they take, land on the
- * `BitcoinTransportAdapter` port in Phase 2 — deferred here so the scaffold
- * doesn't pre-commit signatures before those types exist.
- *
- * Phase 1 (scaffold): namespace identity + the shared network guard only.
+ * Phase 2 exposes the grounded verify-flow operations (account enumeration and
+ * message signing). PSBT signing (Path B) plus finalize/broadcast, and the
+ * high-level `sendTransfer` (Path A), land in Phase 3 alongside their concrete
+ * adapters.
  *
  * Phased build plan:
  * https://app.notion.com/p/3a5f862e950a8187b3d3f0e255d13f45
@@ -42,8 +48,25 @@ export class BitcoinNamespace {
   /** CAIP-2 namespace this module serves. */
   readonly namespace = BITCOIN_NAMESPACE
 
+  constructor(private readonly adapter: BitcoinTransportAdapter) {}
+
   /** Throws unless `network` is a bip122 network. */
   assertSupportedNetwork(network: Network): void {
     assertBitcoinNetwork(network, 'BitcoinNamespace.assertSupportedNetwork')
   }
+
+  /** Enumerate the bip122 accounts on the connected session. */
+  getAccounts(): Promise<BitcoinAccount[]> {
+    return this.adapter.getAccounts()
+  }
+
+  /** Sign a message with the given account. */
+  signMessage(params: BitcoinSignMessageParams): Promise<SignatureType> {
+    return this.adapter.signMessage(params)
+  }
+
+  /** Release any session resources the adapter holds. */
+  async disconnect(): Promise<void> {
+    await this.adapter.disconnect?.()
+  }
 }

package/src/index.ts

@@ -3,3 +3,4 @@ export {
   assertBitcoinNetwork,
   BITCOIN_NAMESPACE
 } from './bitcoin-namespace'
+export type { BitcoinTransportAdapter } from './adapter'