2016-11-15 02:23:20 +01:00
# BOLT #0: Introduction and Index
copy-edit 00-introduction for appropriate grammer, punctuation, and style
Edit 00-introduction copy for clarity (minor rephrasing, punctuation),
correctness (grammar, capitalization, punctuation),
consision (minimizing wordiness, redundancy),
and consistency (document style, e.g. 1 space between sentences,
capitalization of headers, etc.)
2017-11-04 16:53:23 +01:00
Welcome, friend! These Basis of Lightning Technology (BOLT) documents
2017-11-18 21:00:36 +01:00
describe a layer-2 protocol for off-chain bitcoin transfer by mutual
2016-11-15 02:23:20 +01:00
cooperation, relying on on-chain transactions for enforcement if
necessary.
Some requirements are subtle; we have tried to highlight motivations
copy-edit 00-introduction for appropriate grammer, punctuation, and style
Edit 00-introduction copy for clarity (minor rephrasing, punctuation),
correctness (grammar, capitalization, punctuation),
consision (minimizing wordiness, redundancy),
and consistency (document style, e.g. 1 space between sentences,
capitalization of headers, etc.)
2017-11-04 16:53:23 +01:00
and reasoning behind the results you see here. I'm sure we've fallen
2017-11-22 20:13:31 +01:00
short; if you find any part confusing or wrong, please contact us and
2016-11-15 02:23:20 +01:00
help us improve.
This is version 0.
2016-12-04 01:06:34 +01:00
1. [BOLT #1 ](01-messaging.md ): Base Protocol
2016-11-15 02:23:20 +01:00
2. [BOLT #2 ](02-peer-protocol.md ): Peer Protocol for Channel Management
3. [BOLT #3 ](03-transactions.md ): Bitcoin Transaction and Script Formats
4. [BOLT #4 ](04-onion-routing.md ): Onion Routing Protocol
5. [BOLT #5 ](05-onchain.md ): Recommendations for On-chain Transaction Handling
2016-12-04 00:53:08 +01:00
7. [BOLT #7 ](07-routing-gossip.md ): P2P Node and Channel Discovery
8. [BOLT #8 ](08-transport.md ): Encrypted and Authenticated Transport
2017-02-07 01:53:39 +01:00
9. [BOLT #9 ](09-features.md ): Assigned Feature Flags
2017-08-22 02:02:57 +02:00
10. [BOLT #10 ](10-dns-bootstrap.md ): DNS Bootstrap and Assisted Node Location
2017-06-27 12:38:13 +02:00
11. [BOLT #11 ](11-payment-encoding.md ): Invoice Protocol for Lightning Payments
2016-11-15 02:23:20 +01:00
## Glossary and Terminology Guide
Massive Changes to Glossary
This is a big change to the glossary in BOLT-0.
The overarcing changes are:
1.) Reorganized glossary to be alphabetical
2.) Add copious "See also:" lines to cross-reference containers, contents, and other related entries.
*Changed Definitions:* Peer and node were revised based in on discussions with Rusty; commitment revocation secret key was changed to be commitment revocation private key based on #377.
*New Definitions:* New words added based on their usage in the bolts were: announcement, closing transaction, final node, hop, origin node, processing, node, receiving node, receiving peer, revoked commitment transaction, sending node, sending peer.
(I suspect the reorg will make the diffs almost useless, so this is the list of stuff to look at.)
2018-02-10 00:17:24 +01:00
* *Announcement*:
* A gossip message sent between *peers* intended to aid the discovery of a *channel* or a *node* .
2017-11-22 20:13:31 +01:00
Massive Changes to Glossary
This is a big change to the glossary in BOLT-0.
The overarcing changes are:
1.) Reorganized glossary to be alphabetical
2.) Add copious "See also:" lines to cross-reference containers, contents, and other related entries.
*Changed Definitions:* Peer and node were revised based in on discussions with Rusty; commitment revocation secret key was changed to be commitment revocation private key based on #377.
*New Definitions:* New words added based on their usage in the bolts were: announcement, closing transaction, final node, hop, origin node, processing, node, receiving node, receiving peer, revoked commitment transaction, sending node, sending peer.
(I suspect the reorg will make the diffs almost useless, so this is the list of stuff to look at.)
2018-02-10 00:17:24 +01:00
* `chain_hash` :
2018-03-03 01:29:55 +01:00
* The uniquely identifying hash of the target blockchain (usually the genesis hash).
This allows *nodes* to create and reference *channels* on
Massive Changes to Glossary
This is a big change to the glossary in BOLT-0.
The overarcing changes are:
1.) Reorganized glossary to be alphabetical
2.) Add copious "See also:" lines to cross-reference containers, contents, and other related entries.
*Changed Definitions:* Peer and node were revised based in on discussions with Rusty; commitment revocation secret key was changed to be commitment revocation private key based on #377.
*New Definitions:* New words added based on their usage in the bolts were: announcement, closing transaction, final node, hop, origin node, processing, node, receiving node, receiving peer, revoked commitment transaction, sending node, sending peer.
(I suspect the reorg will make the diffs almost useless, so this is the list of stuff to look at.)
2018-02-10 00:17:24 +01:00
several blockchains. Nodes are to ignore any messages that reference a
`chain_hash` that are unknown to them. Unlike `bitcoin-cli` , the hash is
not reversed but is used directly.
2017-11-22 20:13:31 +01:00
Massive Changes to Glossary
This is a big change to the glossary in BOLT-0.
The overarcing changes are:
1.) Reorganized glossary to be alphabetical
2.) Add copious "See also:" lines to cross-reference containers, contents, and other related entries.
*Changed Definitions:* Peer and node were revised based in on discussions with Rusty; commitment revocation secret key was changed to be commitment revocation private key based on #377.
*New Definitions:* New words added based on their usage in the bolts were: announcement, closing transaction, final node, hop, origin node, processing, node, receiving node, receiving peer, revoked commitment transaction, sending node, sending peer.
(I suspect the reorg will make the diffs almost useless, so this is the list of stuff to look at.)
2018-02-10 00:17:24 +01:00
For the main chain Bitcoin blockchain, the `chain_hash` value MUST be
(encoded in hex):
`6fe28c0ab6f1b372c1a6a246ae63f74f931e8365e15a089c68d6190000000000` .
2016-11-15 02:23:20 +01:00
* *Channel*:
2017-11-15 11:55:16 +01:00
* A fast, off-chain method of mutual exchange between two *peers* .
2017-11-22 20:13:31 +01:00
To transact funds, peers exchange signatures to create an updated *commitment transaction* .
2018-03-03 01:29:55 +01:00
* _See closure methods: mutual close, revoked transaction close, unilateral close_
Massive Changes to Glossary
This is a big change to the glossary in BOLT-0.
The overarcing changes are:
1.) Reorganized glossary to be alphabetical
2.) Add copious "See also:" lines to cross-reference containers, contents, and other related entries.
*Changed Definitions:* Peer and node were revised based in on discussions with Rusty; commitment revocation secret key was changed to be commitment revocation private key based on #377.
*New Definitions:* New words added based on their usage in the bolts were: announcement, closing transaction, final node, hop, origin node, processing, node, receiving node, receiving peer, revoked commitment transaction, sending node, sending peer.
(I suspect the reorg will make the diffs almost useless, so this is the list of stuff to look at.)
2018-02-10 00:17:24 +01:00
* *Closing transaction*:
* A transaction generated as part of a _mutual close_ . A closing transaction is similar to a _commitment transaction_ , but with no pending payments.
* _See related: commitment transaction, funding transaction, penalty transaction_
* *Commitment number*:
* A 48-bit incrementing counter for each *commitment transaction* ; counters
are independent for each *peer* in the *channel* and start at 0.
* _See container: commitment transaction_
* _See related: closing transaction, funding transaction, penalty transaction_
* *Commitment revocation private key*:
* Every *commitment transaction* has a unique commitment revocation private-key
value that allows the other *peer* to spend all outputs
immediately: revealing this key is how old commitment
transactions are revoked. To support revocation, each output of the
commitment transaction refers to the commitment revocation public key.
* _See container: commitment transaction_
* _See originator: per-commitment secret_
2016-11-15 02:23:20 +01:00
copy-edit 00-introduction for appropriate grammer, punctuation, and style
Edit 00-introduction copy for clarity (minor rephrasing, punctuation),
correctness (grammar, capitalization, punctuation),
consision (minimizing wordiness, redundancy),
and consistency (document style, e.g. 1 space between sentences,
capitalization of headers, etc.)
2017-11-04 16:53:23 +01:00
* *Commitment transaction*:
2017-11-22 20:13:31 +01:00
* A transaction that spends the *funding transaction* .
Each *peer* holds the other peer's signature for this transaction, so that each
always has a commitment transaction that it can spend. After a new
2017-11-10 03:32:52 +01:00
commitment transaction is negotiated, the old one is *revoked* .
Massive Changes to Glossary
This is a big change to the glossary in BOLT-0.
The overarcing changes are:
1.) Reorganized glossary to be alphabetical
2.) Add copious "See also:" lines to cross-reference containers, contents, and other related entries.
*Changed Definitions:* Peer and node were revised based in on discussions with Rusty; commitment revocation secret key was changed to be commitment revocation private key based on #377.
*New Definitions:* New words added based on their usage in the bolts were: announcement, closing transaction, final node, hop, origin node, processing, node, receiving node, receiving peer, revoked commitment transaction, sending node, sending peer.
(I suspect the reorg will make the diffs almost useless, so this is the list of stuff to look at.)
2018-02-10 00:17:24 +01:00
* _See parts: commitment number, commitment revocation private key, HTLC, per-commitment secret_
* _See related: closing transaction, funding transaction, penalty transaction_
* _See types: revoked commitment transaction_
* *Final node*:
* The final recipient of a packet that is routing a payment from an _origin node_ through some number of _hops_ . It is also the final *receiving peer* in a chain.
* _See category: node_
* _See related: origin node, processing node_
* *Funding transaction*:
* An irreversible on-chain transaction that pays to both *peers* on a *channel* .
It can only be spent by mutual consent.
* _See related: closing transaction, commitment transaction, penalty transaction_
* *Hop*:
2018-03-03 01:29:55 +01:00
* A *node* . Generally, an intermediate node lying between an *origin node* and a *final node* .
Massive Changes to Glossary
This is a big change to the glossary in BOLT-0.
The overarcing changes are:
1.) Reorganized glossary to be alphabetical
2.) Add copious "See also:" lines to cross-reference containers, contents, and other related entries.
*Changed Definitions:* Peer and node were revised based in on discussions with Rusty; commitment revocation secret key was changed to be commitment revocation private key based on #377.
*New Definitions:* New words added based on their usage in the bolts were: announcement, closing transaction, final node, hop, origin node, processing, node, receiving node, receiving peer, revoked commitment transaction, sending node, sending peer.
(I suspect the reorg will make the diffs almost useless, so this is the list of stuff to look at.)
2018-02-10 00:17:24 +01:00
* _See category: node_
2016-11-15 02:23:20 +01:00
* *HTLC*: Hashed Time Locked Contract.
2017-11-22 20:13:31 +01:00
* A conditional payment between two *peers* : the recipient can spend
2017-11-10 03:32:52 +01:00
the payment by presenting its signature and a *payment preimage* ,
otherwise the payer can cancel the contract by spending it after
a given time. These are implemented as outputs from the
*commitment transaction* .
Massive Changes to Glossary
This is a big change to the glossary in BOLT-0.
The overarcing changes are:
1.) Reorganized glossary to be alphabetical
2.) Add copious "See also:" lines to cross-reference containers, contents, and other related entries.
*Changed Definitions:* Peer and node were revised based in on discussions with Rusty; commitment revocation secret key was changed to be commitment revocation private key based on #377.
*New Definitions:* New words added based on their usage in the bolts were: announcement, closing transaction, final node, hop, origin node, processing, node, receiving node, receiving peer, revoked commitment transaction, sending node, sending peer.
(I suspect the reorg will make the diffs almost useless, so this is the list of stuff to look at.)
2018-02-10 00:17:24 +01:00
* _See container: commitment transaction_
* _See parts: Payment hash, Payment preimage_
* *It's ok to be odd*:
* A rule applied to some numeric fields that indicates either optional or
compulsory support for features. Even numbers indicate that both endpoints
MUST support the feature in question, while odd numbers indicate
that the feature MAY be disregarded by the other endpoint.
* *MSAT*:
* A millisatoshi, often used as a field name.
* *Mutual close*:
* A cooperative close of a *channel* , accomplished by broadcasting an unconditional
spend of the *funding transaction* with an output to each *peer*
(unless one output is too small, and thus is not included).
* _See related: revoked transaction close, unilateral close__
* *Node*:
* A computer or other device that is part of the Lightning network.
* _See related: peers_
* _See types: final node, hop, origin node, processing node, receiving node, sending node_
* *Origin node*:
* The _node_ that originates a packet that will route a payment through some number of _hops_ to a _final node_ . It is also the first _sending peer_ in a chain.
* _See category: node_
* _See related: final node, processing node_
2016-11-15 02:23:20 +01:00
2017-11-22 20:13:31 +01:00
* *Payment hash*:
* The *HTLC* contains the payment hash, which is the hash of the
2017-12-16 07:50:30 +01:00
*payment preimage* .
Massive Changes to Glossary
This is a big change to the glossary in BOLT-0.
The overarcing changes are:
1.) Reorganized glossary to be alphabetical
2.) Add copious "See also:" lines to cross-reference containers, contents, and other related entries.
*Changed Definitions:* Peer and node were revised based in on discussions with Rusty; commitment revocation secret key was changed to be commitment revocation private key based on #377.
*New Definitions:* New words added based on their usage in the bolts were: announcement, closing transaction, final node, hop, origin node, processing, node, receiving node, receiving peer, revoked commitment transaction, sending node, sending peer.
(I suspect the reorg will make the diffs almost useless, so this is the list of stuff to look at.)
2018-02-10 00:17:24 +01:00
* _See container: HTLC_
* _See originator: payment preimage_
2017-11-22 20:13:31 +01:00
2017-12-16 07:50:30 +01:00
* *Payment preimage*:
2017-11-22 20:13:31 +01:00
* Proof that payment has been received, held by
the final recipient, who is the only person who knows this
secret. The final recipient releases the preimage in order to
2017-11-27 23:32:02 +01:00
release funds. The payment preimage is hashed as the *payment hash*
2017-11-22 20:13:31 +01:00
in the *HTLC* .
Massive Changes to Glossary
This is a big change to the glossary in BOLT-0.
The overarcing changes are:
1.) Reorganized glossary to be alphabetical
2.) Add copious "See also:" lines to cross-reference containers, contents, and other related entries.
*Changed Definitions:* Peer and node were revised based in on discussions with Rusty; commitment revocation secret key was changed to be commitment revocation private key based on #377.
*New Definitions:* New words added based on their usage in the bolts were: announcement, closing transaction, final node, hop, origin node, processing, node, receiving node, receiving peer, revoked commitment transaction, sending node, sending peer.
(I suspect the reorg will make the diffs almost useless, so this is the list of stuff to look at.)
2018-02-10 00:17:24 +01:00
* _See container: HTLC_
* _See derivation: payment hash_
2016-11-15 02:23:20 +01:00
Massive Changes to Glossary
This is a big change to the glossary in BOLT-0.
The overarcing changes are:
1.) Reorganized glossary to be alphabetical
2.) Add copious "See also:" lines to cross-reference containers, contents, and other related entries.
*Changed Definitions:* Peer and node were revised based in on discussions with Rusty; commitment revocation secret key was changed to be commitment revocation private key based on #377.
*New Definitions:* New words added based on their usage in the bolts were: announcement, closing transaction, final node, hop, origin node, processing, node, receiving node, receiving peer, revoked commitment transaction, sending node, sending peer.
(I suspect the reorg will make the diffs almost useless, so this is the list of stuff to look at.)
2018-02-10 00:17:24 +01:00
* *Peers*:
* Two *nodes* that are in communication with each other.
* Two peers may gossip with each other prior to setting up a channel.
* Two peers may establish a *channel* through which they transact.
* _See related: node_
* *Penalty transaction*:
* A transaction that spends all outputs of a *revoked commitment
transaction*, using the *commitment revocation private key* . A *peer* uses this
if the other peer tries to "cheat" by broadcasting a *revoked
commitment transaction*.
* _See related: closing transaction, commitment transaction, funding transaction_
2016-11-15 02:23:20 +01:00
* *Per-commitment secret*:
2017-11-22 20:13:31 +01:00
* Every *commitment transaction* derives its keys from a per-commitment secret,
2016-11-15 02:23:20 +01:00
which is generated such that the series of per-commitment secrets
2017-01-08 16:43:38 +01:00
for all previous commitments can be stored compactly.
Massive Changes to Glossary
This is a big change to the glossary in BOLT-0.
The overarcing changes are:
1.) Reorganized glossary to be alphabetical
2.) Add copious "See also:" lines to cross-reference containers, contents, and other related entries.
*Changed Definitions:* Peer and node were revised based in on discussions with Rusty; commitment revocation secret key was changed to be commitment revocation private key based on #377.
*New Definitions:* New words added based on their usage in the bolts were: announcement, closing transaction, final node, hop, origin node, processing, node, receiving node, receiving peer, revoked commitment transaction, sending node, sending peer.
(I suspect the reorg will make the diffs almost useless, so this is the list of stuff to look at.)
2018-02-10 00:17:24 +01:00
* _See container: commitment transaction_
* _See derivation: commitment revocation private key_
* *Processing node*:
* A *node* that is processing a packet that originated with an *origin node* and that is being sent toward a *final node* in order to route a payment. It acts as a _receiving peer_ to receive the message, then a _sending peer_ to send on the packet.
* _See category: node_
* _See related: final node, origin node_
* *Receiving node*:
* A *node* that is receiving a message.
* _See category: node_
* _See related: sending node_
* *Receiving peer*:
* A *node* that is receiving a message from a directly connected *peer* .
* _See category: peer_
* _See related: sending peer_
* *Revoked commitment transaction*:
* An old *commitment transaction* that has been revoked because a new commitment transaction has been negotiated.
* _See category: commitment transaction_
* *Revoked transaction close*:
* An invalid close of a *channel* , accomplished by broadcasting a *revoked
commitment transaction*. Since the other *peer* knows the
*commitment revocation secret key* , it can create a *penalty transaction* .
2018-03-03 01:29:55 +01:00
* _See related: mutual close, unilateral close_
2016-11-15 02:23:20 +01:00
Massive Changes to Glossary
This is a big change to the glossary in BOLT-0.
The overarcing changes are:
1.) Reorganized glossary to be alphabetical
2.) Add copious "See also:" lines to cross-reference containers, contents, and other related entries.
*Changed Definitions:* Peer and node were revised based in on discussions with Rusty; commitment revocation secret key was changed to be commitment revocation private key based on #377.
*New Definitions:* New words added based on their usage in the bolts were: announcement, closing transaction, final node, hop, origin node, processing, node, receiving node, receiving peer, revoked commitment transaction, sending node, sending peer.
(I suspect the reorg will make the diffs almost useless, so this is the list of stuff to look at.)
2018-02-10 00:17:24 +01:00
* *Sending node*:
* A *node* that is sending a message.
* _See category: node_
* _See related: receiving node_
* *Sending peer*:
* A *node* that is sending a message to a directly connected *peer* .
* _See category: peer_
* _See related: receiving peer_.
2016-11-15 02:23:20 +01:00
copy-edit 00-introduction for appropriate grammer, punctuation, and style
Edit 00-introduction copy for clarity (minor rephrasing, punctuation),
correctness (grammar, capitalization, punctuation),
consision (minimizing wordiness, redundancy),
and consistency (document style, e.g. 1 space between sentences,
capitalization of headers, etc.)
2017-11-04 16:53:23 +01:00
* *Unilateral close*:
2017-11-22 20:13:31 +01:00
* An uncooperative close of a *channel* , accomplished by broadcasting a
2017-11-10 03:32:52 +01:00
*commitment transaction* . This transaction is larger (i.e. less
Massive Changes to Glossary
This is a big change to the glossary in BOLT-0.
The overarcing changes are:
1.) Reorganized glossary to be alphabetical
2.) Add copious "See also:" lines to cross-reference containers, contents, and other related entries.
*Changed Definitions:* Peer and node were revised based in on discussions with Rusty; commitment revocation secret key was changed to be commitment revocation private key based on #377.
*New Definitions:* New words added based on their usage in the bolts were: announcement, closing transaction, final node, hop, origin node, processing, node, receiving node, receiving peer, revoked commitment transaction, sending node, sending peer.
(I suspect the reorg will make the diffs almost useless, so this is the list of stuff to look at.)
2018-02-10 00:17:24 +01:00
efficient) than a *mutual close transaction* , and the *peer* whose
2017-11-10 03:32:52 +01:00
commitment is broadcast cannot access its own outputs for some
previously-negotiated duration.
Massive Changes to Glossary
This is a big change to the glossary in BOLT-0.
The overarcing changes are:
1.) Reorganized glossary to be alphabetical
2.) Add copious "See also:" lines to cross-reference containers, contents, and other related entries.
*Changed Definitions:* Peer and node were revised based in on discussions with Rusty; commitment revocation secret key was changed to be commitment revocation private key based on #377.
*New Definitions:* New words added based on their usage in the bolts were: announcement, closing transaction, final node, hop, origin node, processing, node, receiving node, receiving peer, revoked commitment transaction, sending node, sending peer.
(I suspect the reorg will make the diffs almost useless, so this is the list of stuff to look at.)
2018-02-10 00:17:24 +01:00
* _See related: mutual close, revoked transaction close_
2017-07-24 21:44:14 +02:00
2016-11-15 02:23:20 +01:00
## Theme Song
Why this network could be democratic...
Numismatic...
Cryptographic!
Why it could be released Lightning!
(Release Lightning!)
We'll have some timelocked contracts with hashed pubkeys, oh yeah.
(Keep talking, whoa keep talkin')
We'll segregate the witness for trustless starts, oh yeah.
(I'll get the money, I've got to get the money)
With dynamic onion routes, they'll be shakin' in their boots;
You know that's just the truth, we'll be scaling through the roof.
Release Lightning!
(Go, go, go, go; go, go, go, go, go, go)
[Chorus:]
Oh released Lightning, it's better than a debit card..
(Release Lightning, go release Lightning!)
With released Lightning, micropayments just ain't hard...
(Release Lightning, go release Lightning!)
Then kaboom: we'll hit the moon -- release Lightning!
(Go, go, go, go; go, go, go, go, go, go)
We'll have QR codes, and smartphone apps, oh yeah.
(Ooo ooo ooo ooo ooo ooo ooo)
P2P messaging, and passive incomes, oh yeah.
(Ooo ooo ooo ooo ooo ooo ooo)
Outsourced closure watch, gives me feelings in my crotch.
You'll know it's not a brag when the repo gets a tag:
Released Lightning.
[Chorus]
[Instrumental, ~1m10s]
[Chorus]
(Lightning! Lightning! Lightning! Lightning!
Lightning! Lightning! Lightning! Lightning!)
C'mon guys, let's get to work!
-- Anthony Towns < aj @ erisian . com . au >
## Authors
[ FIXME: Insert Author List ]
2016-11-22 20:52:59 +01:00
![Creative Commons License ](https://i.creativecommons.org/l/by/4.0/88x31.png "License CC-BY" )
< br >
This work is licensed under a [Creative Commons Attribution 4.0 International License ](http://creativecommons.org/licenses/by/4.0/ ).