Skip to content

Maintain a list of the supported BIPs in the repository #2069

@nymius

Description

@nymius

Describe the enhancement

Inside a doc directory at the root of the repository, or maybe in the header section of the project, we could list the BIPs the library is compatible with, or those that are partially supported, and detail the missing components.

Use case

Potential users of the library may want to check before starting building on top of BDK which BIPs are supported by the project.

Additional context

I was reading proposed BIP 3 updated BIP process, and the Adoption Of Proposals section encourages Bitcoin related projects to publish a list of the BIPs they implement. As a reference, bitcoin core has one: doc/bips.md. Although the state of BIP 3 is not yet "deployed", I think it is in general a good idea.

Maybe this doesn't make sense here but on upstream libraries, or maybe on both. Here I'm just gathering feedback.

Impact

  • Blocking production usage
  • Nice-to-have / UX improvement
  • Developer experience / maintainability

Are you using BDK in a production project?

  • Yes
  • No
  • Not yet, but planning to

Which backend(s) are relevant (if any)?

  • Electrum
  • Esplora
  • Bitcoin Core RPC
  • None / not backend-related (e.g. bdk_chain, bdk_core)
  • Other (please specify): ____

Project or organization (optional)

Metadata

Metadata

Assignees

No one assigned

    Labels

    choreNon-coding related workdiscussionThere's still a discussion ongoingdocumentationImprovements or additions to documentation

    Type

    Projects

    Status

    No status

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions