Improve BDK Wallet balance interface and related methods

[nymius]

Overview

Improve BDK Wallet balance interface and related methods.

Description
There are multiple open requirements for the Balance API:

• The notion of trust is unclear.
• There are categories not represented.
• The upstream API for balance is over complicated.
• Further flexibility to apply filters
• Multi keychain requires a different API.

This is a critical, user facing API which should work and provide meaningful insights about wallet.

Expected Outcomes

Assess the existing Balance categories to determine if they are the appropriate ones to resolve the current issue, if they require modification, or if new, non-overlapping categories (such as locked) must be defined. If changes or new categories are required, document their finalized definitions within the Balance struct and ensure they are referenced by any dependent APIs.

Update the API to support the finalized categories. As part of this implementation, remove any redundant API components and apply necessary upstream changes.

The following issues should be resolved through the code modifications required above or formal design decisions. All fixes must include corresponding tests and documentation updates:

• Balance categorization: wallet-generated transactions to external addresses incorrectly marked as untrusted_pending #273
• wallet::Balance::trusted_pending AND TxBuilder::only_spend_change are broken #16
• Maybe we should mark which coins are confirmed but not yet spendable in the balance? #180
• TxGraph::balance's API is too complicated #115

Additional tasks:

• Conduct reviews of feat(wallet): add configurable min_output_value filter #427 and help move its development forward.

Resources

Skills Required

• hands on experience with git and GitHub
• basic rust programming skills
• be able to sign your git commits
• be able to curate and judge LLMs output

Mentor(s)

@nymius

Difficulty

Medium

Competency Test

• Previous ACK'd contributions to BDK projects.