Skip to content

Add design docs for reference#1029

Draft
yyforyongyu wants to merge 5 commits into
btcsuite:masterfrom
yyforyongyu:add-design-docs
Draft

Add design docs for reference#1029
yyforyongyu wants to merge 5 commits into
btcsuite:masterfrom
yyforyongyu:add-design-docs

Conversation

@yyforyongyu

Copy link
Copy Markdown
Collaborator

This PR adds architecture design docs so other tasks can use them as references.

@GustavoStingelin GustavoStingelin left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

just one comment, but LGTM!

Comment thread chain/ARCHITECTURE.md
```go
// MempoolObserver provides methods for observing the mempool of a full node.
// This is an optional interface that a ChainDriver may implement.
type MempoolObserver interface {

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The observer name here reminds me of the Observer Pattern, but the purpose seems to be a bit different, right?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

correct - this is more like providing a mempool IO, tho the whole ntft uses the publish-subscribe pattern, which I believe is the same as the observer pattern you linked.

@yyforyongyu yyforyongyu marked this pull request as draft August 27, 2025 10:28
@yyforyongyu

Copy link
Copy Markdown
Collaborator Author

Turning this into a draft as this PR serves as a reference point atm - we will update the design docs once the whole series is done, as I'm working on the wallet interfaces, I realized there are a few places that need to be fine-tuned.

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants