Implement scantxoutset method and test #164

GideonBature · 2025-05-12T23:20:53Z

The JSON-RPC method scantxoutset does return a type. We want to test this to catch any changes in behavior in future Core versions.

This PR adds a client function that errors if the return value is anything other than the type it returns, along with an integration test that calls this function.

Ref: #116
Closes #115

tcharding · 2025-05-13T04:23:56Z

Why is there identical code in the v17 and v18 blockchain modules of the client?

GideonBature · 2025-05-13T04:50:25Z

Why is there identical code in the v17 and v18 blockchain modules of the client?

They basically work the same way, the difference is in their return type, v18 has an additional field (desc) in it's result, whereas it is lacking in v17. Or is there a way to reuse the client code in v17 for v18 and still be able to return the type that is meant for v18?

tcharding · 2025-05-13T22:44:21Z

Bro I explained this to you already on the other two PRs you did. Perhaps go back over them and see if you can work it out.

GideonBature · 2025-05-14T17:09:45Z

Bro I explained this to you already on the other two PRs you did. Perhaps go back over them and see if you can work it out.

oh, I now understand, I was looking at how gettxout was used in the client, where despite the code is similar, they used it for v17 and again for v22. So I thought that for any change in the fields of return type of a method, there should also be a code in the module of the client for that particular version with the change. But I can see that it's not always the case.

For this recent push, I removed the repeated code across all versions having different fields in their type.

tcharding · 2025-05-15T00:04:59Z

Oh well that would explain your confusion, the gettxout in v22 is just plain wrong. I'll remove it.

tcharding · 2025-05-15T00:09:24Z

Done in #169. FTR bugs happen, if you see things that are wrong or look weird just ask (or PR to fix them). Apologies for being so fierce yesterday.

tcharding · 2025-05-15T02:19:12Z

Returns column needs updating (and Notes).

tcharding

Holy moly you picked a difficult one. I'm going to have to come back to this when I can put more thought into it. Feel free to ignore my suggestions until then.

integration_test/tests/blockchain.rs

types/src/v17/blockchain/mod.rs

tcharding · 2025-05-15T02:30:39Z

types/src/v17/blockchain/mod.rs

