Skip to content

Commit a3129ee

Browse files
committed
Add dual-funding spec links
1 parent 4bd4f19 commit a3129ee

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
@@ -182,10 +182,10 @@ pub struct Pong {
182182
pub byteslen: u16,
183183
}
184184

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

255-
/// An open_channel2 message to be sent by or received from the channel initiator.
255+
/// An [`open_channel2`] message to be sent by or received from the channel initiator.
256256
///
257257
/// Used in V2 channel establishment
258258
///
259-
// TODO(dual_funding): Add spec link for `open_channel2`.
259+
/// [`open_channel2`]: https://github.com/lightning/bolts/blob/master/02-peer-protocol.md#the-open_channel2-message
260260
#[derive(Clone, Debug, Hash, PartialEq, Eq)]
261261
pub struct OpenChannelV2 {
262262
/// Common fields of `open_channel(2)`-like messages
@@ -271,10 +271,10 @@ pub struct OpenChannelV2 {
271271
pub require_confirmed_inputs: Option<()>,
272272
}
273273

274-
/// Contains fields that are both common to [`accept_channel`] and `accept_channel2` messages.
274+
/// Contains fields that are both common to [`accept_channel`] and [`accept_channel2`] messages.
275275
///
276276
/// [`accept_channel`]: https://github.com/lightning/bolts/blob/master/02-peer-protocol.md#the-accept_channel-message
277-
// TODO(dual_funding): Add spec link for `accept_channel2`.
277+
/// [`accept_channel2`]: https://github.com/lightning/bolts/blob/master/02-peer-protocol.md#the-accept_channel2-message
278278
#[derive(Clone, Debug, Hash, PartialEq, Eq)]
279279
pub struct CommonAcceptChannelFields {
280280
/// The same `temporary_channel_id` received from the initiator's `open_channel2` or `open_channel` message.
@@ -334,11 +334,11 @@ pub struct AcceptChannel {
334334
pub next_local_nonce: Option<musig2::types::PublicNonce>,
335335
}
336336

337-
/// An accept_channel2 message to be sent by or received from the channel accepter.
337+
/// An [`accept_channel2`] message to be sent by or received from the channel accepter.
338338
///
339339
/// Used in V2 channel establishment
340340
///
341-
// TODO(dual_funding): Add spec link for `accept_channel2`.
341+
/// [`accept_channel2`]: https://github.com/lightning/bolts/blob/master/02-peer-protocol.md#the-accept_channel2-message
342342
#[derive(Clone, Debug, Hash, PartialEq, Eq)]
343343
pub struct AcceptChannelV2 {
344344
/// Common fields of `accept_channel(2)`-like messages
@@ -468,9 +468,9 @@ pub struct SpliceLocked {
468468
pub splice_txid: Txid,
469469
}
470470

471-
/// A tx_add_input message for adding an input during interactive transaction construction
471+
/// A [`tx_add_input`] message for adding an input during interactive transaction construction
472472
///
473-
// TODO(dual_funding): Add spec link for `tx_add_input`.
473+
/// [`tx_add_input`]: https://github.com/lightning/bolts/blob/master/02-peer-protocol.md#the-tx_add_input-message
474474
#[derive(Clone, Debug, Hash, PartialEq, Eq)]
475475
pub struct TxAddInput {
476476
/// The channel ID
@@ -489,9 +489,9 @@ pub struct TxAddInput {
489489
pub shared_input_txid: Option<Txid>,
490490
}
491491

492-
/// A tx_add_output message for adding an output during interactive transaction construction.
492+
/// A [`tx_add_output`] message for adding an output during interactive transaction construction.
493493
///
494-
// TODO(dual_funding): Add spec link for `tx_add_output`.
494+
/// [`tx_add_output`]: https://github.com/lightning/bolts/blob/master/02-peer-protocol.md#the-tx_add_output-message
495495
#[derive(Clone, Debug, Hash, PartialEq, Eq)]
496496
pub struct TxAddOutput {
497497
/// The channel ID
@@ -505,9 +505,9 @@ pub struct TxAddOutput {
505505
pub script: ScriptBuf,
506506
}
507507

508-
/// A tx_remove_input message for removing an input during interactive transaction construction.
508+
/// A [`tx_remove_input`] message for removing an input during interactive transaction construction.
509509
///
510-
// TODO(dual_funding): Add spec link for `tx_remove_input`.
510+
/// [`tx_remove_input`]: https://github.com/lightning/bolts/blob/master/02-peer-protocol.md#the-tx_remove_input-and-tx_remove_output-messages
511511
#[derive(Clone, Debug, Hash, PartialEq, Eq)]
512512
pub struct TxRemoveInput {
513513
/// The channel ID
@@ -516,9 +516,9 @@ pub struct TxRemoveInput {
516516
pub serial_id: SerialId,
517517
}
518518

519-
/// A tx_remove_output message for removing an output during interactive transaction construction.
519+
/// A [`tx_remove_output`] message for removing an output during interactive transaction construction.
520520
///
521-
// TODO(dual_funding): Add spec link for `tx_remove_output`.
521+
/// [`tx_remove_output`]: https://github.com/lightning/bolts/blob/master/02-peer-protocol.md#the-tx_remove_input-and-tx_remove_output-messages
522522
#[derive(Clone, Debug, Hash, PartialEq, Eq)]
523523
pub struct TxRemoveOutput {
524524
/// The channel ID
@@ -527,20 +527,20 @@ pub struct TxRemoveOutput {
527527
pub serial_id: SerialId,
528528
}
529529

530-
/// A tx_complete message signalling the conclusion of a peer's transaction contributions during
530+
/// [`A tx_complete`] message signalling the conclusion of a peer's transaction contributions during
531531
/// interactive transaction construction.
532532
///
533-
// TODO(dual_funding): Add spec link for `tx_complete`.
533+
/// [`tx_complete`]: https://github.com/lightning/bolts/blob/master/02-peer-protocol.md#the-tx_complete-message
534534
#[derive(Clone, Debug, Hash, PartialEq, Eq)]
535535
pub struct TxComplete {
536536
/// The channel ID
537537
pub channel_id: ChannelId,
538538
}
539539

540-
/// A tx_signatures message containing the sender's signatures for a transaction constructed with
540+
/// A [`tx_signatures`] message containing the sender's signatures for a transaction constructed with
541541
/// interactive transaction construction.
542542
///
543-
// TODO(dual_funding): Add spec link for `tx_signatures`.
543+
/// [`tx_signatures`]: https://github.com/lightning/bolts/blob/master/02-peer-protocol.md#the-tx_signatures-message
544544
#[derive(Clone, Debug, Hash, PartialEq, Eq)]
545545
pub struct TxSignatures {
546546
/// The channel ID
@@ -553,10 +553,10 @@ pub struct TxSignatures {
553553
pub shared_input_signature: Option<Signature>,
554554
}
555555

556-
/// A tx_init_rbf message which initiates a replacement of the transaction after it's been
556+
/// A [`tx_init_rbf`] message which initiates a replacement of the transaction after it's been
557557
/// completed.
558558
///
559-
// TODO(dual_funding): Add spec link for `tx_init_rbf`.
559+
/// [`tx_init_rbf`]: https://github.com/lightning/bolts/blob/master/02-peer-protocol.md#the-tx_init_rbf-message
560560
#[derive(Clone, Debug, Hash, PartialEq, Eq)]
561561
pub struct TxInitRbf {
562562
/// The channel ID
@@ -570,10 +570,10 @@ pub struct TxInitRbf {
570570
pub funding_output_contribution: Option<i64>,
571571
}
572572

573-
/// A tx_ack_rbf message which acknowledges replacement of the transaction after it's been
573+
/// A [`tx_ack_rbf`] message which acknowledges replacement of the transaction after it's been
574574
/// completed.
575575
///
576-
// TODO(dual_funding): Add spec link for `tx_ack_rbf`.
576+
/// [`tx_ack_rbf`]: https://github.com/lightning/bolts/blob/master/02-peer-protocol.md#the-tx_ack_rbf-message
577577
#[derive(Clone, Debug, Hash, PartialEq, Eq)]
578578
pub struct TxAckRbf {
579579
/// The channel ID
@@ -583,9 +583,9 @@ pub struct TxAckRbf {
583583
pub funding_output_contribution: Option<i64>,
584584
}
585585

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

0 commit comments

Comments
 (0)