Skip to content

Commit 35b597a

Browse files
committed
Add features module-level documentation for missing features
1 parent 6ce239c commit 35b597a

File tree

1 file changed

+13
-4
lines changed

1 file changed

+13
-4
lines changed

lightning/src/ln/features.rs

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -45,17 +45,25 @@
4545
//! (see [BOLT-2](https://github.com/lightning/bolts/blob/master/02-peer-protocol.md) for more information).
4646
//! - `OnionMessages` - requires/supports forwarding onion messages
4747
//! (see [BOLT-7](https://github.com/lightning/bolts/pull/759/files) for more information).
48-
//! TODO: update link
48+
// TODO: update link
4949
//! - `ChannelType` - node supports the channel_type field in open/accept
5050
//! (see [BOLT-2](https://github.com/lightning/bolts/blob/master/02-peer-protocol.md) for more information).
5151
//! - `SCIDPrivacy` - supply channel aliases for routing
5252
//! (see [BOLT-2](https://github.com/lightning/bolts/blob/master/02-peer-protocol.md) for more information).
53+
//! - `PaymentMetadata` - include additional data in invoices which is passed to recipients in the
54+
//! onion.
55+
//! (see [BOLT-11](https://github.com/lightning/bolts/blob/master/11-payment-encoding.md) for
56+
//! more).
57+
//! - `ZeroConf` - supports accepting HTLCs and using channels prior to funding confirmation
58+
//! (see
59+
//! [BOLT-2](https://github.com/lightning/bolts/blob/master/02-peer-protocol.md#the-channel_ready-message)
60+
//! for more info).
5361
//! - `Keysend` - send funds to a node without an invoice
5462
//! (see the [`Keysend` feature assignment proposal](https://github.com/lightning/bolts/issues/605#issuecomment-606679798) for more information).
5563
//! - `AnchorsZeroFeeHtlcTx` - requires/supports that commitment transactions include anchor outputs
56-
//! and HTLC transactions are pre-signed with zero fee (see
57-
//! [BOLT-3](https://github.com/lightning/bolts/blob/master/03-transactions.md) for more
58-
//! information).
64+
//! and HTLC transactions are pre-signed with zero fee (see
65+
//! [BOLT-3](https://github.com/lightning/bolts/blob/master/03-transactions.md) for more
66+
//! information).
5967
//!
6068
//! [BOLT #9]: https://github.com/lightning/bolts/blob/master/09-features.md
6169
//! [messages]: crate::ln::msgs
@@ -393,6 +401,7 @@ mod sealed {
393401
define_feature!(55, Keysend, [NodeContext],
394402
"Feature flags for keysend payments.", set_keysend_optional, set_keysend_required,
395403
supports_keysend, requires_keysend);
404+
// Note: update the module-level docs when a new feature bit is added!
396405

397406
#[cfg(test)]
398407
define_feature!(123456789, UnknownFeature,

0 commit comments

Comments
 (0)