Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
LIGHTNING-DECODEPAY(7)	      lightning-decodepay	LIGHTNING-DECODEPAY(7)

NAME
       lightning-decodepay - Command for decoding a bolt11 string (low-level)

SYNOPSIS
       decodepay bolt11	[description]

DESCRIPTION
       The  decodepay  RPC command checks and parses a bolt11 string as	speci-
       fied by the BOLT	11 specification.

RETURN VALUE
       On success, an object is	returned, containing:

	      o	     currency (string):	the BIP173 name	for the	currency

	      o	     created_at	(u64): the UNIX-style timestamp	of the invoice

	      o	     expiry (u64): the number of seconds this is  valid	 after
		     timestamp

	      o	     payee (pubkey): the public	key of the recipient

	      o	     payment_hash (hex): the hash of the payment_preimage (al-
		     ways 64 characters)

	      o	     signature (signature): signature of the payee on this in-
		     voice

	      o	     min_final_cltv_expiry  (u32):  the	minimum	CLTV delay for
		     the final node

	      o	     amount_msat (msat,	optional): Amount  the	invoice	 asked
		     for

	      o	     description  (string,  optional):	the description	of the
		     purpose of	the purchase

	      o	     description_hash (hex, optional): the  hash  of  the  de-
		     scription,	in place of description	(always	64 characters)

	      o	     payment_secret (hex, optional): the secret	to hand	to the
		     payee node	(always	64 characters)

	      o	     features (hex, optional): the features  bitmap  for  this
		     invoice

	      o	     fallbacks	(array	of  objects,  optional):  onchain  ad-
		     dresses:

		     o	    type (string): the address type (if	known) (one of
			    "P2PKH", "P2SH", "P2WPKH", "P2WSH")

		     o	    hex	(hex): Raw encoded address

		     o	    addr  (string, optional): the address in appropri-
			    ate	format for type

	      o	     routes (array of arrays, optional): Route	hints  to  the
		     payee:

		     o	    hops in the	route:

			    o	   pubkey (pubkey): the	public key of the node

			    o	   short_channel_id    (short_channel_id):   a
				   channel to the next peer

			    o	   fee_base_msat (u32):	the base fee for  pay-
				   ments

			    o	   fee_proportional_millionths	  (u32):   the
				   parts-per-million fee for payments

			    o	   cltv_expiry_delta  (u32):  the  CLTV	 delta
				   across this hop

	      o	     extra  (array  of objects,	optional): Any extra fields we
		     didn't know how to	parse:

		     o	    tag	(string): The bech32 letter  which  identifies
			    this field (always 1 characters)

		     o	    data (string): The bech32 data for this field

       Technically,  the  description  field is	optional if a description_hash
       field is	given, but in this case	decodepay will only succeed if the op-
       tional description field	is passed and matches the description_hash. In
       practice, these are currently unused.

AUTHOR
       Rusty Russell _rusty@rustcorp.com.au> is	mainly responsible.

SEE ALSO
       lightning-pay(7), lightning-getroute(7),	lightning-sendpay(7).

       BOLT  #11  (https://github.com/lightningnetwork/lightning-rfc/blob/mas-
       ter/11-payment-encoding.md).

RESOURCES
       Main web	site: https://github.com/ElementsProject/lightning

							LIGHTNING-DECODEPAY(7)

NAME | SYNOPSIS | DESCRIPTION | RETURN VALUE | AUTHOR | SEE ALSO | RESOURCES

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=lightning-decodepay&sektion=7&manpath=FreeBSD+13.0-RELEASE+and+Ports>

home | help