@bsv/message-box-client 2.0.6 → 2.0.7

package/dist/types/src/PeerPayClient.d.ts

@@ -10,8 +10,11 @@
  * between identified peers on the BSV network.
  */
 import { MessageBoxClient } from './MessageBoxClient.js';
+import { PaymentRequestResponse, IncomingPaymentRequest, PaymentRequestLimits } from './types.js';
 import { WalletInterface, AtomicBEEF, Base64String, OriginatorDomainNameStringUnder250Bytes } from '@bsv/sdk';
 export declare const STANDARD_PAYMENT_MESSAGEBOX = "payment_inbox";
+export declare const PAYMENT_REQUESTS_MESSAGEBOX = "payment_requests";
+export declare const PAYMENT_REQUEST_RESPONSES_MESSAGEBOX = "payment_request_responses";
 /**
  * Configuration options for initializing PeerPayClient.
  */
@@ -60,6 +63,41 @@ export declare class PeerPayClient extends MessageBoxClient {
     private readonly settlementModule;
     constructor(config: PeerPayClientConfig);
     private get authFetchInstance();
+    /**
+     * Allows payment requests from a specific identity key by setting
+     * the recipientFee to 0 for the payment_requests message box.
+     *
+     * @param {Object} params - Parameters.
+     * @param {string} params.identityKey - The identity key to allow payment requests from.
+     * @returns {Promise<void>} Resolves when the permission is set.
+     */
+    allowPaymentRequestsFrom({ identityKey }: {
+        identityKey: string;
+    }): Promise<void>;
+    /**
+     * Blocks payment requests from a specific identity key by setting
+     * the recipientFee to -1 for the payment_requests message box.
+     *
+     * @param {Object} params - Parameters.
+     * @param {string} params.identityKey - The identity key to block payment requests from.
+     * @returns {Promise<void>} Resolves when the permission is set.
+     */
+    blockPaymentRequestsFrom({ identityKey }: {
+        identityKey: string;
+    }): Promise<void>;
+    /**
+     * Lists all permissions for the payment_requests message box, mapped to
+     * a simplified { identityKey, allowed } structure.
+     *
+     * A permission is considered "allowed" if recipientFee >= 0 (0 = always allow,
+     * positive = payment required). A recipientFee of -1 means blocked.
+     *
+     * @returns {Promise<Array<{ identityKey: string, allowed: boolean }>>} Resolved with the list of permissions.
+     */
+    listPaymentRequestPermissions(): Promise<Array<{
+        identityKey: string;
+        allowed: boolean;
+    }>>;
     /**
      * Generates a valid payment token for a recipient.
      *
@@ -151,5 +189,126 @@ export declare class PeerPayClient extends MessageBoxClient {
      * @returns {Promise<IncomingPayment[]>} Resolves with an array of pending payments.
      */
     listIncomingPayments(overrideHost?: string): Promise<IncomingPayment[]>;
+    /**
+     * Lists all responses to payment requests from the payment_request_responses message box.
+     *
+     * Retrieves messages and parses each as a PaymentRequestResponse.
+     *
+     * @param {string} [hostOverride] - Optional host override for the message box server.
+     * @returns {Promise<PaymentRequestResponse[]>} Resolves with an array of payment request responses.
+     */
+    listPaymentRequestResponses(hostOverride?: string): Promise<PaymentRequestResponse[]>;
+    /**
+     * Listens for incoming payment requests in real time via WebSocket.
+     *
+     * Wraps listenForLiveMessages on the payment_requests box and converts each
+     * incoming PeerMessage into an IncomingPaymentRequest before calling onRequest.
+     *
+     * @param {Object} params - Listener configuration.
+     * @param {Function} params.onRequest - Callback invoked when a new payment request arrives.
+     * @param {string} [params.overrideHost] - Optional host override for the WebSocket connection.
+     * @returns {Promise<void>} Resolves when the listener is established.
+     */
+    listenForLivePaymentRequests({ onRequest, overrideHost }: {
+        onRequest: (request: IncomingPaymentRequest) => void;
+        overrideHost?: string;
+    }): Promise<void>;
+    /**
+     * Listens for payment request responses in real time via WebSocket.
+     *
+     * Wraps listenForLiveMessages on the payment_request_responses box and converts each
+     * incoming PeerMessage into a PaymentRequestResponse before calling onResponse.
+     *
+     * @param {Object} params - Listener configuration.
+     * @param {Function} params.onResponse - Callback invoked when a new response arrives.
+     * @param {string} [params.overrideHost] - Optional host override for the WebSocket connection.
+     * @returns {Promise<void>} Resolves when the listener is established.
+     */
+    listenForLivePaymentRequestResponses({ onResponse, overrideHost }: {
+        onResponse: (response: PaymentRequestResponse) => void;
+        overrideHost?: string;
+    }): Promise<void>;
+    /**
+     * Fulfills an incoming payment request by sending the requested payment and
+     * notifying the requester with a 'paid' response in the payment_request_responses box.
+     * Also acknowledges the original request message.
+     *
+     * @param {Object} params - Fulfillment parameters.
+     * @param {IncomingPaymentRequest} params.request - The incoming payment request to fulfill.
+     * @param {string} [params.note] - Optional note to include in the response.
+     * @param {string} [hostOverride] - Optional host override for the message box server.
+     * @returns {Promise<void>} Resolves when payment is sent and acknowledgment is complete.
+     */
+    fulfillPaymentRequest(params: {
+        request: IncomingPaymentRequest;
+        note?: string;
+    }, hostOverride?: string): Promise<void>;
+    /**
+     * Declines an incoming payment request by notifying the requester with a 'declined'
+     * response in the payment_request_responses box and acknowledging the original request.
+     *
+     * @param {Object} params - Decline parameters.
+     * @param {IncomingPaymentRequest} params.request - The incoming payment request to decline.
+     * @param {string} [params.note] - Optional note explaining why the request was declined.
+     * @param {string} [hostOverride] - Optional host override for the message box server.
+     * @returns {Promise<void>} Resolves when the response is sent and request is acknowledged.
+     */
+    declinePaymentRequest(params: {
+        request: IncomingPaymentRequest;
+        note?: string;
+    }, hostOverride?: string): Promise<void>;
+    /**
+     * Sends a payment request to a recipient via the payment_requests message box.
+     *
+     * Generates a unique requestId using createNonce, looks up the caller's identity key,
+     * and sends a PaymentRequestMessage to the recipient.
+     *
+     * @param {Object} params - Payment request parameters.
+     * @param {string} params.recipient - The identity key of the intended payer.
+     * @param {number} params.amount - The amount in satoshis being requested (must be > 0).
+     * @param {string} params.description - Human-readable reason for the payment request.
+     * @param {number} params.expiresAt - Unix timestamp (ms) when the request expires.
+     * @param {string} [hostOverride] - Optional host override for the message box server.
+     * @returns {Promise<{ requestId: string }>} The generated requestId for this request.
+     * @throws {Error} If amount is <= 0.
+     */
+    requestPayment(params: {
+        recipient: string;
+        amount: number;
+        description: string;
+        expiresAt: number;
+    }, hostOverride?: string): Promise<{
+        requestId: string;
+        requestProof: string;
+    }>;
+    /**
+     * Lists all incoming payment requests from the payment_requests message box.
+     *
+     * Automatically filters out:
+     * - Expired requests (expiresAt < now), which are acknowledged and discarded.
+     * - Cancelled requests (a cancellation message with the same requestId exists),
+     *   both the original and cancellation messages are acknowledged and discarded.
+     * - Out-of-range requests (when limits are provided), which are acknowledged and discarded.
+     *
+     * @param {string} [hostOverride] - Optional host override for the message box server.
+     * @param {PaymentRequestLimits} [limits] - Optional min/max satoshi limits for filtering.
+     * @returns {Promise<IncomingPaymentRequest[]>} Resolves with active, valid payment requests.
+     */
+    listIncomingPaymentRequests(hostOverride?: string, limits?: PaymentRequestLimits): Promise<IncomingPaymentRequest[]>;
+    /**
+     * Cancels a previously sent payment request by sending a cancellation message
+     * with the same requestId and `cancelled: true`.
+     *
+     * @param {Object} params - Cancellation parameters.
+     * @param {string} params.recipient - The identity key of the recipient of the original request.
+     * @param {string} params.requestId - The requestId of the payment request to cancel.
+     * @param {string} [hostOverride] - Optional host override for the message box server.
+     * @returns {Promise<void>} Resolves when the cancellation message has been sent.
+     */
+    cancelPaymentRequest(params: {
+        recipient: string;
+        requestId: string;
+        requestProof: string;
+    }, hostOverride?: string): Promise<void>;
 }
 //# sourceMappingURL=PeerPayClient.d.ts.map

