Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[chain] keychain module doesn't need to exist #1317

Closed
LLFourn opened this issue Feb 2, 2024 · 2 comments · Fixed by #1493
Closed

[chain] keychain module doesn't need to exist #1317

LLFourn opened this issue Feb 2, 2024 · 2 comments · Fixed by #1493
Labels
api A breaking API change module-blockchain
Milestone

Comments

@LLFourn
Copy link
Contributor

LLFourn commented Feb 2, 2024

The module tries to explain itself as follows:

A keychain here is a set of application-defined indexes for a miniscript descriptor where we can derive script pubkeys at a particular derivation index.

Which is very difficult to read. More importantly it only has one thing in it KeyChainTxOutIndex. We can just have keychain_txout_index.rs. We could move indexers into their own module so indexers/keychain_txout.rs, indexers/spk_txout.rs.

@evanlinjin
Copy link
Member

evanlinjin commented Feb 2, 2024

Let's do this after #1203. I'll take responsibility for the convoluted crate docs.

@ValuedMammal
Copy link
Contributor

ValuedMammal commented Jun 22, 2024

@evanlinjin If you want I can open a PR and have you make suggestions for the crate docs.. Actually, removing this module means we won't need the old docs. This also gives us a chance to finally relocate the Balance struct

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api A breaking API change module-blockchain
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

4 participants