[types] Add missing return fields for `gettxoutsetinfo` RPC #475

natobritto · 2026-01-23T20:34:09Z

The RPC has missing fields which are enabled only when coinstatsindex option is called or muhash hash type is used. Argument list is also added to header comment.

Partially fixes issue #474.

types/src/model/blockchain.rs

types/src/v26/blockchain/mod.rs

types/src/v26/blockchain/into.rs

jamillambert

ACK d776988

tcharding · 2026-01-27T21:38:51Z

types/src/model/blockchain.rs

    /// The total amount.
    pub total_amount: Amount,
+    /// The serialized hash (only present if 'muhash' hash_type is chosen).
+    pub muhash: Option<String>,


Which hash algo is used? We can use a concrete type if we know the algo. Is it SHA256?

lolz, I see we have a FIXME already in the code asking this same question for hash_serialized_2.

So can you either add a FIXME to this line and hash_serialized_3 or work out an answer?

The algorithm is MuHash3072, which from what I understand is like a bucket of hashes. There are libraries that could handle MuHash such as google/rust-multihash (discontinued) or kaspa_muhash. I don't really know how to work with MuHash, or want to include a unknown library in types crate, I decided to put a FIXME there.

Thanks, raised: rust-bitcoin/rust-bitcoin#5589

tcharding · 2026-01-27T21:42:44Z

types/src/model/blockchain.rs

+
+/// Detailed block-level info.  Part of `gettxoutsetinfo`.
+#[derive(Clone, Debug, PartialEq, Deserialize, Serialize)]
+pub struct BlockInfo {


I wonder if this should be called GetTxOutSetInfoBlockInfo? Since we only have one namespace at the model (and also version specific eg types::v30) level this takes up a name that is quite ambiguous.

Precedent is set by ScanTxOutSetFoo for method scantxoutset.

Yes, my bad this was an oversight. Fixed

tcharding · 2026-01-27T21:43:23Z

types/src/model/blockchain.rs

+
+/// Categories of unspendable amounts. Part of `gettxoutsetinfo`.
+#[derive(Clone, Debug, PartialEq, Deserialize, Serialize)]
+pub struct Unspendables {


Perhaps same comment as on BlockInfo although 'unspendables' seems less common?

I agree with the prefix, went ahead and also added it here.

tcharding · 2026-01-27T21:45:34Z

types/src/v26/blockchain/error.rs

+    UnspendablesUnclaimedRewards(amount::ParseAmountError),
+    /// Conversion of the `total_unspendable_amount` field failed.
+    TotalUnspendableAmount(amount::ParseAmountError),
 }


I'm not sure about this error stuff. Including the variants for optional stuff. @jamillambert did we do this before or did we use a nested error type? I can't remember.

In v26 there is an example: SubmitPackage (response for RPC) has optional field fees nested within tx_result list, called SubmitPackageTxResultFees, which has errors defined for all its fields too.

Aight, good enough for me. Thanks

tcharding · 2026-01-27T21:47:31Z

types/src/v26/blockchain/into.rs

+                Some(b) => {
+                    let prevout_spent =
+                        Amount::from_btc(b.prevout_spent).map_err(E::PrevoutSpent)?;
+                    let coinbase = Amount::from_btc(b.coinbase).map_err(E::Coinbase)?;
+                    let new_outputs_ex_coinbase = Amount::from_btc(b.new_outputs_ex_coinbase)
+                        .map_err(E::NewOutputsExCoinbase)?;
+                    let unspendable = Amount::from_btc(b.unspendable).map_err(E::Unspendable)?;
+                    let unspendables = model::Unspendables {
+                        genesis_block: Amount::from_btc(b.unspendables.genesis_block)
+                            .map_err(E::UnspendablesGenesisBlock)?,
+                        bip30: Amount::from_btc(b.unspendables.bip30)
+                            .map_err(E::UnspendablesBip30)?,
+                        scripts: Amount::from_btc(b.unspendables.scripts)
+                            .map_err(E::UnspendablesScripts)?,
+                        unclaimed_rewards: Amount::from_btc(b.unspendables.unclaimed_rewards)
+                            .map_err(E::UnspendablesUnclaimedRewards)?,


Can we put all the conversion logic up above the return statement please? I know is subjective but that is how we have done in everywhere else.

tcharding

Thanks for your work man, this was a big one.

Reviewed: d776988

tcharding · 2026-01-29T21:55:58Z

You can fix formatting by running just fmt.

The RPC has missing fields which are enabled only when `coinstatsindex` or muhash hash type is used. Argument list is also added to header coment.

tcharding

ACK 01f13a9

natobritto requested a review from jamillambert as a code owner January 23, 2026 20:34

github-actions bot added the C-types label Jan 23, 2026

jamillambert reviewed Jan 26, 2026

View reviewed changes

types/src/model/blockchain.rs Outdated Show resolved Hide resolved

types/src/v26/blockchain/mod.rs Outdated Show resolved Hide resolved

types/src/v26/blockchain/into.rs Outdated Show resolved Hide resolved

jamillambert mentioned this pull request Jan 26, 2026

[types] Add completed field to ScanBlocksStart return type #477

Open

natobritto force-pushed the fix-gettxoutsetinfo branch from 60cdd1a to 87826eb Compare January 26, 2026 20:54

jamillambert reviewed Jan 26, 2026

View reviewed changes

types/src/v26/blockchain/into.rs Outdated Show resolved Hide resolved

natobritto force-pushed the fix-gettxoutsetinfo branch from 87826eb to d776988 Compare January 27, 2026 14:41

jamillambert previously approved these changes Jan 27, 2026

View reviewed changes

tcharding reviewed Jan 27, 2026

View reviewed changes

natobritto dismissed jamillambert’s stale review via b10f6d0 January 29, 2026 21:48

natobritto force-pushed the fix-gettxoutsetinfo branch from d776988 to b10f6d0 Compare January 29, 2026 21:48

tcharding mentioned this pull request Jan 29, 2026

hashes: Should we provide a MuHash type? rust-bitcoin/rust-bitcoin#5589

Open

fix(types): add missing return fields for gettxoutsetinfo RPC

01f13a9

The RPC has missing fields which are enabled only when `coinstatsindex` or muhash hash type is used. Argument list is also added to header coment.

natobritto force-pushed the fix-gettxoutsetinfo branch from b10f6d0 to 01f13a9 Compare January 29, 2026 21:56

tcharding approved these changes Jan 29, 2026

View reviewed changes

tcharding merged commit 909850a into rust-bitcoin:master Jan 29, 2026
31 checks passed

[types] Add missing return fields for gettxoutsetinfo RPC #475

[types] Add missing return fields for gettxoutsetinfo RPC #475

Conversation

natobritto commented Jan 23, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jamillambert left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

natobritto Jan 29, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tcharding left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tcharding commented Jan 29, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

tcharding left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

[types] Add missing return fields for `gettxoutsetinfo` RPC #475

[types] Add missing return fields for `gettxoutsetinfo` RPC #475

natobritto Jan 29, 2026 •

edited

Loading

tcharding left a comment •

edited

Loading

tcharding commented Jan 29, 2026 •

edited

Loading