Skip to content

Commit c17affe

Browse files
committed
f: update documentation
1 parent 80420db commit c17affe

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

lightning/src/blinded_path/message.rs

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -236,14 +236,22 @@ pub(crate) struct ForwardTlvs {
236236
pub(crate) next_blinding_override: Option<PublicKey>,
237237
}
238238

239-
/// Similar to [`ForwardTlvs`], but these TLVs are for the final node.
239+
/// Similar to Forward Tlvs, but these TLVs are for the final node.
240240
pub(crate) struct ReceiveTlvs {
241241
/// If `context` is `Some`, it is used to identify the blinded path that this onion message is
242242
/// sending to. This is useful for receivers to check that said blinded path is being used in
243243
/// the right context.
244244
pub context: Option<MessageContext>,
245245

246-
/// Custom Tlvs. A user can use this to send custom tlvs information back to themself.
246+
/// Custom TLVs set by the user. If `custom_tlvs` is `Some`, it will be returned when the
247+
/// blinded path is used.
248+
///
249+
/// This field allows encoding custom data intended to be retrieved when the blinded path is used.
250+
///
251+
/// ## Note on Forward Compatibility:
252+
/// Users can encode any kind of data into the `Vec<u8>`. However, they must ensure that the
253+
/// data is structured in a forward-compatible manner to prevent data loss or misinterpretation
254+
/// during future upgrades.
247255
pub custom_tlvs: Option<Vec<u8>>,
248256
}
249257

0 commit comments

Comments
 (0)