Skip to content

Commit 899d5f5

Browse files
committed
Add dual-funding spec links
1 parent 8da30df commit 899d5f5

File tree

1 file changed

+26
-26
lines changed

1 file changed

+26
-26
lines changed

lightning/src/ln/msgs.rs

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -183,10 +183,10 @@ pub struct Pong {
183183
pub byteslen: u16,
184184
}
185185

186-
/// Contains fields that are both common to [`open_channel`] and `open_channel2` messages.
186+
/// Contains fields that are both common to [`open_channel`] and [`open_channel2`] messages.
187187
///
188188
/// [`open_channel`]: https://github.com/lightning/bolts/blob/master/02-peer-protocol.md#the-open_channel-message
189-
// TODO(dual_funding): Add spec link for `open_channel2`.
189+
/// [`open_channel2`]: https://github.com/lightning/bolts/blob/master/02-peer-protocol.md#the-open_channel2-message
190190
#[derive(Clone, Debug, Hash, PartialEq, Eq)]
191191
pub struct CommonOpenChannelFields {
192192
/// The genesis hash of the blockchain where the channel is to be opened
@@ -288,11 +288,11 @@ pub struct OpenChannel {
288288
pub channel_reserve_satoshis: u64,
289289
}
290290

291-
/// An open_channel2 message to be sent by or received from the channel initiator.
291+
/// An [`open_channel2`] message to be sent by or received from the channel initiator.
292292
///
293293
/// Used in V2 channel establishment
294294
///
295-
// TODO(dual_funding): Add spec link for `open_channel2`.
295+
/// [`open_channel2`]: https://github.com/lightning/bolts/blob/master/02-peer-protocol.md#the-open_channel2-message
296296
#[derive(Clone, Debug, Hash, PartialEq, Eq)]
297297
pub struct OpenChannelV2 {
298298
/// Common fields of `open_channel(2)`-like messages
@@ -307,10 +307,10 @@ pub struct OpenChannelV2 {
307307
pub require_confirmed_inputs: Option<()>,
308308
}
309309

310-
/// Contains fields that are both common to [`accept_channel`] and `accept_channel2` messages.
310+
/// Contains fields that are both common to [`accept_channel`] and [`accept_channel2`] messages.
311311
///
312312
/// [`accept_channel`]: https://github.com/lightning/bolts/blob/master/02-peer-protocol.md#the-accept_channel-message
313-
// TODO(dual_funding): Add spec link for `accept_channel2`.
313+
/// [`accept_channel2`]: https://github.com/lightning/bolts/blob/master/02-peer-protocol.md#the-accept_channel2-message
314314
#[derive(Clone, Debug, Hash, PartialEq, Eq)]
315315
pub struct CommonAcceptChannelFields {
316316
/// The same `temporary_channel_id` received from the initiator's `open_channel2` or `open_channel` message.
@@ -370,11 +370,11 @@ pub struct AcceptChannel {
370370
pub next_local_nonce: Option<musig2::types::PublicNonce>,
371371
}
372372

373-
/// An accept_channel2 message to be sent by or received from the channel accepter.
373+
/// An [`accept_channel2`] message to be sent by or received from the channel accepter.
374374
///
375375
/// Used in V2 channel establishment
376376
///
377-
// TODO(dual_funding): Add spec link for `accept_channel2`.
377+
/// [`accept_channel2`]: https://github.com/lightning/bolts/blob/master/02-peer-protocol.md#the-accept_channel2-message
378378
#[derive(Clone, Debug, Hash, PartialEq, Eq)]
379379
pub struct AcceptChannelV2 {
380380
/// Common fields of `accept_channel(2)`-like messages
@@ -504,9 +504,9 @@ pub struct SpliceLocked {
504504
pub splice_txid: Txid,
505505
}
506506

507-
/// A tx_add_input message for adding an input during interactive transaction construction
507+
/// A [`tx_add_input`] message for adding an input during interactive transaction construction
508508
///
509-
// TODO(dual_funding): Add spec link for `tx_add_input`.
509+
/// [`tx_add_input`]: https://github.com/lightning/bolts/blob/master/02-peer-protocol.md#the-tx_add_input-message
510510
#[derive(Clone, Debug, Hash, PartialEq, Eq)]
511511
pub struct TxAddInput {
512512
/// The channel ID
@@ -525,9 +525,9 @@ pub struct TxAddInput {
525525
pub shared_input_txid: Option<Txid>,
526526
}
527527

528-
/// A tx_add_output message for adding an output during interactive transaction construction.
528+
/// A [`tx_add_output`] message for adding an output during interactive transaction construction.
529529
///
530-
// TODO(dual_funding): Add spec link for `tx_add_output`.
530+
/// [`tx_add_output`]: https://github.com/lightning/bolts/blob/master/02-peer-protocol.md#the-tx_add_output-message
531531
#[derive(Clone, Debug, Hash, PartialEq, Eq)]
532532
pub struct TxAddOutput {
533533
/// The channel ID
@@ -541,9 +541,9 @@ pub struct TxAddOutput {
541541
pub script: ScriptBuf,
542542
}
543543

544-
/// A tx_remove_input message for removing an input during interactive transaction construction.
544+
/// A [`tx_remove_input`] message for removing an input during interactive transaction construction.
545545
///
546-
// TODO(dual_funding): Add spec link for `tx_remove_input`.
546+
/// [`tx_remove_input`]: https://github.com/lightning/bolts/blob/master/02-peer-protocol.md#the-tx_remove_input-and-tx_remove_output-messages
547547
#[derive(Clone, Debug, Hash, PartialEq, Eq)]
548548
pub struct TxRemoveInput {
549549
/// The channel ID
@@ -552,9 +552,9 @@ pub struct TxRemoveInput {
552552
pub serial_id: SerialId,
553553
}
554554

555-
/// A tx_remove_output message for removing an output during interactive transaction construction.
555+
/// A [`tx_remove_output`] message for removing an output during interactive transaction construction.
556556
///
557-
// TODO(dual_funding): Add spec link for `tx_remove_output`.
557+
/// [`tx_remove_output`]: https://github.com/lightning/bolts/blob/master/02-peer-protocol.md#the-tx_remove_input-and-tx_remove_output-messages
558558
#[derive(Clone, Debug, Hash, PartialEq, Eq)]
559559
pub struct TxRemoveOutput {
560560
/// The channel ID
@@ -563,20 +563,20 @@ pub struct TxRemoveOutput {
563563
pub serial_id: SerialId,
564564
}
565565

566-
/// A tx_complete message signalling the conclusion of a peer's transaction contributions during
566+
/// [`A tx_complete`] message signalling the conclusion of a peer's transaction contributions during
567567
/// interactive transaction construction.
568568
///
569-
// TODO(dual_funding): Add spec link for `tx_complete`.
569+
/// [`tx_complete`]: https://github.com/lightning/bolts/blob/master/02-peer-protocol.md#the-tx_complete-message
570570
#[derive(Clone, Debug, Hash, PartialEq, Eq)]
571571
pub struct TxComplete {
572572
/// The channel ID
573573
pub channel_id: ChannelId,
574574
}
575575

576-
/// A tx_signatures message containing the sender's signatures for a transaction constructed with
576+
/// A [`tx_signatures`] message containing the sender's signatures for a transaction constructed with
577577
/// interactive transaction construction.
578578
///
579-
// TODO(dual_funding): Add spec link for `tx_signatures`.
579+
/// [`tx_signatures`]: https://github.com/lightning/bolts/blob/master/02-peer-protocol.md#the-tx_signatures-message
580580
#[derive(Clone, Debug, Hash, PartialEq, Eq)]
581581
pub struct TxSignatures {
582582
/// The channel ID
@@ -589,10 +589,10 @@ pub struct TxSignatures {
589589
pub shared_input_signature: Option<Signature>,
590590
}
591591

592-
/// A tx_init_rbf message which initiates a replacement of the transaction after it's been
592+
/// A [`tx_init_rbf`] message which initiates a replacement of the transaction after it's been
593593
/// completed.
594594
///
595-
// TODO(dual_funding): Add spec link for `tx_init_rbf`.
595+
/// [`tx_init_rbf`]: https://github.com/lightning/bolts/blob/master/02-peer-protocol.md#the-tx_init_rbf-message
596596
#[derive(Clone, Debug, Hash, PartialEq, Eq)]
597597
pub struct TxInitRbf {
598598
/// The channel ID
@@ -606,10 +606,10 @@ pub struct TxInitRbf {
606606
pub funding_output_contribution: Option<i64>,
607607
}
608608

609-
/// A tx_ack_rbf message which acknowledges replacement of the transaction after it's been
609+
/// A [`tx_ack_rbf`] message which acknowledges replacement of the transaction after it's been
610610
/// completed.
611611
///
612-
// TODO(dual_funding): Add spec link for `tx_ack_rbf`.
612+
/// [`tx_ack_rbf`]: https://github.com/lightning/bolts/blob/master/02-peer-protocol.md#the-tx_ack_rbf-message
613613
#[derive(Clone, Debug, Hash, PartialEq, Eq)]
614614
pub struct TxAckRbf {
615615
/// The channel ID
@@ -619,9 +619,9 @@ pub struct TxAckRbf {
619619
pub funding_output_contribution: Option<i64>,
620620
}
621621

622-
/// A tx_abort message which signals the cancellation of an in-progress transaction negotiation.
622+
/// A [`tx_abort`] message which signals the cancellation of an in-progress transaction negotiation.
623623
///
624-
// TODO(dual_funding): Add spec link for `tx_abort`.
624+
/// [`tx_abort`]: https://github.com/lightning/bolts/blob/master/02-peer-protocol.md#the-tx_abort-message
625625
#[derive(Clone, Debug, Hash, PartialEq, Eq)]
626626
pub struct TxAbort {
627627
/// The channel ID

0 commit comments

Comments
 (0)