@bsv/message-box-client 2.0.2 → 2.0.4

package/dist/esm/src/RemittanceAdapter.js

@@ -0,0 +1,133 @@
+/**
+ * RemittanceAdapter - Adapts MessageBoxClient to the CommsLayer interface
+ *
+ * This adapter bridges MessageBoxClient with the ts-sdk RemittanceManager by implementing
+ * the CommsLayer interface. It handles the protocol differences between the two systems,
+ * particularly around message body format (MessageBoxClient returns parsed objects,
+ * RemittanceManager expects JSON strings).
+ *
+ * @example
+ * ```typescript
+ * import { RemittanceAdapter } from '@bsv/message-box-client'
+ * import { RemittanceManager } from '@bsv/sdk'
+ * import { MessageBoxClient } from '@bsv/message-box-client'
+ * import { WalletClient } from '@bsv/sdk'
+ *
+ * const wallet = new WalletClient()
+ * const messageBox = new MessageBoxClient({ walletClient: wallet })
+ * const commsLayer = new RemittanceAdapter(messageBox)
+ *
+ * const manager = new RemittanceManager(
+ *   {
+ *     messageBox: 'remittance_inbox',
+ *     remittanceModules: [new Brc29RemittanceModule()]
+ *   },
+ *   wallet,
+ *   commsLayer
+ * )
+ * ```
+ */
+/**
+ * Adapter that implements the CommsLayer interface for MessageBoxClient
+ *
+ * This class wraps MessageBoxClient to provide compatibility with the RemittanceManager
+ * communications interface. It handles format conversions, particularly ensuring message
+ * bodies are properly stringified for the RemittanceManager protocol.
+ */
+export class RemittanceAdapter {
+    messageBox;
+    /**
+     * Creates a new RemittanceAdapter
+     * @param messageBox - The MessageBoxClient instance to adapt
+     */
+    constructor(messageBox) {
+        this.messageBox = messageBox;
+    }
+    /**
+     * Sends a message over the store-and-forward channel
+     * @param args - Message parameters (recipient, messageBox, body)
+     * @param hostOverride - Optional host override
+     * @returns The transport message ID
+     */
+    async sendMessage(args, hostOverride) {
+        const result = await this.messageBox.sendMessage({
+            recipient: args.recipient,
+            messageBox: args.messageBox,
+            body: args.body
+        }, hostOverride);
+        return result.messageId;
+    }
+    /**
+     * Sends a message over the live channel.
+     * MessageBoxClient handles transport fallback internally (WebSocket -> HTTP).
+     * @param args - Message parameters (recipient, messageBox, body)
+     * @param hostOverride - Optional host override
+     * @returns The transport message ID
+     */
+    async sendLiveMessage(args, hostOverride) {
+        const result = await this.messageBox.sendLiveMessage({
+            recipient: args.recipient,
+            messageBox: args.messageBox,
+            body: args.body
+        }, hostOverride);
+        return result.messageId;
+    }
+    /**
+     * Lists pending messages for a message box
+     *
+     * Note: MessageBoxClient returns message bodies as parsed objects, but RemittanceManager
+     * expects them as JSON strings. This method handles the conversion.
+     *
+     * @param args - List parameters (messageBox, optional host)
+     * @returns Array of peer messages with stringified bodies
+     */
+    async listMessages(args) {
+        const defaultRecipient = await this.messageBox.getIdentityKey();
+        const messages = await this.messageBox.listMessages({
+            messageBox: args.messageBox,
+            host: args.host
+        });
+        return messages.map(msg => this.toRemittancePeerMessage(msg, args.messageBox, defaultRecipient));
+    }
+    /**
+     * Acknowledges messages (deletes them from the server inbox)
+     * @param args - Array of message IDs to acknowledge
+     */
+    async acknowledgeMessage(args) {
+        // MessageBoxClient's acknowledgeMessage expects the same format
+        await this.messageBox.acknowledgeMessage({ messageIds: args.messageIds });
+    }
+    /**
+     * Starts a live listener and normalizes inbound messages to the remittance PeerMessage shape.
+     */
+    async listenForLiveMessages(args) {
+        const defaultRecipient = await this.messageBox.getIdentityKey();
+        await this.messageBox.listenForLiveMessages({
+            messageBox: args.messageBox,
+            overrideHost: args.overrideHost,
+            onMessage: (msg) => {
+                args.onMessage(this.toRemittancePeerMessage(msg, args.messageBox, defaultRecipient));
+            }
+        });
+    }
+    toRemittancePeerMessage(msg, fallbackMessageBox, fallbackRecipient) {
+        return {
+            messageId: msg.messageId,
+            sender: msg.sender,
+            recipient: (msg.recipient ?? fallbackRecipient),
+            messageBox: msg.messageBox ?? fallbackMessageBox,
+            body: this.toBodyString(msg.body)
+        };
+    }
+    toBodyString(body) {
+        if (typeof body === 'string')
+            return body;
+        try {
+            return JSON.stringify(body);
+        }
+        catch {
+            return String(body);
+        }
+    }
+}
+//# sourceMappingURL=RemittanceAdapter.js.map