+/// > 2. "scanobjects"                  (array, required) Array of scan objects
+#[derive(Deserialize, Debug, Clone, PartialEq)]
+#[serde(untagged)]
+pub enum ScanTxOutSet {


Oh this is interesting. This is a new idea for the crate, it could be done for all the methods that have verbose results. I'm not sure it adds any value though. I'd just remove this and leave the three individual return types. Plus I'd document 'returned when the foo action as taken'.

after looking at v28 I'm not sure - leave it with me for a bit.

Alright... Noted. That would be great using it for the methods having verbose results.

GideonBature · 2025-05-15T14:01:16Z

Done in #169. FTR bugs happen, if you see things that are wrong or look weird just ask (or PR to fix them). Apologies for being so fierce yesterday.

No problem. I will do this going forward.

GideonBature · 2025-05-15T20:48:59Z

Returns column needs updating (and Notes).

Noted!

GideonBature · 2025-05-15T20:49:19Z

Holy moly you picked a difficult one. I'm going to have to come back to this when I can put more thought into it. Feel free to ignore my suggestions until then.

Noted....

GideonBature · 2025-05-15T21:09:59Z

Returns column needs updating (and Notes).

for the notes, is there any need to change it? since it describes perfectly that the scantxoutset is experimental.

tcharding · 2025-05-16T00:19:53Z

Oh you are right, lets leave the notes as they are.

tcharding · 2025-05-27T05:41:20Z

Man this method is really not that simple to add support for because it changes so often. Can we put this one on hold until you've got a few more easy ones done?

GideonBature · 2025-05-28T22:33:43Z

Man this method is really not that simple to add support for because it changes so often. Can we put this one on hold until you've got a few more easy ones done?

Understood... sure, let's do that.

GideonBature · 2025-07-15T14:49:49Z

Complete the scantxoutset method and model.

tcharding · 2025-07-15T23:17:17Z

types/src/model/blockchain.rs

+    #[serde(rename = "scriptPubKey")]
+    pub script_pubkey: ScriptBuf,


model types don't get renames because they are never used against Core.

tcharding · 2025-07-15T23:23:40Z

types/src/model/blockchain.rs

+}
+
+#[derive(Deserialize, Debug, Clone, PartialEq)]
+pub struct ScanTxOutSetStatus {


Observation: This struct never changes

Use git grep -A 4 'pub struct ScanTxOutSetStatus' to see.

tcharding · 2025-07-15T23:28:59Z

types/src/v18/blockchain/mod.rs

+}
+
+#[derive(Clone, Debug, PartialEq, Deserialize, Serialize)]
+pub struct ScanTxOutSetStart {


This looks wrong. Perhaps add #[serde(deny_unknown_fields)] to all your structs and that will help find the bugs.

tcharding

You've done a bunch of work, well done. This one is pretty curly, here are some ideas.

I think it would be more simple if we were to split up the return types for the three different commands (start, abort, status). That way we only have to re-implement the ones that change.

In the client I think it would be more simple to have three methods, one for each command and not have a ScanAction type.

Instead of ScanObject I think we can just use a String and ignore the added complexity of an object (the WithDesc variant) since it is unused. In general we don't want to add code to the client that we do not use in testing.

That should give you a bit to work on!

jamillambert

There are some missing renames, relates to issue #298. I haven't necessarily highlighted all of them.

jamillambert · 2025-07-18T17:35:20Z

types/src/v19/blockchain/mod.rs

+    /// The current block height (index)
+    pub height: u64,
+    /// The hash of the block at the tip of the chain
+    pub bestblock: String,


Suggested change

pub bestblock: String,

#[serde(rename = "bestblock")]

pub best_block: String,

jamillambert · 2025-07-18T17:37:08Z

types/src/v19/blockchain/mod.rs

+    #[serde(rename = "scriptPubKey")]
+    pub script_pubkey: String,
+    /// An output descriptor
+    pub desc: String,


Suggested change

pub desc: String,

#[serde(rename = "desc")]

pub descriptor: String,

jamillambert · 2025-07-18T17:38:26Z

types/src/v25/blockchain/mod.rs

+    /// The current block height (index)
+    pub height: u64,
+    /// The hash of the block at the tip of the chain
+    pub bestblock: String,


Suggested change

pub bestblock: String,

#[serde(rename = "bestblock")]

pub best_block: String,

jamillambert · 2025-07-18T17:38:52Z

types/src/v28/blockchain/mod.rs

+    /// The current block height (index)
+    pub height: u64,
+    /// The hash of the block at the tip of the chain
+    pub bestblock: String,


Suggested change

pub bestblock: String,

#[serde(rename = "bestblock")]

pub best_block: String,

jamillambert · 2025-07-18T17:39:17Z

types/src/v28/blockchain/mod.rs

+    #[serde(rename = "scriptPubKey")]
+    pub script_pubkey: String,
+    /// An output descriptor
+    pub desc: String,


Suggested change

pub desc: String,

#[serde(rename = "desc")]

pub descriptor: String,

jamillambert · 2025-07-18T17:39:50Z

types/src/v28/blockchain/mod.rs

+    /// Height of the unspent transaction output
+    pub height: u64,
+    /// Blockhash of the unspent transaction output
+    pub blockhash: String,


Suggested change

pub blockhash: String,

#[serde(rename = "blockhash")]

pub block_hash: String,

GideonBature force-pushed the scantxoutset branch 3 times, most recently from 63e4f61 to 67b03b6 Compare May 12, 2025 23:49

GideonBature force-pushed the scantxoutset branch from 67b03b6 to 43c8b61 Compare May 14, 2025 17:33

tcharding reviewed May 15, 2025

View reviewed changes

GideonBature force-pushed the scantxoutset branch from 43c8b61 to 9b7f019 Compare May 15, 2025 20:58

GideonBature force-pushed the scantxoutset branch from 9b7f019 to 1a3bd20 Compare May 15, 2025 21:10

GideonBature force-pushed the scantxoutset branch from 1a3bd20 to 901bf21 Compare May 18, 2025 13:34

tcharding marked this pull request as draft May 27, 2025 05:41

GideonBature closed this May 31, 2025

GideonBature deleted the scantxoutset branch May 31, 2025 08:09

GideonBature restored the scantxoutset branch May 31, 2025 08:35

GideonBature reopened this May 31, 2025

github-actions bot added C-client C-integration-test C-types labels May 31, 2025

Implement scantxoutset method and test

1bcfa84

GideonBature force-pushed the scantxoutset branch from 901bf21 to 1bcfa84 Compare July 15, 2025 14:41

GideonBature marked this pull request as ready for review July 15, 2025 14:42

Format code

4c0d8c7

GideonBature requested a review from tcharding July 15, 2025 14:50

tcharding reviewed Jul 15, 2025

View reviewed changes

jamillambert reviewed Jul 18, 2025

View reviewed changes

		#[serde(rename = "scriptPubKey")]
		pub script_pubkey: ScriptBuf,

	pub bestblock: String,
	#[serde(rename = "bestblock")]
	pub best_block: String,

	pub desc: String,
	#[serde(rename = "desc")]
	pub descriptor: String,

	pub blockhash: String,
	#[serde(rename = "blockhash")]
	pub block_hash: String,

Implement scantxoutset method and test #164

Are you sure you want to change the base?

Implement scantxoutset method and test #164

Conversation

GideonBature commented May 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

tcharding commented May 13, 2025

Uh oh!

GideonBature commented May 13, 2025

Uh oh!

tcharding commented May 13, 2025

Uh oh!

GideonBature commented May 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

tcharding commented May 15, 2025

Uh oh!

tcharding commented May 15, 2025

Uh oh!

tcharding commented May 15, 2025 • 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!

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!

GideonBature commented May 15, 2025

Uh oh!

GideonBature commented May 15, 2025

Uh oh!

GideonBature commented May 15, 2025

Uh oh!

GideonBature commented May 15, 2025

Uh oh!

tcharding commented May 16, 2025

Uh oh!

tcharding commented May 27, 2025

Uh oh!

GideonBature commented May 28, 2025

Uh oh!

GideonBature commented Jul 15, 2025

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

Choose a reason for hiding this comment

Uh oh!

jamillambert 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!

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!

Uh oh!

GideonBature commented May 12, 2025 •

edited

Loading

GideonBature commented May 14, 2025 •

edited

Loading

tcharding commented May 15, 2025 •

edited

Loading

jamillambert left a comment •

edited

Loading