Skip to content

Comments

Docs: Update README for library#28

Open
tvpeter wants to merge 2 commits intobitcoindevkit:masterfrom
tvpeter:docs/update-readme
Open

Docs: Update README for library#28
tvpeter wants to merge 2 commits intobitcoindevkit:masterfrom
tvpeter:docs/update-readme

Conversation

@tvpeter
Copy link
Collaborator

@tvpeter tvpeter commented Feb 3, 2026

Description

This PR updates the Readme for the library.

Checklists

All Submissions:

  • I've signed all my commits
  • I followed the contribution guidelines
  • I ran cargo fmt and cargo clippy before committing

src/client.rs Outdated
}

/// Retrieve the `basic` BIP 157 content filter for a particular block
/// Retrieve the Compact Block Filter (BIP-158) with type `basic` for the block given its `Blockhash`.
Copy link
Member

Choose a reason for hiding this comment

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

Sorry, missed the 0 in my previous suggestion.

Suggested change
/// Retrieve the Compact Block Filter (BIP-158) with type `basic` for the block given its `Blockhash`.
/// Retrieve the Compact Block Filter (BIP-0158) with type `basic` for the block given its `Blockhash`.

Copy link
Collaborator

@oleonardolima oleonardolima left a comment

Choose a reason for hiding this comment

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

cACK

README.md Outdated
| ----------------- | --------------------- | -------------------------------------------- |
| 30_0 (default) | v30.x and newer | Supports latest target and difficulty fields.|
| 29_0 | v29.x | Aligned with v29 schema. |
| 28_0v | 28.x and older | Omits newer fields |
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
| 28_0v | 28.x and older | Omits newer fields |
| 28_0 | 28.x and older | Omits newer fields |

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Thanks for catching that

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants