@unicitylabs/nostr-js-sdk 0.2.0 → 0.2.2

package/README.md

@@ -177,21 +177,34 @@ client.unsubscribe(subId);
 ### Token Transfers
 
 ```typescript
-import { TokenTransferProtocol } from '@unicitylabs/nostr-sdk';
+import { NostrClient, TokenTransferProtocol } from '@unicitylabs/nostr-sdk';
 
-// Create token transfer event
-const event = await TokenTransferProtocol.createTokenTransferEvent(
-  keyManager,
-  recipientPubkey,
-  JSON.stringify({ tokenId: '...', amount: 100 }),
-  100n,  // amount (optional metadata)
-  'UNIT' // symbol (optional metadata)
-);
+// Simple token transfer using NostrClient
+const eventId = await client.sendTokenTransfer(recipientPubkey, tokenJson);
 
-await client.publishEvent(event);
+// Token transfer with metadata
+const eventId = await client.sendTokenTransfer(recipientPubkey, tokenJson, {
+  amount: 100n,
+  symbol: 'UNIT'
+});
+
+// Token transfer in response to a payment request (with correlation)
+const paymentRequestEventId = '...'; // Event ID of the original payment request
+const eventId = await client.sendTokenTransfer(recipientPubkey, tokenJson, {
+  amount: 100n,
+  symbol: 'UNIT',
+  replyToEventId: paymentRequestEventId  // Links transfer to the payment request
+});
 
 // Parse received token transfer
 const tokenJson = await TokenTransferProtocol.parseTokenTransfer(event, keyManager);
+
+// Get reply-to event ID (for payment request correlation)
+const replyToId = TokenTransferProtocol.getReplyToEventId(event);
+if (replyToId) {
+  // This transfer is in response to a payment request
+  const originalRequest = pendingRequests.get(replyToId);
+}
 ```
 
 ### Payment Requests
@@ -286,6 +299,7 @@ Token transfers use Nostr event kind 31113 with NIP-04 encryption.
 | `type` | Yes | Always `"token_transfer"` |
 | `amount` | No | Transfer amount (metadata for filtering) |
 | `symbol` | No | Token symbol (metadata for filtering) |
+| `e` | No | Reply-to event ID (for payment request correlation) |
 
 ### Encrypted Content
 
@@ -310,10 +324,11 @@ gz:<base64_ciphertext>?iv=<base64_iv>
 TokenTransferProtocol.isTokenTransfer(event); // boolean
 
 // Get metadata from tags
-TokenTransferProtocol.getAmount(event);    // bigint | undefined
-TokenTransferProtocol.getSymbol(event);    // string | undefined
-TokenTransferProtocol.getRecipient(event); // string | undefined
-TokenTransferProtocol.getSender(event);    // string
+TokenTransferProtocol.getAmount(event);         // bigint | undefined
+TokenTransferProtocol.getSymbol(event);         // string | undefined
+TokenTransferProtocol.getRecipient(event);      // string | undefined
+TokenTransferProtocol.getSender(event);         // string
+TokenTransferProtocol.getReplyToEventId(event); // string | undefined (payment request correlation)
 ```
 
 ## Payment Request Format
@@ -477,13 +492,13 @@ To test payment requests against a real wallet:
 
 ```bash
 # Send a single payment request
-TARGET_NAMETAG=mp-6 npm test -- --testNamePattern="send single payment request"
+TARGET_NAMETAG=mp-9 npm test -- --testNamePattern="send single payment request"
 
 # Send multiple payment requests (for UI testing)
-TARGET_NAMETAG=mp-6 npm test -- --testNamePattern="send multiple payment requests"
+TARGET_NAMETAG=mp-9 npm test -- --testNamePattern="send multiple payment requests"
 
 # Full flow with token transfer verification (requires wallet interaction)
