BOLT-11 Edits by shannona · Pull Request #329 · lightning/bolts

shannona · 2017-12-16T00:37:24Z

More line editing and clarifications, also includes typo-fix from @dimitris-t in #306 and table of contents from @bcongdon in #310.

@dimitris-t

More line editing and clarifications, also includes typo-fix from @dimitris-t in #306 and table of contents from @bcongdon in #310.

rustyrussell · 2017-12-18T19:19:15Z

11-payment-encoding.md

-* `f` (9): `data_length` variable, depending on version. Fallback on-chain address: for bitcoin, this starts with a 5 bit `version`; a witness program or P2PKH or P2SH address.
-* `r` (3): `data_length` variable.  One or more entries containing extra routing information for a private route; there may be more than one `r` field, too.
+* `f` (9): `data_length` variable, 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.
+* `r` (3): `data_length` variable. one or more entries containing extra routing information for a private route; there may be more than one `r` field


lower-casing after the period seems weird; is that a thing?

No, probably not.

rustyrussell · 2017-12-18T19:24:29Z

You will also need to add "bitcoins" to the wordlist in .aspell.en.pws. It's case-sensitive.

toadlyBroodle

I think that changing the '.' separators to ':' or ';' in the equation examples within parenthesis would make them clearer. But I can do this when I do my edit also.

toadlyBroodle · 2017-12-18T21:05:38Z

11-payment-encoding.md

 1. `timestamp`: seconds-since-1970 (35 bits, big-endian)
-1. Zero or more tagged parts.
-1. `signature`: bitcoin-style signature of above. (520 bits)
+1. Zero or more tagged parts


toadlyBroodle · 2017-12-18T21:07:07Z

11-payment-encoding.md

+    * [Requirements](#requirements)
+  * [Human-Readable Part](#human-readable-part)
+    * [Requirements](#requirements-1)
+    * [Rationale](#rationale)


ToC sections for other BOLTs do not include 'Requirements' and 'Rationale' sections

toadlyBroodle · 2017-12-18T21:09:24Z

11-payment-encoding.md

-standard actually supports hashing in bit boundaries, it's not widely
-implemented.  The recovery ID allows public key recovery, so the
+`signature` covers an exact number of bytes even though the SHA-2
+standard actually supports hashing in bit boundaries because it's not widely


...boundaries, because...

toadlyBroodle · 2017-12-18T21:11:58Z

11-payment-encoding.md

-* `h` (23): `data_length` 52.  256-bit description of purpose of payment (SHA256).  This is used to commit to an associated description which is too long to fit, such as may be contained in a web page.
-* `x` (6): `data_length` variable.  `expiry` time in seconds (big-endian). Default is 3600 (1 hour) if not specified.
+* `p` (1): `data_length` 52. 256-bit SHA256 payment_hash. Preimage of this provides proof of payment
+* `d` (13): `data_length` variable. short description of purpose of payment (ASCII),  e.g. '1 cup of coffee'


...variable. Short...

toadlyBroodle · 2017-12-18T21:13:06Z

11-payment-encoding.md

-field to identify the channel, `fee_base_msat`, `fee_proportional_millionths` and `cltv_expiry_delta` are as specified in [BOLT #7](07-routing-gossip.md#the-channel_update-message).  A writer MAY include more than one `r` field to
+public node to the final destination. For each entry, the `pubkey` is the
+node ID of the start of the channel; `short_channel_id` is the short channel ID
+field to identify the channel; and `fee_base_msat`, `fee_proportional_millionths` and `cltv_expiry_delta` are as specified in [BOLT #7](07-routing-gossip.md#the-channel_update-message). A writer MAY include more than one `r` field to


...fee_proportional_millionths, and...

toadlyBroodle · 2017-12-18T21:17:54Z

11-payment-encoding.md

 * `x`: expiry time
  * `qz`: `data_length` (`q` = 0, `z` = 2. 0 * 32 + 2 == 2)
-  * `pu`: 60 seconds (`p` = 1, `u` = 28.  1 * 32 + 28 == 60)
+  * `pu`: 60 seconds (`p` = 1, `u` = 28. 1 * 32 + 28 == 60)


...28; 1... use semicolon or colon instead of period?

think you're right; that's more readable. Changing throughout.

toadlyBroodle · 2017-12-18T21:19:01Z

11-payment-encoding.md

 * `r`: tagged field: route information
-  * `9y`: `data_length` (`9` = 5, `y` = 4.  5 * 32 + 4 = 164)
-    `q20q82gphp2nflc7jtzrcazrra7wwgzxqc8u7754cdlpfrmccae92qgzqvzq2ps8pqqqqqqqqqqqq9qqqvpeuqafqxu92d8lr6fvg0r5gv0heeeqgcrqlnm6jhphu9y00rrhy4grqszsvpcgpy9qqqqqqqqqqqq7qqzq`: pubkey `029e03a901b85534ff1e92c43c74431f7ce72046060fcf7a95c37e148f78c77255`, `short_channel_id` 0102030405060708, `fee_base_msat` 1 millisatoshi, `fee_proportional_millionths` 20, `cltv_expiry_delta` 3.  pubkey `039e03a901b85534ff1e92c43c74431f7ce72046060fcf7a95c37e148f78c77255`, `short_channel_id` 030405060708090a, `fee_base_msat` 2 millisatoshi, `fee_proportional_millionths` 30, `cltv_expiry_delta` 4.
+  * `9y`: `data_length` (`9` = 5, `y` = 4. 5 * 32 + 4 = 164)


use semicolon or colon seperator instead of period?

Including some large-scale changes of punctuation in examples.

shannona · 2017-12-20T00:08:30Z

Review fixes should now all be in place now. @toadlyBroodle I went ahead and adjusted all the equations, as you suggested.

toadlyBroodle

Nice one! I've already added 'bitcoins' to spell check list in one of my latest pull requests, so no need to do it again here.

BOLT-11 Edits

46d49ab

More line editing and clarifications, also includes typo-fix from @dimitris-t in #306 and table of contents from @bcongdon in #310.

rustyrussell requested a review from toadlyBroodle December 18, 2017 19:15

rustyrussell approved these changes Dec 18, 2017

View reviewed changes

toadlyBroodle reviewed Dec 18, 2017

View reviewed changes

Adjustments per reviews

588b8d2

Including some large-scale changes of punctuation in examples.

toadlyBroodle approved these changes Dec 20, 2017

View reviewed changes

rustyrussell merged commit ff2d872 into lightning:master Dec 20, 2017

Conversation

shannona commented Dec 16, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rustyrussell commented Dec 18, 2017

Uh oh!

toadlyBroodle left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

shannona commented Dec 20, 2017

Uh oh!

toadlyBroodle left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

toadlyBroodle left a comment •

edited

Loading