search

lightningdevkit / lightningdevkit.org

Lightning Development Kit Documentation
https://lightningdevkit.org
MIT License
59 stars 39 forks source link

Better document distinction between channel/chain monitor #98

Open ConorOkus opened 2 years ago

ConorOkus commented 2 years ago

For some/many users, a unified API would be preferable. Abstraction layer might be convenient?

TheBlueMatt commented 2 years ago

ChainMonitor is the abstraction layer. I'm not entirely sure what's to be done here?

ConorOkus commented 2 years ago

Is there a preferred module to use here, as it seems like ChainMonitor & ChannelMonitor do quite similar things?

Opened this as there seemed to be confusion from one of our users, @arik-so any thoughts?

I'm happy to close if we feel it's a non issue.

arik-so commented 2 years ago

I think the confusion stems from the objects sounding so similar, even though they clearly refer to very different components. This is a hard one, but imo, definitely a big source of confusion.

TheBlueMatt commented 2 years ago

Hmm, they do sound somewhat similar. Some of the confusion may stem from the fact that we have a generic interface a user could implement, but they probably want to just use a ChainMonitor. Is https://lightningdevkit.org/architecture/ not clear on this matter, or should we increase visibility of that page?