-TARGET_NAMETAG=mp-6 npm test -- --testNamePattern="full payment request flow"
+TARGET_NAMETAG=mp-9 npm test -- --testNamePattern="full payment request flow"
 ```
 
 Environment variables:

package/dist/browser/index.js

@@ -6354,11 +6354,12 @@ class NostrClient {
      * Send a token transfer (encrypted).
      * @param recipientPubkeyHex Recipient's public key (hex)
      * @param tokenJson Token JSON string
+     * @param options Optional parameters (amount, symbol, replyToEventId)
      * @returns Promise that resolves with the event ID
      */
-    async sendTokenTransfer(recipientPubkeyHex, tokenJson) {
+    async sendTokenTransfer(recipientPubkeyHex, tokenJson, options) {
         const TokenTransferProtocol$1 = await Promise.resolve().then(function () { return TokenTransferProtocol; });
-        const event = await TokenTransferProtocol$1.createTokenTransferEvent(this.keyManager, recipientPubkeyHex, tokenJson);
+        const event = await TokenTransferProtocol$1.createTokenTransferEvent(this.keyManager, recipientPubkeyHex, tokenJson, options);
         return this.publishEvent(event);
     }
     /**
@@ -9824,16 +9825,32 @@ const MESSAGE_PREFIX$1 = 'token_transfer:';
  *   - ["type", "token_transfer"] - Event type
  *   - ["amount", "<amount>"] - Optional amount
  *   - ["symbol", "<symbol>"] - Optional token symbol
+ *   - ["e", "<event_id>", "", "reply"] - Optional reply-to event (for payment request correlation)
  * - Content: NIP-04 encrypted "token_transfer:{tokenJson}"
  *
  * @param keyManager Key manager with signing keys
  * @param recipientPubkeyHex Recipient's public key (hex)
  * @param tokenJson Token JSON string
- * @param amount Optional amount for metadata
- * @param symbol Optional token symbol for metadata
+ * @param amountOrOptions Optional amount for metadata, or options object
+ * @param symbol Optional token symbol for metadata (ignored if options object used)
  * @returns Signed event
  */
-async function createTokenTransferEvent(keyManager, recipientPubkeyHex, tokenJson, amount, symbol) {
+async function createTokenTransferEvent(keyManager, recipientPubkeyHex, tokenJson, amountOrOptions, symbol) {
+    // Parse options (support both old and new signatures)
+    let amount;
+    let tokenSymbol;
+    let replyToEventId;
+    if (amountOrOptions !== undefined && typeof amountOrOptions === 'object') {
+        // New options object signature
+        amount = amountOrOptions.amount;
+        tokenSymbol = amountOrOptions.symbol;
+        replyToEventId = amountOrOptions.replyToEventId;
+    }
+    else {
+        // Old positional arguments signature
+        amount = amountOrOptions;
+        tokenSymbol = symbol;
+    }
     // Encrypt the token data
     const message = MESSAGE_PREFIX$1 + tokenJson;
     const encryptedContent = await keyManager.encryptHex(message, recipientPubkeyHex);
@@ -9845,8 +9862,12 @@ async function createTokenTransferEvent(keyManager, recipientPubkeyHex, tokenJso
     if (amount !== undefined) {
         tags.push(['amount', String(amount)]);
     }
-    if (symbol !== undefined) {
-        tags.push(['symbol', symbol]);
+    if (tokenSymbol !== undefined) {
+        tags.push(['symbol', tokenSymbol]);
+    }
+    // Add optional reply-to event reference (for payment request correlation)
+    if (replyToEventId !== undefined && replyToEventId.length > 0) {
+        tags.push(['e', replyToEventId, '', 'reply']);
     }
     const event = Event.create(keyManager, {
         kind: TOKEN_TRANSFER,
@@ -9934,6 +9955,15 @@ function getAmount$1(event) {
 function getSymbol(event) {
     return event.getTagValue('symbol');
 }
+/**
+ * Get the reply-to event ID from a token transfer event.
+ * Used to correlate token transfers with payment requests.
+ * @param event Token transfer event
+ * @returns Referenced event ID, or undefined if not present
+ */
+function getReplyToEventId(event) {
+    return event.getTagValue('e');
+}
 /**
  * Check if an event is a token transfer.
  * @param event Event to check
@@ -9965,6 +9995,7 @@ var TokenTransferProtocol = /*#__PURE__*/Object.freeze({
     createTokenTransferEvent: createTokenTransferEvent,
     getAmount: getAmount$1,
     getRecipient: getRecipient,
+    getReplyToEventId: getReplyToEventId,
     getSender: getSender$1,
     getSymbol: getSymbol,
     isTokenTransfer: isTokenTransfer,