Skip to content

BOLT 11: Copy edit#502

Merged
rustyrussell merged 6 commits intolightning:masterfrom
toadlyBroodle:copy-edit-bolt-11
Jan 7, 2019
Merged

BOLT 11: Copy edit#502
rustyrussell merged 6 commits intolightning:masterfrom
toadlyBroodle:copy-edit-bolt-11

Conversation

@toadlyBroodle
Copy link
Copy Markdown
Collaborator

  • clarify purpose of stylesheet
  • add spellchecker execution instructions to stylesheet
  • bring BOLT 11 inline with stylesheet guidelines

Whew...finally done editing all the BOLTs! Won't mess with them anymore, promise.

@toadlyBroodle toadlyBroodle changed the title BOLT11 - Copy edit BOLT 11 - Copy edit Nov 10, 2018
@toadlyBroodle toadlyBroodle changed the title BOLT 11 - Copy edit BOLT 11: Copy edit Nov 10, 2018
Copy link
Copy Markdown
Collaborator

@rustyrussell rustyrussell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor changes, only; sorry for the delay due to summit!

and MUST fail if the checksum is incorrect.
A writer:
- unless the Bech32 string MAY be longer than the 90 characters specified in BIP-0173:
- MUST encode the payment request in Bech32 (see BIP-0173).
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should read:

A writer:
   - MUST encode the payment request in Bech32 (see BIP-0173)
   - MAY exceed the 90-character limit specified in BIP-0173.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done...

- if it does not understand the `prefix`:
- MUST fail the payment.
- if the `amount` is empty:
- SHOULD indicate that amount is unspecified [FIXME: indicate where or to whom?].
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

- SHOULD indicate to the payer that amount is unspecified

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

...and done. No worries, you're a busy man!

@rustyrussell rustyrussell added this to the v1.0 milestone Nov 26, 2018
Copy link
Copy Markdown
Collaborator

@cdecker cdecker left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just some minor nits.

- MUST encode `prefix` using the currency required for successful payment.
- if a specific minimum `amount` is required for successful payment:
- MUST include that `amount`.
- MUST encode `amount` as a positive decimal integer with no leading 0s.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- MUST encode `amount` as a positive decimal integer with no leading 0s.
- MUST encode `amount` as a positive decimal integer with no leading zeoes (`0`).

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what are zeoes?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- MUST encode `amount` as a positive decimal integer with no leading 0s.
- MUST encode `amount` as a positive decimal integer with no leading zeroes.

`fee_base_msat`, `fee_proportional_millionths`, and `cltv_expiry_delta` are as
specified in [BOLT #7](07-routing-gossip.md#the-channel_update-message).
- MAY include more than one `r` field to provide multiple routing options.
- MUST pad field data to a multiple of 5 bits, using 0s.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- MUST pad field data to a multiple of 5 bits, using 0s.
- MUST pad field data to a multiple of 5 bits, using zeroes (`0`).

- MUST encode `prefix` using the currency required for successful payment.
- if a specific minimum `amount` is required for successful payment:
- MUST include that `amount`.
- MUST encode `amount` as a positive decimal integer with no leading 0s.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems we are mixing tabs and spaces here, could we make this consistent while we're here?

@rustyrussell rustyrussell merged commit 90faaed into lightning:master Jan 7, 2019
# Basic checklist/stylesheet used for copy editing BOLTs

This checklist/stylesheet is temporarily included here for reference purposes.
Contributions should comply with this checklist/stylsheet to maintain correct, clear, consistent, and concise BOLTS.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

stylsheet -> stylesheet

dple added a commit to dple/bolts that referenced this pull request Apr 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants