Skip to content

Simplify /examples #1973

@notmandatory

Description

@notmandatory

Describe the enhancement

Our bdk examples should be simplified since combining them all into a cli tool adds a lot of boilerplate code that obscures the core logic needed to use common functions. Also now that we have the bdk-cli updated to bdk_wallet 1.0+ it makes more sense to maintain that as a full working bdk based CLI wallet example.

I suggest we remove the examples/ folder and add smaller focused code examples to the commonly used functions in the rust docs.

Use case

Having smaller easy to digest examples within the rust docs will make it easier for new devs to understand how bdk functions are ment to be used. It will also reduce duplicate work of maintaining the bd-cli tool and similar code in the bdk/examples folder.

Additional context

This was originally brought up by @matthiasdebernardini who maintains the bitcoindevkit/bdk-sqlx crate.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    Projects

    Status

    Todo

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions