nostr-core 0.6.0 → 0.8.0

package/README.md

@@ -1,9 +1,20 @@
-# nostr-core
+# nostr-core - Dead-simple & vendor-neutral
 
-Dead-simple, vendor-neutral [Nostr Wallet Connect (NWC)](https://github.com/nostr-protocol/nips/blob/master/47.md) client for JavaScript and TypeScript.
+**nostr-core** is a comprehensive JavaScript/TypeScript toolkit for building engaging [Nostr](https://nostr.com) applications. With support for 36+ NIPs out of the box, it covers everything from core protocol primitives to advanced social, payments, and identity features — giving you a single, well-typed foundation to build on.
 
-[Demo](https://nostr-core-demo.netlify.app/)
+**Why nostr-core?**
 
+* 📡 Protocol Complete - 36+ NIPs implemented and ready to use, from basics to cutting-edge
+* ⚡ NWC & Lightning - First-class Nostr Wallet Connect support for seamless payment flows
+* 🔐 Identity & Auth - Key management, NIP-07 browser signing, and bunker/remote signer support
+* 🎯 Relay Management - Smart relay abstraction with connection pooling and event routing
+* 🛠️ TypeScript Native - Fully typed, modern APIs designed for developer confidence
+* 🧩 Composable - Headless and framework-agnostic; drop it into any stack
+* 📦 Modular - Use only what you need, scale as your app grows
+
+**Built for builders who want to ship**, not fight the protocol. [Demo](https://nostr-core-demo.netlify.app/)
+
+ [Nostr Wallet Connect (NWC)](https://github.com/nostr-protocol/nips/blob/master/47.md) 
 ```ts
 import { NWC } from 'nostr-core'
 

package/dist/blossom.d.ts

@@ -0,0 +1,122 @@
+import { type NostrEvent, type EventTemplate } from './event.js';
+/** BUD-03: User server list (replaceable) */
+export declare const SERVER_LIST_KIND = 10063;
+/** BUD-11: Authorization token */
+export declare const AUTH_KIND = 24242;
+/** Blob metadata returned by Blossom servers. */
+export type BlobDescriptor = {
+    url: string;
+    sha256: string;
+    size: number;
+    type?: string;
+    uploaded?: number;
+};
+/** Authorization action types for kind 24242. */
+export type BlossomAuthAction = 'get' | 'upload' | 'list' | 'delete' | 'media';
+export declare class BlossomError extends Error {
+    code: string;
+    status?: number;
+    constructor(message: string, code?: string, status?: number);
+}
+/**
+ * Create a kind 10063 server list event template (unsigned).
+ *
+ * Declares which Blossom servers a user prefers for media storage.
+ */
+export declare function createServerListEventTemplate(servers: string[]): EventTemplate;
+/**
+ * Create and sign a kind 10063 server list event.
+ */
+export declare function createServerListEvent(servers: string[], secretKey: Uint8Array): NostrEvent;
+/**
+ * Parse a kind 10063 server list event.
+ */
+export declare function parseServerList(event: NostrEvent): string[];
+/**
+ * Create a kind 24242 Blossom authorization event template (unsigned).
+ *
+ * @param opts.action - Operation type: get, upload, list, delete, media
+ * @param opts.content - Human-readable description (e.g. "Upload Blob")
+ * @param opts.expiration - Unix timestamp when the token expires
+ * @param opts.hashes - SHA-256 hashes to scope the token to (x tags)
+ * @param opts.size - Blob size in bytes
+ * @param opts.servers - Server URLs to restrict the token to
+ */
+export declare function createAuthEventTemplate(opts: {
+    action: BlossomAuthAction;
+    content: string;
+    expiration: number;
+    hashes?: string[];
+    size?: number;
+    servers?: string[];
+}): EventTemplate;
+/**
+ * Create and sign a kind 24242 Blossom authorization event.
+ */
+export declare function createAuthEvent(opts: Parameters<typeof createAuthEventTemplate>[0], secretKey: Uint8Array): NostrEvent;
+/**
+ * Encode a signed kind 24242 event as a Blossom Authorization header value.
+ *
+ * Format: `Nostr <base64url-no-pad-encoded-event>`
+ */
+export declare function getAuthorizationHeader(event: NostrEvent): string;
+/**
+ * Upload a blob to a Blossom server (BUD-02).
+ *
+ * @param serverUrl - Blossom server base URL
+ * @param data - Binary data to upload
+ * @param authEvent - Signed kind 24242 auth event with action "upload"
+ * @param contentType - MIME type (default: application/octet-stream)
+ * @returns Blob descriptor from the server
+ */
+export declare function uploadBlob(serverUrl: string, data: Uint8Array, authEvent: NostrEvent, contentType?: string): Promise<BlobDescriptor>;
+/**
+ * Retrieve a blob from a Blossom server (BUD-01).
+ *
+ * @param serverUrl - Blossom server base URL
+ * @param sha256Hash - SHA-256 hash of the blob (hex)
+ * @param ext - Optional file extension (e.g. ".png")
+ * @returns The raw blob data
+ */
+export declare function getBlob(serverUrl: string, sha256Hash: string, ext?: string): Promise<ArrayBuffer>;
+/**
+ * Check if a blob exists on a Blossom server (BUD-01).
+ */
+export declare function checkBlob(serverUrl: string, sha256Hash: string): Promise<boolean>;
+/**
+ * Delete a blob from a Blossom server (BUD-02).
+ *
+ * @param serverUrl - Blossom server base URL
+ * @param sha256Hash - SHA-256 hash of the blob to delete (hex)
+ * @param authEvent - Signed kind 24242 auth event with action "delete"
+ */
+export declare function deleteBlob(serverUrl: string, sha256Hash: string, authEvent: NostrEvent): Promise<void>;
+/**
+ * List blobs uploaded by a pubkey (BUD-02).
+ *
+ * @param serverUrl - Blossom server base URL
+ * @param pubkey - Hex public key
+ * @param opts.cursor - SHA-256 hash of last blob for pagination
+ * @param opts.limit - Maximum number of results
+ * @returns Array of blob descriptors sorted by upload date descending
+ */
+export declare function listBlobs(serverUrl: string, pubkey: string, opts?: {
+    cursor?: string;
+    limit?: number;
+}): Promise<BlobDescriptor[]>;
+/**
+ * Mirror a blob from a remote URL to a Blossom server (BUD-04).
+ *
+ * @param serverUrl - Destination Blossom server base URL
+ * @param sourceUrl - Public URL of the blob to mirror
+ * @param authEvent - Signed kind 24242 auth event with action "upload"
+ * @returns Blob descriptor from the destination server
+ */
+export declare function mirrorBlob(serverUrl: string, sourceUrl: string, authEvent: NostrEvent): Promise<BlobDescriptor>;
+/**
+ * Compute the SHA-256 hash of a blob (hex).
+ *
+ * This is the content-addressable identifier used by Blossom servers.
+ */
+export declare function getBlobHash(data: Uint8Array): string;
+//# sourceMappingURL=blossom.d.ts.map

package/dist/blossom.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"blossom.d.ts","sourceRoot":"","sources":["../src/blossom.ts"],"names":[],"mappings":"AAEA,OAAO,EAAiB,KAAK,UAAU,EAAE,KAAK,aAAa,EAAE,MAAM,YAAY,CAAA;AAI/E,6CAA6C;AAC7C,eAAO,MAAM,gBAAgB,QAAQ,CAAA;AAErC,kCAAkC;AAClC,eAAO,MAAM,SAAS,QAAQ,CAAA;AAI9B,iDAAiD;AACjD,MAAM,MAAM,cAAc,GAAG;IAC3B,GAAG,EAAE,MAAM,CAAA;IACX,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB,CAAA;AAED,iDAAiD;AACjD,MAAM,MAAM,iBAAiB,GAAG,KAAK,GAAG,QAAQ,GAAG,MAAM,GAAG,QAAQ,GAAG,OAAO,CAAA;AAE9E,qBAAa,YAAa,SAAQ,KAAK;IACrC,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,CAAC,EAAE,MAAM,CAAA;gBACH,OAAO,EAAE,MAAM,EAAE,IAAI,SAAkB,EAAE,MAAM,CAAC,EAAE,MAAM;CAMrE;AAID;;;;GAIG;AACH,wBAAgB,6BAA6B,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,aAAa,CAO9E;AAED;;GAEG;AACH,wBAAgB,qBAAqB,CACnC,OAAO,EAAE,MAAM,EAAE,EACjB,SAAS,EAAE,UAAU,GACpB,UAAU,CAEZ;AAED;;GAEG;AACH,wBAAgB,eAAe,CAAC,KAAK,EAAE,UAAU,GAAG,MAAM,EAAE,CAO3D;AAID;;;;;;;;;GASG;AACH,wBAAgB,uBAAuB,CAAC,IAAI,EAAE;IAC5C,MAAM,EAAE,iBAAiB,CAAA;IACzB,OAAO,EAAE,MAAM,CAAA;IACf,UAAU,EAAE,MAAM,CAAA;IAClB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;IACjB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,OAAO,CAAC,EAAE,MAAM,EAAE,CAAA;CACnB,GAAG,aAAa,CA0BhB;AAED;;GAEG;AACH,wBAAgB,eAAe,CAC7B,IAAI,EAAE,UAAU,CAAC,OAAO,uBAAuB,CAAC,CAAC,CAAC,CAAC,EACnD,SAAS,EAAE,UAAU,GACpB,UAAU,CAEZ;AAID;;;;GAIG;AACH,wBAAgB,sBAAsB,CAAC,KAAK,EAAE,UAAU,GAAG,MAAM,CAIhE;AAQD;;;;;;;;GAQG;AACH,wBAAsB,UAAU,CAC9B,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,UAAU,EAChB,SAAS,EAAE,UAAU,EACrB,WAAW,CAAC,EAAE,MAAM,GACnB,OAAO,CAAC,cAAc,CAAC,CAgBzB;AAED;;;;;;;GAOG;AACH,wBAAsB,OAAO,CAC3B,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,MAAM,EAClB,GAAG,CAAC,EAAE,MAAM,GACX,OAAO,CAAC,WAAW,CAAC,CAWtB;AAED;;GAEG;AACH,wBAAsB,SAAS,CAC7B,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,MAAM,GACjB,OAAO,CAAC,OAAO,CAAC,CAOlB;AAED;;;;;;GAMG;AACH,wBAAsB,UAAU,CAC9B,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,MAAM,EAClB,SAAS,EAAE,UAAU,GACpB,OAAO,CAAC,IAAI,CAAC,CASf;AAED;;;;;;;;GAQG;AACH,wBAAsB,SAAS,CAC7B,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,MAAM,EACd,IAAI,CAAC,EAAE;IAAE,MAAM,CAAC,EAAE,MAAM,CAAC;IAAC,KAAK,CAAC,EAAE,MAAM,CAAA;CAAE,GACzC,OAAO,CAAC,cAAc,EAAE,CAAC,CAgB3B;AAED;;;;;;;GAOG;AACH,wBAAsB,UAAU,CAC9B,SAAS,EAAE,MAAM,EACjB,SAAS,EAAE,MAAM,EACjB,SAAS,EAAE,UAAU,GACpB,OAAO,CAAC,cAAc,CAAC,CAczB;AAID;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,IAAI,EAAE,UAAU,GAAG,MAAM,CAEpD"}

package/dist/blossom.js

@@ -0,0 +1,237 @@
+import { sha256 } from '@noble/hashes/sha2';
+import { bytesToHex } from '@noble/hashes/utils';
+import { finalizeEvent } from './event.js';
+// ── Event Kinds ────────────────────────────────────────────────────────
+/** BUD-03: User server list (replaceable) */
+export const SERVER_LIST_KIND = 10063;
+/** BUD-11: Authorization token */
+export const AUTH_KIND = 24242;
+export class BlossomError extends Error {
+    code;
+    status;
+    constructor(message, code = 'BLOSSOM_ERROR', status) {
+        super(message);
+        this.name = 'BlossomError';
+        this.code = code;
+        this.status = status;
+    }
+}
+// ── Server List (kind 10063 / BUD-03) ──────────────────────────────────
+/**
+ * Create a kind 10063 server list event template (unsigned).
+ *
+ * Declares which Blossom servers a user prefers for media storage.
+ */
+export function createServerListEventTemplate(servers) {
+    return {
+        kind: SERVER_LIST_KIND,
+        created_at: Math.floor(Date.now() / 1000),
+        tags: servers.map(s => ['server', s]),
+        content: '',
+    };
+}
+/**
+ * Create and sign a kind 10063 server list event.
+ */
+export function createServerListEvent(servers, secretKey) {
+    return finalizeEvent(createServerListEventTemplate(servers), secretKey);
+}
+/**
+ * Parse a kind 10063 server list event.
+ */
+export function parseServerList(event) {
+    if (event.kind !== SERVER_LIST_KIND) {
+        throw new Error(`Expected kind ${SERVER_LIST_KIND}, got ${event.kind}`);
+    }
+    return event.tags
+        .filter(t => t[0] === 'server' && t[1])
+        .map(t => t[1]);
+}
+// ── Authorization Event (kind 24242 / BUD-11) ─────────────────────────
+/**
+ * Create a kind 24242 Blossom authorization event template (unsigned).
+ *
+ * @param opts.action - Operation type: get, upload, list, delete, media
+ * @param opts.content - Human-readable description (e.g. "Upload Blob")
+ * @param opts.expiration - Unix timestamp when the token expires
+ * @param opts.hashes - SHA-256 hashes to scope the token to (x tags)
+ * @param opts.size - Blob size in bytes
+ * @param opts.servers - Server URLs to restrict the token to
+ */
+export function createAuthEventTemplate(opts) {
+    const tags = [
+        ['t', opts.action],
+        ['expiration', String(opts.expiration)],
+    ];
+    if (opts.hashes) {
+        for (const hash of opts.hashes)
+            tags.push(['x', hash]);
+    }
+    if (opts.size !== undefined) {
+        tags.push(['size', String(opts.size)]);
+    }
+    if (opts.servers) {
+        for (const server of opts.servers) {
+            try {
+                tags.push(['server', new URL(server).hostname.toLowerCase()]);
+            }
+            catch {
+                tags.push(['server', server.toLowerCase()]);
+            }
+        }
+    }
+    return {
+        kind: AUTH_KIND,
+        created_at: Math.floor(Date.now() / 1000),
+        tags,
+        content: opts.content,
+    };
+}
+/**
+ * Create and sign a kind 24242 Blossom authorization event.
+ */
+export function createAuthEvent(opts, secretKey) {
+    return finalizeEvent(createAuthEventTemplate(opts), secretKey);
+}
+// ── Authorization Header ───────────────────────────────────────────────
+/**
+ * Encode a signed kind 24242 event as a Blossom Authorization header value.
+ *
+ * Format: `Nostr <base64url-no-pad-encoded-event>`
+ */
+export function getAuthorizationHeader(event) {
+    const json = JSON.stringify(event);
+    const b64 = btoa(json).replace(/\+/g, '-').replace(/\//g, '_').replace(/=/g, '');
+    return `Nostr ${b64}`;
+}
+// ── HTTP Operations ────────────────────────────────────────────────────
+function baseUrl(url) {
+    return url.replace(/\/$/, '');
+}
+/**
+ * Upload a blob to a Blossom server (BUD-02).
+ *
+ * @param serverUrl - Blossom server base URL
+ * @param data - Binary data to upload
+ * @param authEvent - Signed kind 24242 auth event with action "upload"
+ * @param contentType - MIME type (default: application/octet-stream)
+ * @returns Blob descriptor from the server
+ */
+export async function uploadBlob(serverUrl, data, authEvent, contentType) {
+    const hash = bytesToHex(sha256(data));
+    const res = await fetch(`${baseUrl(serverUrl)}/upload`, {
+        method: 'PUT',
+        headers: {
+            'Authorization': getAuthorizationHeader(authEvent),
+            'Content-Type': contentType || 'application/octet-stream',
+            'X-SHA-256': hash,
+        },
+        body: data,
+    });
+    if (!res.ok) {
+        const reason = res.headers.get('X-Reason') || (await res.text().catch(() => ''));
+        throw new BlossomError(reason || res.statusText, 'UPLOAD_ERROR', res.status);
+    }
+    return (await res.json());
+}
+/**
+ * Retrieve a blob from a Blossom server (BUD-01).
+ *
+ * @param serverUrl - Blossom server base URL
+ * @param sha256Hash - SHA-256 hash of the blob (hex)
+ * @param ext - Optional file extension (e.g. ".png")
+ * @returns The raw blob data
+ */
+export async function getBlob(serverUrl, sha256Hash, ext) {
+    const path = ext ? `${sha256Hash}${ext}` : sha256Hash;
+    const res = await fetch(`${baseUrl(serverUrl)}/${path}`);
+    if (!res.ok) {
+        throw new BlossomError(res.headers.get('X-Reason') || res.statusText, 'NOT_FOUND', res.status);
+    }
+    return res.arrayBuffer();
+}
+/**
+ * Check if a blob exists on a Blossom server (BUD-01).
+ */
+export async function checkBlob(serverUrl, sha256Hash) {
+    try {
+        const res = await fetch(`${baseUrl(serverUrl)}/${sha256Hash}`, { method: 'HEAD' });
+        return res.ok;
+    }
+    catch {
+        return false;
+    }
+}
+/**
+ * Delete a blob from a Blossom server (BUD-02).
+ *
+ * @param serverUrl - Blossom server base URL
+ * @param sha256Hash - SHA-256 hash of the blob to delete (hex)
+ * @param authEvent - Signed kind 24242 auth event with action "delete"
+ */
+export async function deleteBlob(serverUrl, sha256Hash, authEvent) {
+    const res = await fetch(`${baseUrl(serverUrl)}/${sha256Hash}`, {
+        method: 'DELETE',
+        headers: { 'Authorization': getAuthorizationHeader(authEvent) },
+    });
+    if (!res.ok) {
+        const reason = res.headers.get('X-Reason') || (await res.text().catch(() => ''));
+        throw new BlossomError(reason || res.statusText, 'DELETE_ERROR', res.status);
+    }
+}
+/**
+ * List blobs uploaded by a pubkey (BUD-02).
+ *
+ * @param serverUrl - Blossom server base URL
+ * @param pubkey - Hex public key
+ * @param opts.cursor - SHA-256 hash of last blob for pagination
+ * @param opts.limit - Maximum number of results
+ * @returns Array of blob descriptors sorted by upload date descending
+ */
+export async function listBlobs(serverUrl, pubkey, opts) {
+    const params = new URLSearchParams();
+    if (opts?.cursor)
+        params.set('cursor', opts.cursor);
+    if (opts?.limit)
+        params.set('limit', String(opts.limit));
+    const qs = params.toString();
+    const url = `${baseUrl(serverUrl)}/list/${pubkey}${qs ? `?${qs}` : ''}`;
+    const res = await fetch(url);
+    if (!res.ok) {
+        throw new BlossomError(res.headers.get('X-Reason') || res.statusText, 'LIST_ERROR', res.status);
+    }
+    return (await res.json());
+}
+/**
+ * Mirror a blob from a remote URL to a Blossom server (BUD-04).
+ *
+ * @param serverUrl - Destination Blossom server base URL
+ * @param sourceUrl - Public URL of the blob to mirror
+ * @param authEvent - Signed kind 24242 auth event with action "upload"
+ * @returns Blob descriptor from the destination server
+ */
+export async function mirrorBlob(serverUrl, sourceUrl, authEvent) {
+    const res = await fetch(`${baseUrl(serverUrl)}/mirror`, {
+        method: 'PUT',
+        headers: {
+            'Authorization': getAuthorizationHeader(authEvent),
+            'Content-Type': 'application/json',
+        },
+        body: JSON.stringify({ url: sourceUrl }),
+    });
+    if (!res.ok) {
+        const reason = res.headers.get('X-Reason') || (await res.text().catch(() => ''));
+        throw new BlossomError(reason || res.statusText, 'MIRROR_ERROR', res.status);
+    }
+    return (await res.json());
+}
+// ── Utilities ──────────────────────────────────────────────────────────
+/**
+ * Compute the SHA-256 hash of a blob (hex).
+ *
+ * This is the content-addressable identifier used by Blossom servers.
+ */
+export function getBlobHash(data) {
+    return bytesToHex(sha256(data));
+}
+//# sourceMappingURL=blossom.js.map

package/dist/blossom.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"blossom.js","sourceRoot":"","sources":["../src/blossom.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAA;AAC3C,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAA;AAChD,OAAO,EAAE,aAAa,EAAuC,MAAM,YAAY,CAAA;AAE/E,0EAA0E;AAE1E,6CAA6C;AAC7C,MAAM,CAAC,MAAM,gBAAgB,GAAG,KAAK,CAAA;AAErC,kCAAkC;AAClC,MAAM,CAAC,MAAM,SAAS,GAAG,KAAK,CAAA;AAgB9B,MAAM,OAAO,YAAa,SAAQ,KAAK;IACrC,IAAI,CAAQ;IACZ,MAAM,CAAS;IACf,YAAY,OAAe,EAAE,IAAI,GAAG,eAAe,EAAE,MAAe;QAClE,KAAK,CAAC,OAAO,CAAC,CAAA;QACd,IAAI,CAAC,IAAI,GAAG,cAAc,CAAA;QAC1B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;QAChB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;CACF;AAED,0EAA0E;AAE1E;;;;GAIG;AACH,MAAM,UAAU,6BAA6B,CAAC,OAAiB;IAC7D,OAAO;QACL,IAAI,EAAE,gBAAgB;QACtB,UAAU,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC;QACzC,IAAI,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;QACrC,OAAO,EAAE,EAAE;KACZ,CAAA;AACH,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,qBAAqB,CACnC,OAAiB,EACjB,SAAqB;IAErB,OAAO,aAAa,CAAC,6BAA6B,CAAC,OAAO,CAAC,EAAE,SAAS,CAAC,CAAA;AACzE,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,eAAe,CAAC,KAAiB;IAC/C,IAAI,KAAK,CAAC,IAAI,KAAK,gBAAgB,EAAE,CAAC;QACpC,MAAM,IAAI,KAAK,CAAC,iBAAiB,gBAAgB,SAAS,KAAK,CAAC,IAAI,EAAE,CAAC,CAAA;IACzE,CAAC;IACD,OAAO,KAAK,CAAC,IAAI;SACd,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,QAAQ,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;SACtC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;AACnB,CAAC;AAED,yEAAyE;AAEzE;;;;;;;;;GASG;AACH,MAAM,UAAU,uBAAuB,CAAC,IAOvC;IACC,MAAM,IAAI,GAAe;QACvB,CAAC,GAAG,EAAE,IAAI,CAAC,MAAM,CAAC;QAClB,CAAC,YAAY,EAAE,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;KACxC,CAAA;IACD,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;QAChB,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,MAAM;YAAE,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,CAAA;IACxD,CAAC;IACD,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;QAC5B,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;IACxC,CAAC;IACD,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;QACjB,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YAClC,IAAI,CAAC;gBACH,IAAI,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,IAAI,GAAG,CAAC,MAAM,CAAC,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC,CAAC,CAAA;YAC/D,CAAC;YAAC,MAAM,CAAC;gBACP,IAAI,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,MAAM,CAAC,WAAW,EAAE,CAAC,CAAC,CAAA;YAC7C,CAAC;QACH,CAAC;IACH,CAAC;IACD,OAAO;QACL,IAAI,EAAE,SAAS;QACf,UAAU,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC;QACzC,IAAI;QACJ,OAAO,EAAE,IAAI,CAAC,OAAO;KACtB,CAAA;AACH,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,eAAe,CAC7B,IAAmD,EACnD,SAAqB;IAErB,OAAO,aAAa,CAAC,uBAAuB,CAAC,IAAI,CAAC,EAAE,SAAS,CAAC,CAAA;AAChE,CAAC;AAED,0EAA0E;AAE1E;;;;GAIG;AACH,MAAM,UAAU,sBAAsB,CAAC,KAAiB;IACtD,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAA;IAClC,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAA;IAChF,OAAO,SAAS,GAAG,EAAE,CAAA;AACvB,CAAC;AAED,0EAA0E;AAE1E,SAAS,OAAO,CAAC,GAAW;IAC1B,OAAO,GAAG,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAA;AAC/B,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,CAAC,KAAK,UAAU,UAAU,CAC9B,SAAiB,EACjB,IAAgB,EAChB,SAAqB,EACrB,WAAoB;IAEpB,MAAM,IAAI,GAAG,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAA;IACrC,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,GAAG,OAAO,CAAC,SAAS,CAAC,SAAS,EAAE;QACtD,MAAM,EAAE,KAAK;QACb,OAAO,EAAE;YACP,eAAe,EAAE,sBAAsB,CAAC,SAAS,CAAC;YAClD,cAAc,EAAE,WAAW,IAAI,0BAA0B;YACzD,WAAW,EAAE,IAAI;SAClB;QACD,IAAI,EAAE,IAA2B;KAClC,CAAC,CAAA;IACF,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC;QACZ,MAAM,MAAM,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC,CAAC,CAAA;QAChF,MAAM,IAAI,YAAY,CAAC,MAAM,IAAI,GAAG,CAAC,UAAU,EAAE,cAAc,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;IAC9E,CAAC;IACD,OAAO,CAAC,MAAM,GAAG,CAAC,IAAI,EAAE,CAAmB,CAAA;AAC7C,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,OAAO,CAC3B,SAAiB,EACjB,UAAkB,EAClB,GAAY;IAEZ,MAAM,IAAI,GAAG,GAAG,CAAC,CAAC,CAAC,GAAG,UAAU,GAAG,GAAG,EAAE,CAAC,CAAC,CAAC,UAAU,CAAA;IACrD,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,GAAG,OAAO,CAAC,SAAS,CAAC,IAAI,IAAI,EAAE,CAAC,CAAA;IACxD,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC;QACZ,MAAM,IAAI,YAAY,CACpB,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,GAAG,CAAC,UAAU,EAC7C,WAAW,EACX,GAAG,CAAC,MAAM,CACX,CAAA;IACH,CAAC;IACD,OAAO,GAAG,CAAC,WAAW,EAAE,CAAA;AAC1B,CAAC;AAED;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,SAAS,CAC7B,SAAiB,EACjB,UAAkB;IAElB,IAAI,CAAC;QACH,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,GAAG,OAAO,CAAC,SAAS,CAAC,IAAI,UAAU,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAA;QAClF,OAAO,GAAG,CAAC,EAAE,CAAA;IACf,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAA;IACd,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,UAAU,CAC9B,SAAiB,EACjB,UAAkB,EAClB,SAAqB;IAErB,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,GAAG,OAAO,CAAC,SAAS,CAAC,IAAI,UAAU,EAAE,EAAE;QAC7D,MAAM,EAAE,QAAQ;QAChB,OAAO,EAAE,EAAE,eAAe,EAAE,sBAAsB,CAAC,SAAS,CAAC,EAAE;KAChE,CAAC,CAAA;IACF,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC;QACZ,MAAM,MAAM,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC,CAAC,CAAA;QAChF,MAAM,IAAI,YAAY,CAAC,MAAM,IAAI,GAAG,CAAC,UAAU,EAAE,cAAc,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;IAC9E,CAAC;AACH,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,CAAC,KAAK,UAAU,SAAS,CAC7B,SAAiB,EACjB,MAAc,EACd,IAA0C;IAE1C,MAAM,MAAM,GAAG,IAAI,eAAe,EAAE,CAAA;IACpC,IAAI,IAAI,EAAE,MAAM;QAAE,MAAM,CAAC,GAAG,CAAC,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,CAAA;IACnD,IAAI,IAAI,EAAE,KAAK;QAAE,MAAM,CAAC,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAA;IACxD,MAAM,EAAE,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAA;IAC5B,MAAM,GAAG,GAAG,GAAG,OAAO,CAAC,SAAS,CAAC,SAAS,MAAM,GAAG,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAA;IAEvE,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,GAAG,CAAC,CAAA;IAC5B,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC;QACZ,MAAM,IAAI,YAAY,CACpB,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,GAAG,CAAC,UAAU,EAC7C,YAAY,EACZ,GAAG,CAAC,MAAM,CACX,CAAA;IACH,CAAC;IACD,OAAO,CAAC,MAAM,GAAG,CAAC,IAAI,EAAE,CAAqB,CAAA;AAC/C,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,UAAU,CAC9B,SAAiB,EACjB,SAAiB,EACjB,SAAqB;IAErB,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,GAAG,OAAO,CAAC,SAAS,CAAC,SAAS,EAAE;QACtD,MAAM,EAAE,KAAK;QACb,OAAO,EAAE;YACP,eAAe,EAAE,sBAAsB,CAAC,SAAS,CAAC;YAClD,cAAc,EAAE,kBAAkB;SACnC;QACD,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,GAAG,EAAE,SAAS,EAAE,CAAC;KACzC,CAAC,CAAA;IACF,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC;QACZ,MAAM,MAAM,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC,CAAC,CAAA;QAChF,MAAM,IAAI,YAAY,CAAC,MAAM,IAAI,GAAG,CAAC,UAAU,EAAE,cAAc,EAAE,GAAG,CAAC,MAAM,CAAC,CAAA;IAC9E,CAAC;IACD,OAAO,CAAC,MAAM,GAAG,CAAC,IAAI,EAAE,CAAmB,CAAA;AAC7C,CAAC;AAED,0EAA0E;AAE1E;;;;GAIG;AACH,MAAM,UAAU,WAAW,CAAC,IAAgB;IAC1C,OAAO,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAA;AACjC,CAAC"}

package/dist/bolt11.d.ts

@@ -0,0 +1,78 @@
+export declare class Bolt11Error extends Error {
+    code: string;
+    constructor(message: string, code?: string);
+}
+export type Bolt11Network = 'mainnet' | 'testnet' | 'signet' | 'regtest';
+export type Bolt11RouteHint = {
+    pubkey: string;
+    shortChannelId: string;
+    feeBaseMsat: number;
+    feeProportionalMillionths: number;
+    cltvExpiryDelta: number;
+};
+export type Bolt11FallbackAddress = {
+    version: number;
+    hex: string;
+};
+export type Bolt11Invoice = {
+    /** The canonical lowercase invoice string */
+    paymentRequest: string;
+    /** HRP prefix (e.g. "lnbc", "lntb") */
+    prefix: string;
+    /** Bitcoin network */
+    network: Bolt11Network;
+    /** Amount in millisatoshis (undefined for zero-amount invoices) */
+    amountMsat?: number;
+    /** Amount in satoshis (undefined for zero-amount invoices) */
+    amountSat?: number;
+    /** Unix timestamp when invoice was created */
+    timestamp: number;
+    /** Expiry time in seconds (default 3600) */
+    expiry: number;
+    /** Absolute expiry timestamp (timestamp + expiry) */
+    expiresAt: number;
+    /** Whether the invoice has expired at decode time */
+    isExpired: boolean;
+    /** Payment hash (256-bit, hex) */
+    paymentHash: string;
+    /** Payment secret (256-bit, hex) */
+    paymentSecret?: string;
+    /** Short description (UTF-8) */
+    description?: string;
+    /** SHA-256 hash of a longer description (hex) */
+    descriptionHash?: string;
+    /** Payee node public key (33-byte compressed, hex) */
+    payeeNodeKey?: string;
+    /** Minimum final CLTV expiry delta in blocks (default 18) */
+    minFinalCltvExpiry: number;
+    /** Feature bits */
+    featureBits?: Uint8Array;
+    /** Payment metadata (hex) */
+    metadata?: string;
+    /** Route hints for private channels (each entry is one r-tag's hops) */
+    routeHints: Bolt11RouteHint[][];
+    /** Fallback on-chain addresses */
+    fallbackAddresses: Bolt11FallbackAddress[];
+    /** Signature R||S (64 bytes, hex) */
+    signature: string;
+    /** Signature recovery flag (0-3) */
+    recoveryFlag: number;
+    /** Unrecognized tagged fields */
+    unknownTags: {
+        tag: number;
+        words: number[];
+    }[];
+};
+/**
+ * Decode a BOLT-11 Lightning invoice.
+ *
+ * Extracts amount, payment hash, description, expiry, route hints,
+ * payee node key, and all other tagged fields from a bech32-encoded
+ * Lightning invoice.
+ *
+ * @param invoice - A BOLT-11 invoice string (e.g. "lnbc10u1p...")
+ * @returns Decoded invoice with all fields
+ * @throws {Bolt11Error} If the invoice is malformed or missing required fields
+ */
+export declare function decode(invoice: string): Bolt11Invoice;
+//# sourceMappingURL=bolt11.d.ts.map

package/dist/bolt11.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"bolt11.d.ts","sourceRoot":"","sources":["../src/bolt11.ts"],"names":[],"mappings":"AAQA,qBAAa,WAAY,SAAQ,KAAK;IACpC,IAAI,EAAE,MAAM,CAAA;gBACA,OAAO,EAAE,MAAM,EAAE,IAAI,SAAiB;CAKnD;AAID,MAAM,MAAM,aAAa,GAAG,SAAS,GAAG,SAAS,GAAG,QAAQ,GAAG,SAAS,CAAA;AAExE,MAAM,MAAM,eAAe,GAAG;IAC5B,MAAM,EAAE,MAAM,CAAA;IACd,cAAc,EAAE,MAAM,CAAA;IACtB,WAAW,EAAE,MAAM,CAAA;IACnB,yBAAyB,EAAE,MAAM,CAAA;IACjC,eAAe,EAAE,MAAM,CAAA;CACxB,CAAA;AAED,MAAM,MAAM,qBAAqB,GAAG;IAClC,OAAO,EAAE,MAAM,CAAA;IACf,GAAG,EAAE,MAAM,CAAA;CACZ,CAAA;AAED,MAAM,MAAM,aAAa,GAAG;IAC1B,6CAA6C;IAC7C,cAAc,EAAE,MAAM,CAAA;IACtB,uCAAuC;IACvC,MAAM,EAAE,MAAM,CAAA;IACd,sBAAsB;IACtB,OAAO,EAAE,aAAa,CAAA;IACtB,mEAAmE;IACnE,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,8DAA8D;IAC9D,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,8CAA8C;IAC9C,SAAS,EAAE,MAAM,CAAA;IACjB,4CAA4C;IAC5C,MAAM,EAAE,MAAM,CAAA;IACd,qDAAqD;IACrD,SAAS,EAAE,MAAM,CAAA;IACjB,qDAAqD;IACrD,SAAS,EAAE,OAAO,CAAA;IAClB,kCAAkC;IAClC,WAAW,EAAE,MAAM,CAAA;IACnB,oCAAoC;IACpC,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,gCAAgC;IAChC,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,iDAAiD;IACjD,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB,sDAAsD;IACtD,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,6DAA6D;IAC7D,kBAAkB,EAAE,MAAM,CAAA;IAC1B,mBAAmB;IACnB,WAAW,CAAC,EAAE,UAAU,CAAA;IACxB,6BAA6B;IAC7B,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,wEAAwE;IACxE,UAAU,EAAE,eAAe,EAAE,EAAE,CAAA;IAC/B,kCAAkC;IAClC,iBAAiB,EAAE,qBAAqB,EAAE,CAAA;IAC1C,qCAAqC;IACrC,SAAS,EAAE,MAAM,CAAA;IACjB,oCAAoC;IACpC,YAAY,EAAE,MAAM,CAAA;IACpB,iCAAiC;IACjC,WAAW,EAAE;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,EAAE,CAAA;KAAE,EAAE,CAAA;CAChD,CAAA;AAuID;;;;;;;;;;GAUG;AACH,wBAAgB,MAAM,CAAC,OAAO,EAAE,MAAM,GAAG,aAAa,CAmLrD"}