BOLT 11

Imagemap
BOLT 11 docs BOLT 11 Glossary resources links mailing list github bolts lndecode min_final_cltv_expiry tags BOLT 11 Invoice Protocol for Lightning Payments Encoding Overview bech32 used in segwit uri lightning: fallback bitcoin: Human-Readable Part ln bc amount multiplier m (milli): multiply by 0.001 u (micro): multiply by 0.000001 n (nano): multiply by 0.000000001 p (pico): multiply by 0.000000000001 tb testnet bcrt regtest Data Part timestamp: seconds-since-1970 (35 bits, ... zero or more tagged parts signature: Bitcoin-style signature of ab ... 512-bit secp256k1 signature of the SHA2 ... Tagged Fields (7) type (5 bits) data_length (10 bits, big-endian) data (data_length x 5 bits) d description h (52) purpose of payment n (53) public key of node r routes(5) routing information for a private route pubkey (264) short_channel (64) fee_base_msat (32) fee_base_proportional_millionths (32) bigendian cltv_expiry_delta (16) bigendian x expiry time in seconds default 3600 p (52) preimage sha256 payment_hash provides proof of payment c min_final_cltv_expiry to use for the last HTLC in the route default 9 f fallback depending on version. Fallback on-chain ... 9 feature bits (5) Feature Bits Feature bits allow forward and backward ... bigendian lsb 0 even msb 1 odd Payer / Payee Interactions These are generally defined by the rest ... Implementation lightning payencode Examples
hidelightning
BOLT 11 User Link
hideinfo
docs
leaf
BOLT 11 User Link
leaf
Glossary User Link
leaf
resources User Link
hideattach
links
leaf
mailing list User Link
leaf
github bolts User Link
leaf
lndecode User Link
leaf
min_final_cltv_expiry User Link
leafhashtag
tags
hidelightning
BOLT 11 User Link
leaf
Invoice Protocol for Lightning Payments
hidepencil
Encoding Overview
hide
bech32
leaf
used in segwit
hide
uri
hide
lightning:
leaf
fallback bitcoin:
hidemale1
Human-Readable Part
hide
ln
hide
bc
hide
amount
hide
multiplier
leaf
m (milli): multiply by 0.001
leaf
u (micro): multiply by 0.000001
leaf
n (nano): multiply by 0.000000001
leaf
p (pico): multiply by 0.000000000001
hide
tb
leaf
testnet
hide
bcrt
leaf
regtest
hideedit
Data Part
leaf
timestamp: seconds-since-1970 (35 bits, big-endian)
leaf
zero or more tagged parts
hide
signature: Bitcoin-style signature of above (520 bits)
leaf
512-bit secp256k1 signature of the SHA2 256-bit hash of the human-readable part, represented as UTF-8 bytes, concatenated with the data part (excluding the signature) with 0 bits appended to pad the data to the next byte boundary, with a trailing byte containing the recovery ID (0, 1, 2, or 3).
hidehashtag
Tagged Fields (7)
hide
type (5 bits)
hide
data_length (10 bits, big-endian)
leaf
data (data_length x 5 bits)
hide16x16-free-application-icons/png/16x16/Left-right
hide
d
leaf
description
hide
h (52)
leaf
purpose of payment
hide16x16-free-application-icons/png/16x16/Left-right
hide
n (53)
leaf
public key of node
hidelist
r
hide
routes(5)
leaf
routing information for a private route
leaf
pubkey (264)
leaf
short_channel (64)
leaf
fee_base_msat (32)
hide
fee_base_proportional_millionths (32)
leaf
bigendian
hide
cltv_expiry_delta (16)
leaf
bigendian
hide
x
hide
expiry time in seconds
leaf
default 3600
hide
p (52)
hide
preimage
hide
sha256 payment_hash
leaf
provides proof of payment
hide
c
hide
min_final_cltv_expiry
hide
to use for the last HTLC in the route
leaf
default 9
hide
f
hide
fallback
leaf

depending on version. Fallback on-chain address: for Bitcoin, this starts with a 5-bit version and contains a witness program or P2PKH or P2SH address

hidelist
9
leaf
feature bits (5)
hideidea
Feature Bits
hide
Feature bits allow forward and backward compatibility, and follow the it's ok to be odd rule.
leaf
bigendian
hide
lsb 0
leaf
even
hide
msb 1
leaf
odd
hidefema
Payer / Payee Interactions
leaf
These are generally defined by the rest of the Lightning BOLT series, but it's worth noting that BOLT #4 specifies that the payee SHOULD accept up to twice the expected amount, so the payer can make payments harder to track by adding small variations
hideexecutable
Implementation
leaf
lightning payencode User Link
hidelist
Examples
leaf
Please send $3 for a cup of coffee to the same peer, within one minute
leaf
lnbc2500u1pvjluezpp5qqqsyqcyq5rqwzqfqqqsyqcyq5rqwzqfqqqsyqcyq5rqwzqfqypqdq5xysxxatsyp3k7enxv4jsxqzpuaztrnwngzn3kdzw5hydlzf03qdgm2hdq27cqv3agm2awhz5se903vruatfhq77w3ls4evs3ch9zw97j25emudupq63nyw24cg27h2rspfj9srp User Link
leaf
Breakdown:
leaf
lnbc: prefix, Lightning on Bitcoin mainnet
leaf
2500u: amount (2500 micro-bitcoin)
leaf
1: Bech32 separator
leaf
pvjluez: timestamp (1496314658)
leaf
p: payment hash...
leaf
d: short description
leaf
q5: data_length (q = 0, 5 = 20; 0 * 32 + 20 == 20)
leaf
xysxxatsyp3k7enxv4js: '1 cup coffee'
leaf
x: expiry time
leaf
qz: data_length (q = 0, z = 2; 0 * 32 + 2 == 2)
leaf
pu: 60 seconds (p = 1, u = 28; 1 * 32 + 28 == 60)
leaf
aztrnwngzn3kdzw5hydlzf03qdgm2hdq27cqv3agm2awhz5se903vruatfhq77w3ls4evs3ch9zw97j25emudupq63nyw24cg27h2rsp: signature
leaf
fj9srp: Bech32 checksum
leaf
Signature breakdown:
leaf
e89639ba6814e36689d4b91bf125f10351b55da057b00647a8dabaeb8a90c95f160f9d5a6e0f79d1fc2b964238b944e2fa4aa677c6f020d466472ab842bd750e hex of signature data (32-byte r, 32-byte s)
leaf
1 (int) recovery flag contained in signature
leaf
6c6e626332353030750b25fe64410d00004080c1014181c20240004080c1014181c20240004080c1014181c202404081a0a189031bab81031b7b33332b2818020f00 hex of data for signing (prefix + data after separator up to the start of the signature)
leaf
3cd6ef07744040556e01be64f68fd9e1565fb47d78c42308b1ee005aca5a0d86 hex of SHA256 of the preimage
hide

Payment Info:

leaf
Network
leaf
bitcoin mainnet
leaf
Amount
leaf
0.0025 BTC
leaf
Date
leaf
Thu, 01 Jun 2017 10:57:38 GMT
leaf
Payment Hash
leaf
0001020304050607080900010203040506070809000102030405060708090102
leaf
Description
leaf
1 cup coffee
leaf
Expiration Time
leaf
60 seconds
leaf
Min Final CLTV Expiry
hide
9
leaf
Signature
leaf
R value
leaf
e89639ba6814e36689d4b91bf125f10351b55da057b00647a8dabaeb8a90c95f
leaf
S value
leaf
160f9d5a6e0f79d1fc2b964238b944e2fa4aa677c6f020d466472ab842bd750e
leaf
Recovery Flag
leaf
1
leaf
Signing Data
leaf
6c6e626332353030750b25fe64410d00004080c1014181c20240004080c1014181c20240004080c1014181c202404081a0a189031bab81031b7b33332b2818020f00
leaf
Checksum
leaf
fj9srp