Skip to content

Commit 960c570

Browse files
committed
Add dual-funding spec links
1 parent 2f869fe commit 960c570

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
@@ -464,9 +464,9 @@ pub struct SpliceLocked {
464464
pub channel_id: ChannelId,
465465
}
466466

467-
/// A tx_add_input message for adding an input during interactive transaction construction
467+
/// A [`tx_add_input`] message for adding an input during interactive transaction construction
468468
///
469-
// TODO(dual_funding): Add spec link for `tx_add_input`.
469+
/// [`tx_add_input`]: https://github.com/lightning/bolts/blob/master/02-peer-protocol.md#the-tx_add_input-message
470470
#[derive(Clone, Debug, Hash, PartialEq, Eq)]
471471
pub struct TxAddInput {
472472
/// The channel ID
@@ -483,9 +483,9 @@ pub struct TxAddInput {
483483
pub sequence: u32,
484484
}
485485

486-
/// A tx_add_output message for adding an output during interactive transaction construction.
486+
/// A [`tx_add_output`] message for adding an output during interactive transaction construction.
487487
///
488-
// TODO(dual_funding): Add spec link for `tx_add_output`.
488+
/// [`tx_add_output`]: https://github.com/lightning/bolts/blob/master/02-peer-protocol.md#the-tx_add_output-message
489489
#[derive(Clone, Debug, Hash, PartialEq, Eq)]
490490
pub struct TxAddOutput {
491491
/// The channel ID
@@ -499,9 +499,9 @@ pub struct TxAddOutput {
499499
pub script: ScriptBuf,
500500
}
501501

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

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

524-
/// A tx_complete message signalling the conclusion of a peer's transaction contributions during
524+
/// [`A tx_complete`] message signalling the conclusion of a peer's transaction contributions during
525525
/// interactive transaction construction.
526526
///
527-
// TODO(dual_funding): Add spec link for `tx_complete`.
527+
/// [`tx_complete`]: https://github.com/lightning/bolts/blob/master/02-peer-protocol.md#the-tx_complete-message
528528
#[derive(Clone, Debug, Hash, PartialEq, Eq)]
529529
pub struct TxComplete {
530530
/// The channel ID
531531
pub channel_id: ChannelId,
532532
}
533533

534-
/// A tx_signatures message containing the sender's signatures for a transaction constructed with
534+
/// A [`tx_signatures`] message containing the sender's signatures for a transaction constructed with
535535
/// interactive transaction construction.
536536
///
537-
// TODO(dual_funding): Add spec link for `tx_signatures`.
537+
/// [`tx_signatures`]: https://github.com/lightning/bolts/blob/master/02-peer-protocol.md#the-tx_signatures-message
538538
#[derive(Clone, Debug, Hash, PartialEq, Eq)]
539539
pub struct TxSignatures {
540540
/// The channel ID
@@ -547,10 +547,10 @@ pub struct TxSignatures {
547547
pub funding_outpoint_sig: Option<Signature>,
548548
}
549549

550-
/// A tx_init_rbf message which initiates a replacement of the transaction after it's been
550+
/// A [`tx_init_rbf`] message which initiates a replacement of the transaction after it's been
551551
/// completed.
552552
///
553-
// TODO(dual_funding): Add spec link for `tx_init_rbf`.
553+
/// [`tx_init_rbf`]: https://github.com/lightning/bolts/blob/master/02-peer-protocol.md#the-tx_init_rbf-message
554554
#[derive(Clone, Debug, Hash, PartialEq, Eq)]
555555
pub struct TxInitRbf {
556556
/// The channel ID
@@ -564,10 +564,10 @@ pub struct TxInitRbf {
564564
pub funding_output_contribution: Option<i64>,
565565
}
566566

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

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

0 commit comments

Comments
 (0)