search

LLFourn / bdk_core_staging

Staging area for bdk_core initial development
15 stars 12 forks source link

Add `revealed_and_lookahead_spks_of_keychain` #182

Closed danielabrozzoni closed 1 year ago

danielabrozzoni commented 1 year ago

Sometimes we want to know the scripts revealed and the one present in the lookahead (for example, in the CBF example)

codecov-commenter commented 1 year ago

Codecov Report

Merging #182 (dbfb861) into master (cef4985) will not change coverage. The diff coverage is n/a.

:mega: This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more

@@           Coverage Diff           @@
##           master     #182   +/-   ##
=======================================
  Coverage   56.74%   56.74%           
=======================================
  Files          10       10           
  Lines         252      252           
=======================================
  Hits          143      143           
  Misses        109      109

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

danielabrozzoni commented 1 year ago

Oh wait, I just realized you can also do txout_index.inner().all_spks(), maybe it's better to document this instead of adding yet another method?

rajarshimaitra commented 1 year ago

Oh wait, I just realized you can also do txout_index.inner().all_spks(), maybe it's better to document this instead of adding yet another method?

I think it's still valuable to have the revealed_and_lookahead_spks_of_keychain function, which is just filtering for a specific keychain. It makes sense to have the API to get only stored scipts of a keychain. Or else the user need to figure out our indexing system and do the filtering themselves. But for all keychains we can essentially skip the extra API and document somewhere to just call txout_index.inner().all_spks().

LLFourn commented 1 year ago

Oh wait, I just realized you can also do txout_index.inner().all_spks(), maybe it's better to document this instead of adding yet another method?

I think this is the right way forward. It needs to be clear that you can always get the inner txout index which has all the spks that the thing actually scans for.