Skip to content

Commit 3342704

Browse files
committed
Add dual-funding spec links
1 parent 66fb520 commit 3342704

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
@@ -287,11 +287,11 @@ pub struct OpenChannel {
287287
pub channel_reserve_satoshis: u64,
288288
}
289289

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

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

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

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

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

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

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

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

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

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

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

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

0 commit comments

Comments
 (0)