refactor(tests): move TxTemplate from `chain` to `testenv` by tvpeter · Pull Request #2177 · bitcoindevkit/bdk

tvpeter · 2026-04-15T18:23:47Z

Description

This PR moves the TxTemplate from the chain crate into the testenv. It also updates the TxTemplate to use the Cow smart pointer, adds method implementations to TxTemplate, and migrates tests to the builder API.

This PR addresses the first and second todos on #1936.

Changelog notice

moved TxTemplate from chain to testenv
added builder API methods to TxTemplate

Checklists

All Submissions:

I followed the contribution guidelines

oleonardolima

cACK a5d9f41

You can rebase to get the latest toolchain updated CI. Overall looks good, I only would like to take a deeper look into the last commit.

oleonardolima · 2026-04-29T14:30:42Z

cACK a5d9f41

You can rebase to get the latest toolchain updated CI. Overall looks good, I only would like to take a deeper look into the last commit.

Also, I'd avoid mixing renaming and moving code in the same commits.

oleonardolima · 2026-05-01T14:46:43Z

@tvpeter Oh, there are some conflicts 😅

tvpeter · 2026-05-01T14:48:31Z

@tvpeter Oh, there are some conflicts 😅

Yeah, from the recent merge. I will rebase and resolve

oleonardolima · 2026-06-15T16:57:36Z

@tvpeter I've rebased it on top of master to solve the conflicts, let me know if it's all good or I've messed something.

codecov · 2026-06-15T17:03:45Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 78.32%. Comparing base (1acb4d0) to head (16619d4).

Additional details and impacted files

@@           Coverage Diff           @@
##           master    #2177   +/-   ##
=======================================
  Coverage   78.32%   78.32%           
=======================================
  Files          30       30           
  Lines        5934     5934           
  Branches      281      281           
=======================================
  Hits         4648     4648           
  Misses       1210     1210           
  Partials       76       76

Flag	Coverage Δ
rust	`78.32% <ø> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

tvpeter · 2026-06-16T05:41:57Z

@tvpeter I've rebased it on top of master to solve the conflicts, let me know if it's all good or I've messed something.

At a glance, it looks just fine. Thank you.

evanlinjin · 2026-06-16T08:51:34Z

Remember that PR descriptions need to explain why things are done.

It also updates the TxTemplate to use the Cow smart pointe

What is the rationale for this?

Edit: I see that it is my suggestion in the ticket. I was wrong. Cow only makes sense if the type will start as a reference and may need to be mutated later on.

tvpeter · 2026-06-16T09:18:05Z

Edit: I see that it is my suggestion in the ticket. I was wrong. Cow only makes sense if the type will start as a reference and may need to be mutated later on.

Alright, should I revert the aspect that updates the TxTemplate struct using Cow?

ValuedMammal · 2026-07-20T19:20:30Z

+    /// If `Some(index)`, the output will use the script pubkey at that index
+    /// from the test descriptor set. If `None`, a random (empty) script is used.
+    pub spk_index: Option<u32>,


🔧 This will cause a panic on L214 if the spk index wasn't inserted into the index.

Refactored init_graph fn to prevent panics, check the outputs of each TxTemplate, derive and inserts spk that the indexer has not yet seen just-in-time before the transaction is constructed and scanned.

Ok, also spk_index can't be in the hardened derivation range either (>= 2^31), worth a comment somewhere in the docs.

- Move the tx template helpers (TxTemplate, TxInTemplate,TxOutTemplate, init_graph) out of crates/chain/tests/common into the testenv.

Move shared test/bench helpers into testenv utils. Update benches and the affected tests to use them

- Remove changeset macro because it is no longer used - Merged `new_standard_tx`` into `new_tx`` to have a uniform helper for creating standard tx and updated call sites across tests - Removed the static loop in init_graph that pre-populated the SpkTxOutIndex and replaced it with a check in the TxTemplate outputs, that derives and populate empty the script pub key for indexers without spk before a transaction is constructed and scanned. This refactor removes the 0-9 limitation of having just 10 outputs. Users can use any spk_index without panic. Also removed generating spks that may not be used - Renamed `txid_to_name` field to `txids` in TxTemplateEnv and update usage across tests - Remove dead_code flag

ValuedMammal

Code review ACK 16619d4

tvpeter requested review from evanlinjin, luisschwab and oleonardolima as code owners April 15, 2026 18:23

github-project-automation Bot added this to BDK Chain Apr 15, 2026

tvpeter mentioned this pull request Apr 15, 2026

refactor: move tx_template from bdk_chain to bdk_testenv #1800

Closed

3 tasks

luisschwab assigned tvpeter Apr 19, 2026

luisschwab moved this to Needs Review in BDK Chain Apr 19, 2026

luisschwab mentioned this pull request Apr 26, 2026

Move TxTemplate to bdk_testenv (#1936) #2191

Closed

3 tasks

oleonardolima added this to the Chain 0.24.0 milestone Apr 28, 2026

oleonardolima added the tests label Apr 28, 2026

oleonardolima reviewed Apr 29, 2026

View reviewed changes

tvpeter force-pushed the refactor/mv-txtemplate-to-testenv branch from a5d9f41 to 6d5cac1 Compare April 30, 2026 02:58

tvpeter force-pushed the refactor/mv-txtemplate-to-testenv branch 2 times, most recently from e381444 to 49ba5a5 Compare May 2, 2026 12:46

oleonardolima force-pushed the refactor/mv-txtemplate-to-testenv branch from 49ba5a5 to 067245e Compare June 15, 2026 16:55

tvpeter force-pushed the refactor/mv-txtemplate-to-testenv branch 3 times, most recently from 5ee920d to ee76753 Compare June 30, 2026 02:46

ValuedMammal reviewed Jul 20, 2026

View reviewed changes

tvpeter added 3 commits July 20, 2026 20:51

refactor(test): move tx_template to testenv

c212303

- Move the tx template helpers (TxTemplate, TxInTemplate,TxOutTemplate, init_graph) out of crates/chain/tests/common into the testenv.

refactor(test):mv util fns from benches to testenv

0237e7f

Move shared test/bench helpers into testenv utils. Update benches and the affected tests to use them

docs(testenv): Add crate level docs for testenv

16619d4

tvpeter force-pushed the refactor/mv-txtemplate-to-testenv branch from ee76753 to 16619d4 Compare July 21, 2026 15:35

ValuedMammal approved these changes Jul 21, 2026

View reviewed changes

Uh oh!

Conversation

tvpeter commented Apr 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Changelog notice

Checklists

All Submissions:

Uh oh!

oleonardolima left a comment

Choose a reason for hiding this comment

Uh oh!

oleonardolima commented Apr 29, 2026

Uh oh!

oleonardolima commented May 1, 2026

Uh oh!

tvpeter commented May 1, 2026

Uh oh!

oleonardolima commented Jun 15, 2026

Uh oh!

codecov Bot commented Jun 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

tvpeter commented Jun 16, 2026

Uh oh!

evanlinjin commented Jun 16, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

tvpeter commented Jun 16, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ValuedMammal Jul 20, 2026

Choose a reason for hiding this comment

Uh oh!

tvpeter Jul 21, 2026

Choose a reason for hiding this comment

Uh oh!

ValuedMammal Jul 21, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

ValuedMammal left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

tvpeter commented Apr 15, 2026 •

edited

Loading

codecov Bot commented Jun 15, 2026 •

edited

Loading

evanlinjin commented Jun 16, 2026 •

edited

Loading