Class LNURL

Constructors

constructor

Properties

#service? #url

Accessors

canZap isLNAddress lnurl max maxCommentLength min name url zapperPubkey

Methods

#validateService getInvoice getLNAddress load

Constructors

constructor

  • new LNURL(lnurl): LNURL

  • Setup LNURL service

    Parameters

    • lnurl: string

      bech32 lnurl / lightning address / https url

    Returns LNURL

Properties

Private Optional #service

#service?: LNURLService

Private #url

#url: URL

Accessors

canZap

  • get canZap(): boolean

  • Are zaps (NIP-57) supported

    Returns boolean

isLNAddress

  • get isLNAddress(): boolean

  • Is this LNURL a LUD-16 Lightning Address

    Returns boolean

lnurl

  • get lnurl(): string

  • Return the optimal formatted LNURL

    Returns string

max

  • get max(): number

  • Max sendable in milli-sats

    Returns number

maxCommentLength

  • get maxCommentLength(): number

  • Get the max allowed comment length

    Returns number

min

  • get min(): number

  • Min sendable in milli-sats

    Returns number

name

  • get name(): string

  • Human readable name for this service

    Returns string

url

  • get url(): URL

  • URL of this payService

    Returns URL

zapperPubkey

  • get zapperPubkey(): undefined | string

  • Return pubkey of zap service

    Returns undefined | string

Methods

Private #validateService

  • #validateService(): void

  • Returns void

getInvoice

  • getInvoice(amount, comment?, zap?): Promise<LNURLInvoice>

  • Fetch an invoice from the LNURL service

    Parameters

    • amount: number

      Amount in sats

    • Optional comment: string
    • Optional zap: object

    Returns Promise<LNURLInvoice>

getLNAddress

  • getLNAddress(): string

  • Get the LN Address for this LNURL

    Returns string

load

  • load(): Promise<void>

  • Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc