LIGHTNING-FETCHBIP353(7)

📦
version 26.06.9 · 2 versions
, in nixpkgs unstable

NAME ✨

LIGHTNING-FETCHBIP353(7) bestie! This is the manual page for fetchbip353 — Fetch BIP-353 payment instructions. okay so she’s literally the one fetching BIP-353 payment instructions, no cap. 💖

SYNOPSIS 🎀

fetchbip353 address

DESCRIPTION 🌸

Command added in v25.09. ✨

fetchbip353 fetches BIP-353 payment instructions and the DNSSEC proof. That’s the whole plot, bestie.

  • address (string) — The BIP-353 address to fetch payment instructions for. That’s the one argument, periodt.

RETURN VALUE 💸

On success, an object is returned, containing:

  • proof (string) — The hex-encoded DNSSEC proof for the BIP-353 address.
  • instructions (array of objects) — A list of processed payment instruction objects. Each object either contains information about an onchain or an offchain payment. Both can have an optional amount for fixed amount payments aswell as an optional description provided by the recipient. The per-instruction details are:
    • description (string, optional) — Optional description of the payment instruction.
    • offer (string, optional) — An offer string for a bolt12 payment.
    • onchain (string, optional) — A bitcoin onchain address.
    • offchain_amount_msat (u64, optional) — Optional lightning payment amount in millisatoshis, present only if offer is specified.
    • onchain_amount_sat (u64, optional) — Optional onchain payment amount in satoshis, present only if onchain is specified.

ERRORS 😭

On failure, the following error code may be returned:

  • -32700 — Description of the error.

AUTHOR 👑

daywalker90 is mainly responsible. Iconic.

EXAMPLES 🧚

Example 1: Example of fetching BIP-353 payment details. ✨

Request:

$ lightning-cli fetchbip353 -k "address"="send.some@satsto.me"
{
  "id": "example:fetchbip353#1",
  "method": "fetchbip353",
  "params": {
    "address": "send.some@satsto.me"
  }
}

Response:

{
  "instructions": [
    {
      "onchain": "bc1qztwy6xen3zdtt7z0vrgapmjtfz8acjkfp5fp7l"
    },
    {
      "offer": "lno1zr5qyugqgskrk70kqmuq7v3dnr2fnmhukps9n8hut48vkqpqnskt2svsqwjakp7k6pyhtkuxw7y2kqmsxlwruhzqv0zsnhh9q3t9xhx39suc6qsr07ekm5esdyum0w66mnx8vdquwvp7dp5jp7j3v5cp6aj0w329fnkqqv60q96sz5nkrc5r95qffx002q53tqdk8x9m2tmt85jtpmcycvfnrpx3lr45h2g7na3sec7xguctfzzcm8jjqtj5ya27te60j03vpt0vq9tm2n9yxl2hngfnmygesa25s4u4zlxewqpvp94xt7rur4rhxunwkthk9vly3lm5hh0pqv4aymcqejlgssnlpzwlggykkajp7yjs5jvr2agkyypcdlj280cy46jpynsezrcj2kwa2lyr8xvd6lfkph4xrxtk2xc3lpq"
    }
  ],
  "proof": "0473656e64proof00001proof00001proof00001proof00001proof00001proof00001proof00001proof00001proof00001proof00001"
}

sign-off time 🌈 the footer’s source/version is Core Lightning v26.06.9, this manual is LIGHTNING-FETCHBIP353(7), and the footer has no date printed, so no invented date bestie — bye and slay 🫶💜

📦 where this page comes from