@nostrify/nostrify@0.46.5

latest

Framework for Nostr on Deno and web. 🛸

Published

2 months ago (0.46.5)

class LNURL

Represents an LNURL, with methods to fetch details and generate invoices.

Constructors

new



LNURL(url: URL,
opts?: { fetch: globalThis.fetch;  },
)

private



fetch: globalThis.fetch

Fetch function to use for HTTP requests.

readonly



url: URL

Underlying HTTP(s) URL of the user.



getDetails(opts?: { signal?: AbortSignal;  }): Promise<LNURLDetails>

Resolve an LNURL to its details.



getInvoice(opts: { amount: number; nostr?: NostrEvent; signal?: AbortSignal;  }): Promise<LNURLCallback>

Generate an LNURL invoice from the params.



toString(): `lnurl1${string}`

Returns the LNURL object as a bech32-encoded lnurl1... string.



fromLightningAddress(ln: string,
opts?: { fetch: globalThis.fetch;  },
): LNURL

Create an LNURL object from a lightning address (email-like format). Throws if the value is not a valid lightning address.



fromString(value: string,
opts?: { fetch: globalThis.fetch;  },
): LNURL

Create an LNURL object from a bech32 lnurl1... string. Throws if the value is not a valid lnurl.



lnurlCallbackSchema(): z.ZodType<LNURLCallback>

LNURL callback schema.



lnurlDetailsSchema(): z.ZodType<LNURLDetails>

LNURL response schema.

Add Package

deno add jsr:@nostrify/nostrify

Import symbol

import { LNURL } from "@nostrify/nostrify/ln";

Import directly with a jsr specifier

import { LNURL } from "jsr:@nostrify/nostrify/ln";

Add Package

pnpm i jsr:@nostrify/nostrify

or (using pnpm 10.8 or older)

pnpm dlx jsr add @nostrify/nostrify

Import symbol

import { LNURL } from "@nostrify/nostrify/ln";

Add Package

yarn add jsr:@nostrify/nostrify

or (using Yarn 4.8 or older)

yarn dlx jsr add @nostrify/nostrify

Import symbol

import { LNURL } from "@nostrify/nostrify/ln";

Add Package

vlt install jsr:@nostrify/nostrify

Import symbol

import { LNURL } from "@nostrify/nostrify/ln";

Add Package

npx jsr add @nostrify/nostrify

Import symbol

import { LNURL } from "@nostrify/nostrify/ln";

Add Package

bunx jsr add @nostrify/nostrify

Import symbol

import { LNURL } from "@nostrify/nostrify/ln";