Skip to content

Document better optional features (data_loss_protect, upfront_shutdown_script,...) #438

Closed

Description

@ariard

Post #428 merge, would be great to document FeatureContext* setters (lightning/src/ln/msgs.rs), I don't think optional features are documented anyway in the current codebase beyond references to BOLT.

Activity

  1. mattfaltyn commented on May 19, 2022

    @mattfaltyn
    Contributor

    @ariard would love to work on this if it's still available!

  2. TheBlueMatt commented on May 19, 2022

    @TheBlueMatt
    Collaborator

    I believe we already have the setters documented in a sense, but indeed we don't currently have docs which indicate the list of features that we support and what is optional/required/etc. We should probably put it in the module-level documentation in lightning/src/ln/features.rs, and, yes, its still up for grabs :)

  3. mattfaltyn commented on May 27, 2022

    @mattfaltyn
    Contributor

    I believe we already have the setters documented in a sense, but indeed we don't currently have docs which indicate the list of features that we support and what is optional/required/etc. We should probably put it in the module-level documentation in lightning/src/ln/features.rs, and, yes, its still up for grabs :)

    What features are worth documenting in lightning/src/ln/features.rs from lightning/src/ln/msgs.rs? I.e., should I group the structs in lightning/src/ln/msgs.rs into features by their feature flags as shown in BOLT #9: Assigned Feature Flags? Not sure if this question makes sense.

  4. TheBlueMatt commented on May 27, 2022

    @TheBlueMatt
    Collaborator

    Not sure why you mention msgs.rs - I was mostly thinking about documenting the set of features implemented in LDK, ie just in features.rs talking about the features that we set and what they do.

  5. mattfaltyn commented on May 28, 2022

    @mattfaltyn
    Contributor

    That makes sense. In the context of ariard's initial comment on this issue, I thought your comment referred to specific features in msgs.rs that should be documented in features.rs. Thanks for the clarification!

  6. TheBlueMatt commented on May 29, 2022

    @TheBlueMatt
    Collaborator

    Yea, it's a bit confusing because the code has changed a good bit since this issue was opened. But safe to just treat it as "need better docs on what features do and would be good to document them in some global place in terms of 'what LDK supports'".

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions