@integraledger/lcp/lightning

InterfacesCopy Anchor Link

Bolt11Copy Anchor Link

PropertiesCopy Anchor Link

---

LnMppChoiceCopy Anchor Link

PropertiesCopy Anchor Link

---

LnMppUnsignedCopy Anchor Link

PropertiesCopy Anchor Link

MethodsCopy Anchor Link

complete()Copy Anchor Link

complete(preimage): Refusal | MppCredential

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Refusal | MppCredential

---

LnRefCopy Anchor Link

The read keys recorded at claim: the invoice's payment hash as lowercase hex, and when the payment can land.

PropertiesCopy Anchor Link

---

LnUnsignedCopy Anchor Link

PropertiesCopy Anchor Link

MethodsCopy Anchor Link

complete()Copy Anchor Link

complete(preimage): Refusal | LnPaymentPayload

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Refusal | LnPaymentPayload

Type AliasesCopy Anchor Link

LnMppPairingCopy Anchor Link

LnMppPairing = typeof LN_CHARGE | typeof LN_SESSION

---

LnNetworkCopy Anchor Link

LnNetwork = "lnbtc:000000000019d6689c085ae165831e93" | "lnbtc:000000000933ea01ad0ee984209779ba"

CAIP-2 for Lightning: lnbtc: and the first 32 hex digits of the Bitcoin network's genesis block hash.

---

LnPaymentPayloadCopy Anchor Link

LnPaymentPayload = object

PropertiesCopy Anchor Link

VariablesCopy Anchor Link

chargeLightningCopy Anchor Link

const chargeLightning: Readonly<{ advertise: (doc, h, link, offer, agreementUrl?) => Refusal | MppChallenge[]; advertiseBeforeCarrier: (doc, h, link, offer, agreementUrl?) => Refusal | MppChallenge[]; bound: (presented) => Promise<`0x${string}` | Refusal>; build: (choice, h) => Promise<Refusal | LnMppUnsigned>; carrier: string; claims: boolean; id: "mpp/charge/lightning"; pattern: LcpPattern; read: (doc) => Refusal | { agreement?: string; h: `0x${string}`; link: string; offer: { challenges: MppChallenge[]; }; }; reference: (presented) => Promise<Refusal | LnRef>; tie: (options) => ["mpp", { challenges: MppChallenge[]; }]; unplaced: (c) => MppChallenge; }>

---

exactLnbtcCopy Anchor Link

const exactLnbtc: Readonly<{ advertise: (doc, h, link, offer, agreementUrl?) => Refusal | PaymentRequired; advertiseBeforeCarrier: (doc, h, link, offer, agreementUrl?) => Refusal | PaymentRequired; bound: (presented) => Promise<`0x${string}` | Refusal>; build: (c, h) => Promise<Refusal | LnUnsigned>; carrier: "extra.invoice#m"; claims: boolean; id: "x402/exact/lnbtc"; pattern: LcpPattern; read: (doc) => Refusal | X402Read; reference: (presented) => Promise<Refusal | LnRef>; tie: (accepts, request) => ["x402", { accepts: readonly PaymentRequirements[]; request: RequestCommitment; }]; unplaced: (option) => PaymentRequirements; }>

---

exactLnbtcNamedCopy Anchor Link

const exactLnbtcNamed: Readonly<{ advertise: (doc, h, link, offer, agreementUrl?) => Refusal | PaymentRequired; bound: (presented) => Promise<`0x${string}` | Refusal>; build: (c, h) => Promise<Refusal | LnUnsigned>; carrier: null; claims: boolean; id: "x402/exact/lnbtc/invoice-named"; pattern: LcpPattern; read: (doc) => Refusal | X402Read; reference: (presented) => Promise<Refusal | LnRef>; tie: (accepts, request) => ["x402", { accepts: readonly PaymentRequirements[]; request: RequestCommitment; }]; unplaced: (option) => PaymentRequirements; }>

---

sessionLightningCopy Anchor Link

const sessionLightning: Readonly<{ advertise: (doc, h, link, offer, agreementUrl?) => Refusal | MppChallenge[]; advertiseBeforeCarrier: (doc, h, link, offer, agreementUrl?) => Refusal | MppChallenge[]; bound: (presented) => Promise<`0x${string}` | Refusal>; build: (choice, h) => Promise<Refusal | LnMppUnsigned>; carrier: string; channel: Readonly<{ boundWithin: (_presented) => Promise<`0x${string}` | Refusal>; kind: (presented) => "open" | "close" | Refusal | "within"; ref: (presented) => Promise<Refusal | { channel: string; network: string; }>; until: (_presented) => number | undefined; }>; claims: boolean; id: "mpp/session/lightning"; pattern: LcpPattern; read: (doc) => Refusal | { agreement?: string; h: `0x${string}`; link: string; offer: { challenges: MppChallenge[]; }; }; reference: (presented) => Promise<Refusal | LnRef>; tie: (options) => ["mpp", { challenges: MppChallenge[]; }]; unplaced: (c) => MppChallenge; }>

FunctionsCopy Anchor Link

atrNamesInvoice()Copy Anchor Link

atrNamesInvoice(atr, invoice): boolean

True when the ATR's bytes are one JSON object whose x402 slot's accepts holds an option whose extra.invoice is exactly invoice. Only that slot is read.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

boolean

---

decodeBolt11()Copy Anchor Link

decodeBolt11(invoice): Promise<Refusal | Bolt11>

Decodes a BOLT11 invoice without its length limit, up to 8 KiB. The signature is not verified.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise<Refusal | Bolt11>

---

invoiceH()Copy Anchor Link

invoiceH(b, field): `0x${string}` | Refusal

The one 32-byte h or m field of an invoice, as the hash it carries.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

`0x${string}` | Refusal

---

lnbtcPairingOf()Copy Anchor Link

lnbtcPairingOf(option): "x402/exact/lnbtc" | "x402/exact/lnbtc/invoice-named" | undefined

Which of the two x402 Lightning pairings an option belongs to: by whether its invoice has an m field. An option whose extra has no invoice is the offer the seller sends before its node writes the invoice, so it is x402/exact/lnbtc; an invoice-named option carries its invoice at issue.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

"x402/exact/lnbtc" | "x402/exact/lnbtc/invoice-named" | undefined