package/dist/esm/src/RemittanceAdapter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RemittanceAdapter.js","sourceRoot":"","sources":["../../../src/RemittanceAdapter.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AAaH;;;;;;GAMG;AACH,MAAM,OAAO,iBAAiB;IAKC;IAJ7B;;;OAGG;IACH,YAA6B,UAA4B;QAA5B,eAAU,GAAV,UAAU,CAAkB;IAAI,CAAC;IAE9D;;;;;OAKG;IACH,KAAK,CAAC,WAAW,CACf,IAAgE,EAChE,YAAqB;QAErB,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC;YAC/C,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,UAAU,EAAE,IAAI,CAAC,UAAU;YAC3B,IAAI,EAAE,IAAI,CAAC,IAAI;SAChB,EAAE,YAAY,CAAC,CAAA;QAEhB,OAAO,MAAM,CAAC,SAAS,CAAA;IACzB,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,eAAe,CACnB,IAAgE,EAChE,YAAqB;QAErB,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC;YACnD,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,UAAU,EAAE,IAAI,CAAC,UAAU;YAC3B,IAAI,EAAE,IAAI,CAAC,IAAI;SAChB,EAAE,YAAY,CAAC,CAAA;QAEhB,OAAO,MAAM,CAAC,SAAS,CAAA;IACzB,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,YAAY,CAAC,IAA2C;QAC5D,MAAM,gBAAgB,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,cAAc,EAAe,CAAA;QAC5E,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC;YAClD,UAAU,EAAE,IAAI,CAAC,UAAU;YAC3B,IAAI,EAAE,IAAI,CAAC,IAAI;SAChB,CAAC,CAAA;QAEF,OAAO,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,uBAAuB,CAAC,GAAG,EAAE,IAAI,CAAC,UAAU,EAAE,gBAAgB,CAAC,CAAC,CAAA;IAClG,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,kBAAkB,CAAC,IAA8B;QACrD,gEAAgE;QAChE,MAAM,IAAI,CAAC,UAAU,CAAC,kBAAkB,CAAC,EAAE,UAAU,EAAE,IAAI,CAAC,UAAU,EAAE,CAAC,CAAA;IAC3E,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,qBAAqB,CAAC,IAI3B;QACC,MAAM,gBAAgB,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,cAAc,EAAe,CAAA;QAE5E,MAAM,IAAI,CAAC,UAAU,CAAC,qBAAqB,CAAC;YAC1C,UAAU,EAAE,IAAI,CAAC,UAAU;YAC3B,YAAY,EAAE,IAAI,CAAC,YAAY;YAC/B,SAAS,EAAE,CAAC,GAA0B,EAAE,EAAE;gBACxC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,uBAAuB,CAAC,GAAG,EAAE,IAAI,CAAC,UAAU,EAAE,gBAAgB,CAAC,CAAC,CAAA;YACtF,CAAC;SACF,CAAC,CAAA;IACJ,CAAC;IAEO,uBAAuB,CAC7B,GAAwE,EACxE,kBAA0B,EAC1B,iBAA4B;QAE5B,OAAO;YACL,SAAS,EAAE,GAAG,CAAC,SAAS;YACxB,MAAM,EAAE,GAAG,CAAC,MAAmB;YAC/B,SAAS,EAAE,CAAC,GAAG,CAAC,SAAS,IAAI,iBAAiB,CAAc;YAC5D,UAAU,EAAE,GAAG,CAAC,UAAU,IAAI,kBAAkB;YAChD,IAAI,EAAE,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,IAAI,CAAC;SAClC,CAAA;IACH,CAAC;IAEO,YAAY,CAAE,IAAa;QACjC,IAAI,OAAO,IAAI,KAAK,QAAQ;YAAE,OAAO,IAAI,CAAA;QACzC,IAAI,CAAC;YACH,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAA;QAC7B,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,MAAM,CAAC,IAAI,CAAC,CAAA;QACrB,CAAC;IACH,CAAC;CACF"}

