feat(chain): add new list_ordered_canonical_txs method#2027
Merged
ValuedMammal merged 4 commits intobitcoindevkit:release/chain-0.23.xfrom Nov 24, 2025
Conversation
oleonardolima
force-pushed
the
test/add-canonical-iter-topological-order-tests
branch
2 times, most recently
from
6b76092 to
a28cfdf
Compare
Member
|
Nice diagrams |
oleonardolima
force-pushed
the
test/add-canonical-iter-topological-order-tests
branch
11 times, most recently
from
08e4ce8 to
70ee41b
Compare
This comment was marked as outdated.
This comment was marked as outdated.
oleonardolima
force-pushed
the
test/add-canonical-iter-topological-order-tests
branch
2 times, most recently
from
6239c8f to
0aab769
Compare
evanlinjin
reviewed
Sep 18, 2025
oleonardolima
force-pushed
the
test/add-canonical-iter-topological-order-tests
branch
from
d57a580 to
3b79cba
Compare
evanlinjin
requested changes
Sep 19, 2025
Member
evanlinjin
left a comment
evanlinjin
left a comment
There was a problem hiding this comment.
The internals have completely changed. I don't think a point release would make any sense (we also have already merged other breaking changes). I recommend to just break the API.
Get rid of CanonicalIter. Just have a single function that returns impl Iterator<Item = ...>.
oleonardolima
force-pushed
the
test/add-canonical-iter-topological-order-tests
branch
2 times, most recently
from
0a17091 to
71c3744
Compare
ValuedMammal
changed the base branch from
release/chain-0.23.2
to
release/chain-0.23.x
ValuedMammal
approved these changes
Oct 3, 2025
ValuedMammal
previously requested changes
Nov 6, 2025
3 tasks
oleonardolima
force-pushed
the
test/add-canonical-iter-topological-order-tests
branch
from
9c4da10 to
6fd0de9
Compare
1 task
oleonardolima
force-pushed
the
test/add-canonical-iter-topological-order-tests
branch
7 times, most recently
from
b1294f5 to
37920a2
Compare
Collaborator
Author
|
@evanlinjin I've addressed all the comments/nits, and it's ready for a final round of review. Let me know if you see anything else. I improved the docs, commit messages, and also squashed some of them. --
@ValuedMammal I fixed these through the rebase, but now I'll need to drop the new one d9a7c2c, but it depends on #2075 landing in |
Collaborator
ValuedMammal
left a comment
ValuedMammal
left a comment
There was a problem hiding this comment.
I'll give this another review.
- Add a new `test_list_ordered_canonical_txs`, to assert the topological spending order when yielding the list of canonical txs, it also adds a new helper `Scenario` structure, and `is_txs_in_topological_order`.
Adds a new `list_ordered_canonical_txs` method which uses the new `TopologicalIterator` on top of the result of `list_canonical_txs` method, yielding the canonical txs in topological spending order. The new `list_ordered_canonical_txs` guarantees that spending transactions appears after their inputs, in topological "spending order". - Introduce the new `TopologicalIterator` for level-based topological sorting, based on Kahn's Algorithm, it uses the `ChainPosition` for sorting within the same graph level, and it takes an `Iterator<Item = CanonicalTx<'a, Arc<Transaction>, A>> of canonical txs. - Introduce the new `list_ordered_canonical_txs` method to `TxGraph`. - Update the existing tests under `test_tx_graph.rs` to verify the topological ordering correctness. - Update the existing `canonicalization` benchmark to also use the new `topological_ordered_txs` method. NOTE: - I've squashed the previous commits into a single one, as they're changing the same files and applies to the same scope. - Also, I've partially used Claude to help with the Kahn's Algorithm. Co-Authored-By: Claude <noreply@anthropic.com>
oleonardolima
force-pushed
the
test/add-canonical-iter-topological-order-tests
branch
from
37920a2 to
12c1076
Compare
ValuedMammal
merged commit 1a77475
into
bitcoindevkit:release/chain-0.23.x
19 checks passed
3 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
It introduces a new method for topological ordering canonical transactions,
list_ordered_canonical_txs. It now ensures the dependency-based transaction processing, guaranteeing that parent transactions always appears before their children transaction.The existing
list_canonical_txsandtry_list_canonical_txsmethods have been deprecated in favor of the new ordered version.Notes to the reviewers
"[...] For those reviewing, and wondering why we don't have a fallible try version of this method, it's because we don't have a fallible ChainOracle implementation - we will get rid of ChainOracle trait soon anyway."
This PR is intended for a point release so that bdk_wallet 2.x users can get a topologically sorted list of transactions (we need a point release on bdk_wallet 2.x as well).
It might be useful to take a look at the new test scenarios that I've added, it shows some specific scenarios where the current implementation and output of
canonical_txsdidn't output the transactions in topological order.Let me know if you think the TopologicalIter algorithm and/or API could be improved.
Changelog notice
Checklists
All Submissions:
New Features: