rust-lightning icon indicating copy to clipboard operation
rust-lightning copied to clipboard

[Clarity] Minor Docs

Open G8XSU opened this issue 3 years ago • 7 comments

  • In ChannelManager we have to wait for initial sync to complete. (clarity)
  • Monitor Updates need to be persisted in sequential fashion (specially when async) (clarity)

G8XSU avatar Oct 21 '22 19:10 G8XSU

Slipping to 114, not sure why this has a 113 tag if it wasnt assigned to anyone.

TheBlueMatt avatar Dec 14 '22 19:12 TheBlueMatt

Are we moving this to 115? I can take it if I know where we should be clarifying the above to make it obvious to the user.

dunxen avatar Feb 28 '23 07:02 dunxen

Yea, I'm honestly not sure what the first one refers to. The second is kinda implied by docs today, but we definitely need to include it when we rewrite docs for fully-async monitor updates. Will note it in #1684.

@G8XSU can you suggest something concrete for the first bullet? Either way 114 doesnt need to wait on this.

TheBlueMatt avatar Mar 01 '23 17:03 TheBlueMatt

I think both points are based on feedback from Lexe, and first bullet means, ChannelManager and monitors need to be fully synced before client starts using channel-manager api's (including block-sync).

G8XSU avatar Mar 09 '23 17:03 G8XSU

@G8XSU mind opening a PR for this?

TheBlueMatt avatar Nov 05 '23 01:11 TheBlueMatt

Ok.. will do :)

G8XSU avatar Nov 05 '23 01:11 G8XSU

@G8XSU any update?

TheBlueMatt avatar Mar 18 '24 14:03 TheBlueMatt

Don't think there's anything left for this after #2992.

TheBlueMatt avatar Aug 26 '24 14:08 TheBlueMatt