@branta-ops/branta 0.0.3 → 0.0.5

package/README.md

@@ -72,7 +72,7 @@ await client.addPayment({
 
  - [X] Per Environment configuration
  - [X] V2 Get Payment by address
- - [ ] V2 Get Payment by QR Code
+ - [X] V2 Get Payment by QR Code
  - [X] V2 Get decrypted Zero Knowledge by address and secret
  - [X] V2 Add Payment
  - [X] V2 Payment by Parent Platform with HMAC

package/dist/v2/client.d.ts

@@ -8,6 +8,7 @@ export interface Payment {
     ttl?: number;
     description?: string;
     metadata?: Record<string, string>;
+    verify_url?: string;
 }
 interface PaymentResponse extends Payment {
     createdAt: Date;
@@ -28,7 +29,11 @@ export declare class V2BrantaClient {
     getZKPayment(address: string, secret: string, options?: BrantaClientOptions | null): Promise<Payment[]>;
     addPayment(payment: Payment, options?: BrantaClientOptions | null): Promise<PaymentResult>;
     addZKPayment(payment: Payment, options?: BrantaClientOptions | null): Promise<ZKPaymentResult>;
+    getPaymentsByQRCode(qrText: string, options?: BrantaClientOptions | null): Promise<Payment[]>;
     isApiKeyValid(options?: BrantaClientOptions | null): Promise<boolean>;
+    private _buildVerifyUrl;
+    private _resolveBaseUrl;
+    private _normalizeAddress;
     private _createClient;
     private _setApiKey;
     private _setHmacHeaders;

package/dist/v2/client.js

@@ -11,6 +11,10 @@ export class V2BrantaClient {
             return [];
         }
         const data = await response.json();
+        const baseUrl = this._resolveBaseUrl(options);
+        for (const payment of data) {
+            payment.verify_url = this._buildVerifyUrl(baseUrl, address);
+        }
         return data;
     }
     async getZKPayment(address, secret, options = null) {
@@ -22,6 +26,10 @@ export class V2BrantaClient {
                 destination.value = await AesEncryption.decrypt(destination.value, secret);
             }
         }
+        const baseUrl = this._resolveBaseUrl(options);
+        for (const payment of payments) {
+            payment.verify_url = this._buildVerifyUrl(baseUrl, address, secret);
+        }
         return payments;
     }
     async addPayment(payment, options = null) {
@@ -34,6 +42,7 @@ export class V2BrantaClient {
         }
         const responseBody = await response.text();
         const paymentResponse = JSON.parse(responseBody);
+        paymentResponse.verify_url = this._buildVerifyUrl(httpClient.baseURL, payment.destinations[0].value);
         const verifyLink = httpClient.baseURL + "/v2/verify/" + encodeURIComponent(payment.destinations[0].value);
         return { payment: paymentResponse, verifyLink };
     }
@@ -47,14 +56,75 @@ export class V2BrantaClient {
         const responsePayment = (await this.addPayment(payment, options));
         responsePayment.secret = secret;
         responsePayment.verifyLink = responsePayment.verifyLink.replace('verify', 'zk-verify') + "#secret=" + secret;
+        responsePayment.payment.verify_url = this._buildVerifyUrl(this._resolveBaseUrl(options), payment.destinations[0].value, secret);
         return responsePayment;
     }
+    async getPaymentsByQRCode(qrText, options = null) {
+        const text = qrText.trim();
+        let url = null;
+        try {
+            url = new URL(text);
+        }
+        catch { /* not a URL */ }
+        if (url) {
+            const brantaId = url.searchParams.get('branta_id');
+            const brantaSecret = url.searchParams.get('branta_secret');
+            if (brantaId && brantaSecret) {
+                return this.getZKPayment(brantaId, brantaSecret, options);
+            }
+            if (url.protocol === 'http:' || url.protocol === 'https:') {
+                const baseUrl = this._resolveBaseUrl(options);
+                if (baseUrl && new URL(baseUrl).origin === url.origin) {
+                    const segments = url.pathname.split('/').filter(Boolean);
+                    const [version, type, id] = segments;
+                    if (version === 'v2' && id) {
+                        if (type === 'verify')
+                            return this.getPayments(id, options);
+                        if (type === 'zk-verify') {
+                            const secret = new URLSearchParams(url.hash.slice(1)).get('secret');
+                            return secret
+                                ? this.getZKPayment(id, secret, options)
+                                : this.getPayments(id, options);
+                        }
+                    }
+                    const lastSegment = segments.at(-1);
+                    if (lastSegment)
+                        return this.getPayments(lastSegment, options);
+                }
+            }
+        }
+        return this.getPayments(this._normalizeAddress(text), options);
+    }
     async isApiKeyValid(options = null) {
         const httpClient = this._createClient(options);
         this._setApiKey(httpClient, options);
         const response = await httpClient.get("/v2/api-keys/health-check");
         return response.ok;
     }
+    _buildVerifyUrl(baseUrl, address, secret) {
+        const encoded = encodeURIComponent(address);
+        if (secret) {
+            return `${baseUrl}/v2/zk-verify/${encoded}#secret=${secret}`;
+        }
+        return `${baseUrl}/v2/verify/${encoded}`;
+    }
+    _resolveBaseUrl(options) {
+        const baseUrl = options?.baseUrl ?? this._defaultOptions?.baseUrl;
+        return typeof baseUrl === 'string' ? baseUrl : baseUrl?.url ?? '';
+    }
+    _normalizeAddress(text) {
+        const lower = text.toLowerCase();
+        if (lower.startsWith('lightning:'))
+            return lower.slice('lightning:'.length);
+        if (lower.startsWith('bitcoin:')) {
+            const addr = text.slice('bitcoin:'.length);
+            const addrLower = addr.toLowerCase();
+            return addrLower.startsWith('bc1q') || addrLower.startsWith('bcrt') ? addrLower : addr;
+        }
+        if (lower.startsWith('lnbc') || lower.startsWith('bc1q'))
+            return lower;
+        return text;
+    }
     _createClient(options) {
         const baseUrl = options?.baseUrl ?? this._defaultOptions?.baseUrl;
         const timeout = options?.timeout ?? this._defaultOptions?.timeout ?? 10000;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@branta-ops/branta",
-  "version": "0.0.3",
+  "version": "0.0.5",
   "description": "A JavaScript SDK for the Branta API",
   "homepage": "https://github.com/BrantaOps/branta-js#readme",
   "bugs": {