package/dist/esm/src/__tests/RemittanceAdapter.test.js

@@ -0,0 +1,131 @@
+/* eslint-env jest */
+import { jest } from '@jest/globals';
+import { RemittanceAdapter } from '../RemittanceAdapter.js';
+describe('RemittanceAdapter', () => {
+    const myIdentityKey = '02b463b8ef7f03c47fba2679c7334d13e4939b8ca30dbb6bbd22e34ea3e9b1b0e4';
+    const senderKey = '03f5d7a10f8ac22f0785a54d7d30fd009a77da27812f4e2f4ac9327dfcb5f65f86';
+    it('delegates sendMessage and returns the transport messageId', async () => {
+        const messageBox = {
+            sendMessage: jest.fn().mockResolvedValue({
+                status: 'success',
+                messageId: 'http-mid'
+            })
+        };
+        const adapter = new RemittanceAdapter(messageBox);
+        const result = await adapter.sendMessage({
+            recipient: senderKey,
+            messageBox: 'remittance_inbox',
+            body: '{"v":1}'
+        }, 'https://override-host');
+        expect(result).toBe('http-mid');
+        expect(messageBox.sendMessage).toHaveBeenCalledWith({
+            recipient: senderKey,
+            messageBox: 'remittance_inbox',
+            body: '{"v":1}'
+        }, 'https://override-host');
+    });
+    it('delegates sendLiveMessage (live path) and returns the transport messageId', async () => {
+        const messageBox = {
+            sendLiveMessage: jest.fn().mockResolvedValue({
+                status: 'success',
+                messageId: 'ws-mid'
+            })
+        };
+        const adapter = new RemittanceAdapter(messageBox);
+        const result = await adapter.sendLiveMessage({
+            recipient: senderKey,
+            messageBox: 'remittance_inbox',
+            body: '{"v":1}'
+        }, 'https://override-host');
+        expect(result).toBe('ws-mid');
+        expect(messageBox.sendLiveMessage).toHaveBeenCalledWith({
+            recipient: senderKey,
+            messageBox: 'remittance_inbox',
+            body: '{"v":1}'
+        }, 'https://override-host');
+    });
+    it('normalizes listMessages shape for remittance and forwards host', async () => {
+        const messageBox = {
+            getIdentityKey: jest.fn().mockResolvedValue(myIdentityKey),
+            listMessages: jest.fn().mockResolvedValue([
+                {
+                    messageId: 'm1',
+                    sender: senderKey,
+                    created_at: '2026-01-01T00:00:00Z',
+                    updated_at: '2026-01-01T00:00:00Z',
+                    body: { kind: 'invoice', amount: 1 }
+                },
+                {
+                    messageId: 'm2',
+                    sender: senderKey,
+                    recipient: '020202020202020202020202020202020202020202020202020202020202020202',
+                    messageBox: 'custom_box',
+                    created_at: '2026-01-01T00:00:00Z',
+                    updated_at: '2026-01-01T00:00:00Z',
+                    body: '{"kind":"receipt"}'
+                }
+            ])
+        };
+        const adapter = new RemittanceAdapter(messageBox);
+        const result = await adapter.listMessages({
+            messageBox: 'remittance_inbox',
+            host: 'https://remote-host'
+        });
+        expect(messageBox.listMessages).toHaveBeenCalledWith({
+            messageBox: 'remittance_inbox',
+            host: 'https://remote-host'
+        });
+        expect(result).toEqual([
+            {
+                messageId: 'm1',
+                sender: senderKey,
+                recipient: myIdentityKey,
+                messageBox: 'remittance_inbox',
+                body: '{"kind":"invoice","amount":1}'
+            },
+            {
+                messageId: 'm2',
+                sender: senderKey,
+                recipient: '020202020202020202020202020202020202020202020202020202020202020202',
+                messageBox: 'custom_box',
+                body: '{"kind":"receipt"}'
+            }
+        ]);
+    });
+    it('forwards live listener setup and normalizes inbound message shape', async () => {
+        const onPaymentMessage = jest.fn();
+        let forwardedListener;
+        const messageBox = {
+            getIdentityKey: jest.fn().mockResolvedValue(myIdentityKey),
+            listenForLiveMessages: jest.fn().mockImplementation(async ({ onMessage }) => {
+                forwardedListener = onMessage;
+            })
+        };
+        const adapter = new RemittanceAdapter(messageBox);
+        await adapter.listenForLiveMessages({
+            messageBox: 'remittance_inbox',
+            overrideHost: 'https://ws-host',
+            onMessage: onPaymentMessage
+        });
+        expect(messageBox.listenForLiveMessages).toHaveBeenCalledWith({
+            messageBox: 'remittance_inbox',
+            overrideHost: 'https://ws-host',
+            onMessage: expect.any(Function)
+        });
+        forwardedListener?.({
+            messageId: 'live-1',
+            sender: senderKey,
+            created_at: '2026-01-01T00:00:00Z',
+            updated_at: '2026-01-01T00:00:00Z',
+            body: { kind: 'settlement' }
+        });
+        expect(onPaymentMessage).toHaveBeenCalledWith({
+            messageId: 'live-1',
+            sender: senderKey,
+            recipient: myIdentityKey,
+            messageBox: 'remittance_inbox',
+            body: '{"kind":"settlement"}'
+        });
+    });
+});
+//# sourceMappingURL=RemittanceAdapter.test.js.map