package/dist/types/src/PeerPayClient.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"PeerPayClient.d.ts","sourceRoot":"","sources":["../../../src/PeerPayClient.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAA;AAExD,OAAO,EAAE,eAAe,EAAE,UAAU,EAAa,YAAY,EAAE,uCAAuC,EAAyB,MAAM,UAAU,CAAA;AAmB/I,eAAO,MAAM,2BAA2B,kBAAkB,CAAA;AAG1D;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,YAAY,EAAE,eAAe,CAAA;IAC7B,aAAa,CAAC,EAAE,OAAO,CAAA;IACvB,UAAU,CAAC,EAAE,uCAAuC,CAAA;CACrD;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,SAAS,EAAE,MAAM,CAAA;IACjB,MAAM,EAAE,MAAM,CAAA;CACf;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,kBAAkB,EAAE;QAClB,gBAAgB,EAAE,YAAY,CAAA;QAC9B,gBAAgB,EAAE,YAAY,CAAA;KAC/B,CAAA;IACD,WAAW,EAAE,UAAU,CAAA;IACvB,MAAM,EAAE,MAAM,CAAA;IACd,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,SAAS,EAAE,MAAM,CAAA;IACjB,MAAM,EAAE,MAAM,CAAA;IACd,KAAK,EAAE,YAAY,CAAA;IACnB,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AAED;;GAEG;AACH,qBAAa,aAAc,SAAQ,gBAAgB;IACjD,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAAiB;IACrD,OAAO,CAAC,kBAAkB,CAAC,CAAW;IACtC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAQ;IACnC,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAuB;gBAE3C,MAAM,EAAE,mBAAmB;IAqBxC,OAAO,KAAK,iBAAiB,GAK5B;IAED;;;;;;;;;;;OAWG;IACG,kBAAkB,CAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,YAAY,CAAC;IA0CxE;;;;;;;;;;;;OAYG;IACG,WAAW,CAAE,OAAO,EAAE,aAAa,EAAE,YAAY,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAe/E;;;;;;;;;;;;;OAaG;IACG,eAAe,CAAE,OAAO,EAAE,aAAa,EAAE,YAAY,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAsBpF;;;;;;;;;;;OAWG;IACG,qBAAqB,CAAE,EAC3B,SAAS,EACT,YAAY,EACb,EAAE;QACD,SAAS,EAAE,CAAC,OAAO,EAAE,eAAe,KAAK,IAAI,CAAA;QAC7C,YAAY,CAAC,EAAE,MAAM,CAAA;KACtB,GAAG,OAAO,CAAC,IAAI,CAAC;IAmBjB;;;;;;;;;;OAUG;IACG,aAAa,CAAE,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,GAAG,CAAC;IA4C5D;;;;;;;;;OASG;IACG,aAAa,CAAE,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC;IAoD7D;;;;;;;;OAQG;IACG,oBAAoB,CAAE,YAAY,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,EAAE,CAAC;CAY/E"}
+{"version":3,"file":"PeerPayClient.d.ts","sourceRoot":"","sources":["../../../src/PeerPayClient.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAA;AACxD,OAAO,EAAsC,sBAAsB,EAAE,sBAAsB,EAAE,oBAAoB,EAA0E,MAAM,YAAY,CAAA;AAC7M,OAAO,EAAE,eAAe,EAAE,UAAU,EAAa,YAAY,EAAE,uCAAuC,EAAsC,MAAM,UAAU,CAAA;AAmC5J,eAAO,MAAM,2BAA2B,kBAAkB,CAAA;AAC1D,eAAO,MAAM,2BAA2B,qBAAqB,CAAA;AAC7D,eAAO,MAAM,oCAAoC,8BAA8B,CAAA;AAG/E;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,YAAY,EAAE,eAAe,CAAA;IAC7B,aAAa,CAAC,EAAE,OAAO,CAAA;IACvB,UAAU,CAAC,EAAE,uCAAuC,CAAA;CACrD;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,SAAS,EAAE,MAAM,CAAA;IACjB,MAAM,EAAE,MAAM,CAAA;CACf;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,kBAAkB,EAAE;QAClB,gBAAgB,EAAE,YAAY,CAAA;QAC9B,gBAAgB,EAAE,YAAY,CAAA;KAC/B,CAAA;IACD,WAAW,EAAE,UAAU,CAAA;IACvB,MAAM,EAAE,MAAM,CAAA;IACd,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,SAAS,EAAE,MAAM,CAAA;IACjB,MAAM,EAAE,MAAM,CAAA;IACd,KAAK,EAAE,YAAY,CAAA;IACnB,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AAED;;GAEG;AACH,qBAAa,aAAc,SAAQ,gBAAgB;IACjD,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAAiB;IACrD,OAAO,CAAC,kBAAkB,CAAC,CAAW;IACtC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAQ;IACnC,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAuB;gBAE3C,MAAM,EAAE,mBAAmB;IAqBxC,OAAO,KAAK,iBAAiB,GAK5B;IAED;;;;;;;OAOG;IACG,wBAAwB,CAAE,EAAE,WAAW,EAAE,EAAE;QAAE,WAAW,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAQxF;;;;;;;OAOG;IACG,wBAAwB,CAAE,EAAE,WAAW,EAAE,EAAE;QAAE,WAAW,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAQxF;;;;;;;;OAQG;IACG,6BAA6B,IAAK,OAAO,CAAC,KAAK,CAAC;QAAE,WAAW,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,OAAO,CAAA;KAAE,CAAC,CAAC;IAYjG;;;;;;;;;;;OAWG;IACG,kBAAkB,CAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,YAAY,CAAC;IA0CxE;;;;;;;;;;;;OAYG;IACG,WAAW,CAAE,OAAO,EAAE,aAAa,EAAE,YAAY,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAe/E;;;;;;;;;;;;;OAaG;IACG,eAAe,CAAE,OAAO,EAAE,aAAa,EAAE,YAAY,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAsBpF;;;;;;;;;;;OAWG;IACG,qBAAqB,CAAE,EAC3B,SAAS,EACT,YAAY,EACb,EAAE;QACD,SAAS,EAAE,CAAC,OAAO,EAAE,eAAe,KAAK,IAAI,CAAA;QAC7C,YAAY,CAAC,EAAE,MAAM,CAAA;KACtB,GAAG,OAAO,CAAC,IAAI,CAAC;IAqBjB;;;;;;;;;;OAUG;IACG,aAAa,CAAE,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,GAAG,CAAC;IA4C5D;;;;;;;;;OASG;IACG,aAAa,CAAE,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC;IAoD7D;;;;;;;;OAQG;IACG,oBAAoB,CAAE,YAAY,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,EAAE,CAAC;IAc9E;;;;;;;OAOG;IACG,2BAA2B,CAAE,YAAY,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,sBAAsB,EAAE,CAAC;IAM5F;;;;;;;;;;OAUG;IACG,4BAA4B,CAAE,EAClC,SAAS,EACT,YAAY,EACb,EAAE;QACD,SAAS,EAAE,CAAC,OAAO,EAAE,sBAAsB,KAAK,IAAI,CAAA;QACpD,YAAY,CAAC,EAAE,MAAM,CAAA;KACtB,GAAG,OAAO,CAAC,IAAI,CAAC;IAoBjB;;;;;;;;;;OAUG;IACG,oCAAoC,CAAE,EAC1C,UAAU,EACV,YAAY,EACb,EAAE;QACD,UAAU,EAAE,CAAC,QAAQ,EAAE,sBAAsB,KAAK,IAAI,CAAA;QACtD,YAAY,CAAC,EAAE,MAAM,CAAA;KACtB,GAAG,OAAO,CAAC,IAAI,CAAC;IAYjB;;;;;;;;;;OAUG;IACG,qBAAqB,CACzB,MAAM,EAAE;QAAE,OAAO,EAAE,sBAAsB,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,EAC1D,YAAY,CAAC,EAAE,MAAM,GACpB,OAAO,CAAC,IAAI,CAAC;IAqBhB;;;;;;;;;OASG;IACG,qBAAqB,CACzB,MAAM,EAAE;QAAE,OAAO,EAAE,sBAAsB,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,EAC1D,YAAY,CAAC,EAAE,MAAM,GACpB,OAAO,CAAC,IAAI,CAAC;IAkBhB;;;;;;;;;;;;;;OAcG;IACG,cAAc,CAClB,MAAM,EAAE;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAC;QAAC,WAAW,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAA;KAAE,EACrF,YAAY,CAAC,EAAE,MAAM,GACpB,OAAO,CAAC;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,YAAY,EAAE,MAAM,CAAA;KAAE,CAAC;IA2CvD;;;;;;;;;;;;OAYG;IACG,2BAA2B,CAC/B,YAAY,CAAC,EAAE,MAAM,EACrB,MAAM,CAAC,EAAE,oBAAoB,GAC5B,OAAO,CAAC,sBAAsB,EAAE,CAAC;IA4HpC;;;;;;;;;OASG;IACG,oBAAoB,CACxB,MAAM,EAAE;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAC;QAAC,YAAY,EAAE,MAAM,CAAA;KAAE,EACtE,YAAY,CAAC,EAAE,MAAM,GACpB,OAAO,CAAC,IAAI,CAAC;CAgBjB"}

package/dist/types/src/__tests/PeerPayClientRequestIntegration.test.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Integration tests for the PeerPayClient payment request flow.
+ *
+ * Uses a MockMessageBus to simulate the MessageBox server in memory,
+ * wiring the PeerPayClient methods (sendMessage, listMessages, acknowledgeMessage,
+ * getIdentityKey) to the mock bus so that full round-trip flows can be tested
+ * without hitting a real server.
+ */
+export {};
+//# sourceMappingURL=PeerPayClientRequestIntegration.test.d.ts.map

package/dist/types/src/__tests/PeerPayClientRequestIntegration.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PeerPayClientRequestIntegration.test.d.ts","sourceRoot":"","sources":["../../../../src/__tests/PeerPayClientRequestIntegration.test.ts"],"names":[],"mappings":"AACA;;;;;;;GAOG"}

package/dist/types/src/types.d.ts

@@ -170,4 +170,92 @@ export interface ListDevicesResponse {
     devices: RegisteredDevice[];
     description?: string;
 }
+/**
+ * Base fields shared by both payment request and cancellation messages.
+ */
+interface PaymentRequestBase {
+    /** Unique identifier for this request, generated via createNonce(). */
+    requestId: string;
+    /** Identity key of the requester, used for correlation and cancellation verification. */
+    senderIdentityKey: string;
+}
+/**
+ * A new payment request sent from requester to payer.
+ * Carried in the 'payment_requests' message box.
+ */
+export interface PaymentRequestNew extends PaymentRequestBase {
+    /** Amount in satoshis being requested. */
+    amount: number;
+    /** Human-readable reason for the request. */
+    description: string;
+    /** Unix timestamp (ms) after which the request expires. Set by the sender. */
+    expiresAt: number;
+    /** HMAC proof tying this request to the sender's identity. Used to authorize cancellations. */
+    requestProof: string;
+    /** Omitted or false for a new payment request. */
+    cancelled?: false;
+}
+/**
+ * A cancellation of a previously sent payment request.
+ * Carried in the 'payment_requests' message box.
+ */
+export interface PaymentRequestCancellation extends PaymentRequestBase {
+    /** If true, this message cancels a previously sent request with the same requestId. */
+    cancelled: true;
+    /** HMAC proof from the original request, proving cancellation authority. */
+    requestProof: string;
+}
+/**
+ * Discriminated union: either a new payment request or a cancellation.
+ * Discriminant field: `cancelled` (true = cancellation, absent/false = new request).
+ */
+export type PaymentRequestMessage = PaymentRequestNew | PaymentRequestCancellation;
+/**
+ * Represents a response to a payment request, sent from the payer back to the requester.
+ * Carried in the 'payment_request_responses' message box.
+ */
+export interface PaymentRequestResponse {
+    /** The requestId of the original PaymentRequestMessage this responds to. */
+    requestId: string;
+    /** Status of the response. */
+    status: 'paid' | 'declined';
+    /** Optional note from the payer. */
+    note?: string;
+    /** Actual amount paid in satoshis (may differ from the requested amount). */
+    amountPaid?: number;
+}
+/**
+ * Represents an incoming payment request as returned by listIncomingPaymentRequests().
+ * Combines the transport message metadata with the parsed request body.
+ * Only active (non-cancelled) requests are returned, so cancelled field is omitted.
+ */
+export interface IncomingPaymentRequest {
+    /** Transport message ID used for acknowledgment. */
+    messageId: string;
+    /** Identity key of the requester. */
+    sender: string;
+    /** Unique identifier for this request. */
+    requestId: string;
+    /** Amount in satoshis requested. */
+    amount: number;
+    /** Human-readable reason for the request. */
+    description: string;
+    /** Unix timestamp (ms) when the request expires. */
+    expiresAt: number;
+}
+/** Default minimum satoshis for payment request filtering. */
+export declare const DEFAULT_PAYMENT_REQUEST_MIN_AMOUNT = 1000;
+/** Default maximum satoshis for payment request filtering. */
+export declare const DEFAULT_PAYMENT_REQUEST_MAX_AMOUNT = 10000000;
+/**
+ * Configurable min/max amount limits for incoming payment requests.
+ * Requests outside these bounds are auto-acknowledged and discarded.
+ */
+export interface PaymentRequestLimits {
+    /** Minimum satoshis to accept in a request. Requests below this are discarded. Default: 1000. */
+    minAmount?: number;
+    /** Maximum satoshis to accept in a request. Requests above this are discarded. Default: 10000000. */
+    maxAmount?: number;
+}
+export {};
 //# sourceMappingURL=types.d.ts.map

package/dist/types/src/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,yBAAyB,EAAE,IAAI,EAAE,kBAAkB,EAAE,2BAA2B,EAAE,SAAS,EAAE,wBAAwB,EAAE,aAAa,EAAE,4BAA4B,EAAE,qBAAqB,EAAE,SAAS,EAAE,eAAe,EAAE,MAAM,UAAU,CAAA;AAE1Q;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;;OAGG;IACH,YAAY,CAAC,EAAE,eAAe,CAAA;IAE9B;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,CAAA;IAEvB;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,GAAG,SAAS,GAAG,SAAS,CAAA;IAE/C;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB;AAED;;;;;GAKG;AACH,MAAM,WAAW,WAAW;IAC1B,SAAS,EAAE,MAAM,CAAA;IACjB,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IAClC,MAAM,EAAE,MAAM,CAAA;IACd,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,MAAM,CAAA;IAClB,YAAY,CAAC,EAAE,OAAO,CAAA;CACvB;AAED;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,iBAAiB;IAChC,SAAS,EAAE,MAAM,CAAA;IACjB,UAAU,EAAE,MAAM,CAAA;IAClB,IAAI,EAAE,MAAM,GAAG,MAAM,CAAA;IACrB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB,gGAAgG;IAChG,gBAAgB,CAAC,EAAE,OAAO,CAAA;CAC3B;AAED;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAClC,MAAM,EAAE,MAAM,CAAA;IACd,SAAS,EAAE,MAAM,CAAA;CAClB;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,wBAAwB;IACvC,UAAU,EAAE,MAAM,EAAE,CAAA;IACpB,IAAI,CAAC,EAAE,MAAM,CAAA;CACd;AAED;;;;;GAKG;AACH,MAAM,WAAW,kBAAkB;IACjC,UAAU,EAAE,MAAM,CAAA;IAClB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,cAAc,CAAC,EAAE,OAAO,CAAA;CACzB;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAC/B,gBAAgB,EAAE,YAAY,CAAA;CAC/B;AAED,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,SAAS,CAAA;IACf,WAAW,EAAE,MAAM,CAAA;IACnB,aAAa,EAAE,aAAa,CAAA;IAC5B,IAAI,EAAE,IAAI,CAAA;CACX;AAED,MAAM,WAAW,OAAO;IACtB,EAAE,EAAE,UAAU,CAAA;IACd,OAAO,EAAE,KAAK,CAAC;QACb,WAAW,EAAE,qBAAqB,CAAA;QAClC,QAAQ,EAAE,gBAAgB,GAAG,kBAAkB,CAAA;QAC/C,iBAAiB,CAAC,EAAE;YAClB,gBAAgB,EAAE,YAAY,CAAA;YAC9B,gBAAgB,EAAE,YAAY,CAAA;YAC9B,iBAAiB,EAAE,SAAS,CAAA;SAC7B,CAAA;QACD,mBAAmB,CAAC,EAAE;YACpB,MAAM,EAAE,yBAAyB,CAAA;YACjC,kBAAkB,CAAC,EAAE,MAAM,CAAA;YAC3B,IAAI,CAAC,EAAE,4BAA4B,EAAE,CAAA;SACtC,CAAA;KACF,CAAC,CAAA;IACF,WAAW,EAAE,2BAA2B,CAAA;IACxC,MAAM,CAAC,EAAE,wBAAwB,EAAE,CAAA;IACnC,cAAc,CAAC,EAAE,kBAAkB,CAAA;CACpC;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,kCAAkC;IAClC,QAAQ,EAAE,MAAM,CAAA;IAChB,iCAAiC;IACjC,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,6BAA6B;IAC7B,QAAQ,CAAC,EAAE,KAAK,GAAG,SAAS,GAAG,KAAK,CAAA;CACrC;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC,MAAM,EAAE,MAAM,CAAA;IACd,OAAO,EAAE,MAAM,CAAA;IACf,QAAQ,EAAE,MAAM,CAAA;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,EAAE,EAAE,MAAM,CAAA;IACV,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,QAAQ,EAAE,MAAM,CAAA;IAChB,MAAM,EAAE,OAAO,CAAA;IACf,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,QAAQ,EAAE,MAAM,CAAA;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,MAAM,EAAE,MAAM,CAAA;IACd,OAAO,EAAE,gBAAgB,EAAE,CAAA;IAC3B,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,yBAAyB,EAAE,IAAI,EAAE,kBAAkB,EAAE,2BAA2B,EAAE,SAAS,EAAE,wBAAwB,EAAE,aAAa,EAAE,4BAA4B,EAAE,qBAAqB,EAAE,SAAS,EAAE,eAAe,EAAE,MAAM,UAAU,CAAA;AAE1Q;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;;OAGG;IACH,YAAY,CAAC,EAAE,eAAe,CAAA;IAE9B;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,CAAA;IAEvB;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,GAAG,SAAS,GAAG,SAAS,CAAA;IAE/C;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB;AAED;;;;;GAKG;AACH,MAAM,WAAW,WAAW;IAC1B,SAAS,EAAE,MAAM,CAAA;IACjB,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IAClC,MAAM,EAAE,MAAM,CAAA;IACd,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,MAAM,CAAA;IAClB,YAAY,CAAC,EAAE,OAAO,CAAA;CACvB;AAED;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,iBAAiB;IAChC,SAAS,EAAE,MAAM,CAAA;IACjB,UAAU,EAAE,MAAM,CAAA;IAClB,IAAI,EAAE,MAAM,GAAG,MAAM,CAAA;IACrB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB,gGAAgG;IAChG,gBAAgB,CAAC,EAAE,OAAO,CAAA;CAC3B;AAED;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAClC,MAAM,EAAE,MAAM,CAAA;IACd,SAAS,EAAE,MAAM,CAAA;CAClB;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,wBAAwB;IACvC,UAAU,EAAE,MAAM,EAAE,CAAA;IACpB,IAAI,CAAC,EAAE,MAAM,CAAA;CACd;AAED;;;;;GAKG;AACH,MAAM,WAAW,kBAAkB;IACjC,UAAU,EAAE,MAAM,CAAA;IAClB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,cAAc,CAAC,EAAE,OAAO,CAAA;CACzB;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAC/B,gBAAgB,EAAE,YAAY,CAAA;CAC/B;AAED,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,SAAS,CAAA;IACf,WAAW,EAAE,MAAM,CAAA;IACnB,aAAa,EAAE,aAAa,CAAA;IAC5B,IAAI,EAAE,IAAI,CAAA;CACX;AAED,MAAM,WAAW,OAAO;IACtB,EAAE,EAAE,UAAU,CAAA;IACd,OAAO,EAAE,KAAK,CAAC;QACb,WAAW,EAAE,qBAAqB,CAAA;QAClC,QAAQ,EAAE,gBAAgB,GAAG,kBAAkB,CAAA;QAC/C,iBAAiB,CAAC,EAAE;YAClB,gBAAgB,EAAE,YAAY,CAAA;YAC9B,gBAAgB,EAAE,YAAY,CAAA;YAC9B,iBAAiB,EAAE,SAAS,CAAA;SAC7B,CAAA;QACD,mBAAmB,CAAC,EAAE;YACpB,MAAM,EAAE,yBAAyB,CAAA;YACjC,kBAAkB,CAAC,EAAE,MAAM,CAAA;YAC3B,IAAI,CAAC,EAAE,4BAA4B,EAAE,CAAA;SACtC,CAAA;KACF,CAAC,CAAA;IACF,WAAW,EAAE,2BAA2B,CAAA;IACxC,MAAM,CAAC,EAAE,wBAAwB,EAAE,CAAA;IACnC,cAAc,CAAC,EAAE,kBAAkB,CAAA;CACpC;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,kCAAkC;IAClC,QAAQ,EAAE,MAAM,CAAA;IAChB,iCAAiC;IACjC,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,6BAA6B;IAC7B,QAAQ,CAAC,EAAE,KAAK,GAAG,SAAS,GAAG,KAAK,CAAA;CACrC;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC,MAAM,EAAE,MAAM,CAAA;IACd,OAAO,EAAE,MAAM,CAAA;IACf,QAAQ,EAAE,MAAM,CAAA;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,EAAE,EAAE,MAAM,CAAA;IACV,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,QAAQ,EAAE,MAAM,CAAA;IAChB,MAAM,EAAE,OAAO,CAAA;IACf,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;IACjB,QAAQ,EAAE,MAAM,CAAA;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,MAAM,EAAE,MAAM,CAAA;IACd,OAAO,EAAE,gBAAgB,EAAE,CAAA;IAC3B,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AAED;;GAEG;AACH,UAAU,kBAAkB;IAC1B,uEAAuE;IACvE,SAAS,EAAE,MAAM,CAAA;IACjB,yFAAyF;IACzF,iBAAiB,EAAE,MAAM,CAAA;CAC1B;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAkB,SAAQ,kBAAkB;IAC3D,0CAA0C;IAC1C,MAAM,EAAE,MAAM,CAAA;IACd,6CAA6C;IAC7C,WAAW,EAAE,MAAM,CAAA;IACnB,8EAA8E;IAC9E,SAAS,EAAE,MAAM,CAAA;IACjB,+FAA+F;IAC/F,YAAY,EAAE,MAAM,CAAA;IACpB,kDAAkD;IAClD,SAAS,CAAC,EAAE,KAAK,CAAA;CAClB;AAED;;;GAGG;AACH,MAAM,WAAW,0BAA2B,SAAQ,kBAAkB;IACpE,uFAAuF;IACvF,SAAS,EAAE,IAAI,CAAA;IACf,4EAA4E;IAC5E,YAAY,EAAE,MAAM,CAAA;CACrB;AAED;;;GAGG;AACH,MAAM,MAAM,qBAAqB,GAAG,iBAAiB,GAAG,0BAA0B,CAAA;AAElF;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC,4EAA4E;IAC5E,SAAS,EAAE,MAAM,CAAA;IACjB,8BAA8B;IAC9B,MAAM,EAAE,MAAM,GAAG,UAAU,CAAA;IAC3B,oCAAoC;IACpC,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,6EAA6E;IAC7E,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB;AAED;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACrC,oDAAoD;IACpD,SAAS,EAAE,MAAM,CAAA;IACjB,qCAAqC;IACrC,MAAM,EAAE,MAAM,CAAA;IACd,0CAA0C;IAC1C,SAAS,EAAE,MAAM,CAAA;IACjB,oCAAoC;IACpC,MAAM,EAAE,MAAM,CAAA;IACd,6CAA6C;IAC7C,WAAW,EAAE,MAAM,CAAA;IACnB,oDAAoD;IACpD,SAAS,EAAE,MAAM,CAAA;CAClB;AAED,8DAA8D;AAC9D,eAAO,MAAM,kCAAkC,OAAO,CAAA;AACtD,8DAA8D;AAC9D,eAAO,MAAM,kCAAkC,WAAa,CAAA;AAE5D;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,iGAAiG;IACjG,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,qGAAqG;IACrG,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB"}