package/dist/esm/src/__tests/RemittanceAdapter.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RemittanceAdapter.test.js","sourceRoot":"","sources":["../../../../src/__tests/RemittanceAdapter.test.ts"],"names":[],"mappings":"AAAA,qBAAqB;AACrB,OAAO,EAAE,IAAI,EAAE,MAAM,eAAe,CAAA;AACpC,OAAO,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAA;AAG3D,QAAQ,CAAC,mBAAmB,EAAE,GAAG,EAAE;IACjC,MAAM,aAAa,GAAG,oEAAoE,CAAA;IAC1F,MAAM,SAAS,GAAG,oEAAoE,CAAA;IAEtF,EAAE,CAAC,2DAA2D,EAAE,KAAK,IAAI,EAAE;QACzE,MAAM,UAAU,GAAG;YACjB,WAAW,EAAE,IAAI,CAAC,EAAE,EAAwD,CAAC,iBAAiB,CAAC;gBAC7F,MAAM,EAAE,SAAS;gBACjB,SAAS,EAAE,UAAU;aACtB,CAAC;SAC4B,CAAA;QAEhC,MAAM,OAAO,GAAG,IAAI,iBAAiB,CAAC,UAAU,CAAC,CAAA;QACjD,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,WAAW,CAAC;YACvC,SAAS,EAAE,SAAS;YACpB,UAAU,EAAE,kBAAkB;YAC9B,IAAI,EAAE,SAAS;SAChB,EAAE,uBAAuB,CAAC,CAAA;QAE3B,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;QAC/B,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC,oBAAoB,CAAC;YAClD,SAAS,EAAE,SAAS;YACpB,UAAU,EAAE,kBAAkB;YAC9B,IAAI,EAAE,SAAS;SAChB,EAAE,uBAAuB,CAAC,CAAA;IAC7B,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,2EAA2E,EAAE,KAAK,IAAI,EAAE;QACzF,MAAM,UAAU,GAAG;YACjB,eAAe,EAAE,IAAI,CAAC,EAAE,EAAwD,CAAC,iBAAiB,CAAC;gBACjG,MAAM,EAAE,SAAS;gBACjB,SAAS,EAAE,QAAQ;aACpB,CAAC;SAC4B,CAAA;QAEhC,MAAM,OAAO,GAAG,IAAI,iBAAiB,CAAC,UAAU,CAAC,CAAA;QACjD,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,eAAe,CAAC;YAC3C,SAAS,EAAE,SAAS;YACpB,UAAU,EAAE,kBAAkB;YAC9B,IAAI,EAAE,SAAS;SAChB,EAAE,uBAAuB,CAAC,CAAA;QAE3B,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;QAC7B,MAAM,CAAC,UAAU,CAAC,eAAe,CAAC,CAAC,oBAAoB,CAAC;YACtD,SAAS,EAAE,SAAS;YACpB,UAAU,EAAE,kBAAkB;YAC9B,IAAI,EAAE,SAAS;SAChB,EAAE,uBAAuB,CAAC,CAAA;IAC7B,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,gEAAgE,EAAE,KAAK,IAAI,EAAE;QAC9E,MAAM,UAAU,GAAG;YACjB,cAAc,EAAE,IAAI,CAAC,EAAE,EAAyB,CAAC,iBAAiB,CAAC,aAAa,CAAC;YACjF,YAAY,EAAE,IAAI,CAAC,EAAE,EAAwB,CAAC,iBAAiB,CAAC;gBAC9D;oBACE,SAAS,EAAE,IAAI;oBACf,MAAM,EAAE,SAAS;oBACjB,UAAU,EAAE,sBAAsB;oBAClC,UAAU,EAAE,sBAAsB;oBAClC,IAAI,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,EAAE,CAAC,EAAE;iBACrC;gBACD;oBACE,SAAS,EAAE,IAAI;oBACf,MAAM,EAAE,SAAS;oBACjB,SAAS,EAAE,oEAAoE;oBAC/E,UAAU,EAAE,YAAY;oBACxB,UAAU,EAAE,sBAAsB;oBAClC,UAAU,EAAE,sBAAsB;oBAClC,IAAI,EAAE,oBAAoB;iBAC3B;aACF,CAAC;SAC4B,CAAA;QAEhC,MAAM,OAAO,GAAG,IAAI,iBAAiB,CAAC,UAAU,CAAC,CAAA;QACjD,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,YAAY,CAAC;YACxC,UAAU,EAAE,kBAAkB;YAC9B,IAAI,EAAE,qBAAqB;SAC5B,CAAC,CAAA;QAEF,MAAM,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC,oBAAoB,CAAC;YACnD,UAAU,EAAE,kBAAkB;YAC9B,IAAI,EAAE,qBAAqB;SAC5B,CAAC,CAAA;QACF,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC;YACrB;gBACE,SAAS,EAAE,IAAI;gBACf,MAAM,EAAE,SAAS;gBACjB,SAAS,EAAE,aAAa;gBACxB,UAAU,EAAE,kBAAkB;gBAC9B,IAAI,EAAE,+BAA+B;aACtC;YACD;gBACE,SAAS,EAAE,IAAI;gBACf,MAAM,EAAE,SAAS;gBACjB,SAAS,EAAE,oEAAoE;gBAC/E,UAAU,EAAE,YAAY;gBACxB,IAAI,EAAE,oBAAoB;aAC3B;SACF,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,mEAAmE,EAAE,KAAK,IAAI,EAAE;QACjF,MAAM,gBAAgB,GAAG,IAAI,CAAC,EAAE,EAAE,CAAA;QAClC,IAAI,iBAMmB,CAAA;QAEvB,MAAM,UAAU,GAAG;YACjB,cAAc,EAAE,IAAI,CAAC,EAAE,EAAyB,CAAC,iBAAiB,CAAC,aAAa,CAAC;YACjF,qBAAqB,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,kBAAkB,CAAC,KAAK,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE;gBAC1E,iBAAiB,GAAG,SAAS,CAAA;YAC/B,CAAC,CAAC;SAC4B,CAAA;QAEhC,MAAM,OAAO,GAAG,IAAI,iBAAiB,CAAC,UAAU,CAAC,CAAA;QACjD,MAAM,OAAO,CAAC,qBAAqB,CAAC;YAClC,UAAU,EAAE,kBAAkB;YAC9B,YAAY,EAAE,iBAAiB;YAC/B,SAAS,EAAE,gBAAgB;SAC5B,CAAC,CAAA;QAEF,MAAM,CAAC,UAAU,CAAC,qBAAqB,CAAC,CAAC,oBAAoB,CAAC;YAC5D,UAAU,EAAE,kBAAkB;YAC9B,YAAY,EAAE,iBAAiB;YAC/B,SAAS,EAAE,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;SAChC,CAAC,CAAA;QAEF,iBAAiB,EAAE,CAAC;YAClB,SAAS,EAAE,QAAQ;YACnB,MAAM,EAAE,SAAS;YACjB,UAAU,EAAE,sBAAsB;YAClC,UAAU,EAAE,sBAAsB;YAClC,IAAI,EAAE,EAAE,IAAI,EAAE,YAAY,EAAE;SAC7B,CAAC,CAAA;QAEF,MAAM,CAAC,gBAAgB,CAAC,CAAC,oBAAoB,CAAC;YAC5C,SAAS,EAAE,QAAQ;YACnB,MAAM,EAAE,SAAS;YACjB,SAAS,EAAE,aAAa;YACxB,UAAU,EAAE,kBAAkB;YAC9B,IAAI,EAAE,uBAAuB;SAC9B,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA"}