feat: add frigate electrum based RPC methods by sdmg15 · Pull Request #16 · bitcoindevkit/electrum_streaming_client

sdmg15 · 2026-04-29T20:02:07Z

This PR adds supports for additional RPC methods provided by Frigate electrum based RPC server.

The added methods are:

server.version: This is the first message sent to establish connection with server
blockchain.silentpayments.subscribe: This takes a spend public key and a scan private key and return outputs belonging to the them.
blockchain.silentpayments.unsubscribe: This takes a spend public key and a scan private key and unsubscribe from notifications.

Some context:
This is useful for the PR opened at bitcoindevkit/bdk-sp#48 which is doing integration of frigate ephemeral scanning.
Opening this PR in order to receive feedback.

Reference:
https://github.com/sparrowwallet/frigate/

Supported Frigate version 1.3.2

evanlinjin · 2026-05-06T16:45:48Z

Thanks for the PR! Note that it needs a rebase now with the recent merges.

… `blockchain.silentpayments.unsubscribe`

oleonardolima

In https://github.com/sparrowwallet/frigate#serverfeatures it mentions the new field in server.features, is it not needed by bdk-sp ?

oleonardolima · 2026-07-14T14:36:48Z

@sdmg15 I just thought this now during the call, but you could also try adding support for these in https://github.com/bitcoindevkit/rust-electrum-client, not sure if the architecture there supports it though.

noahjoeris

Thanks for updating @sdmg15 !
I left a few more comments

…rsion

sdmg15 · 2026-08-04T08:06:14Z

@noahjoeris Thanks for the reviews. I've applied the changes.

noahjoeris

Thanks again for updating man. Almost there 🚀

Could you also add doc comments to the pub fields you added?

noahjoeris · 2026-08-10T10:13:42Z

    GetFeeHistogram,
    Banner,
    Ping,
-    Custom


any reason you dropped Custom here?

Thanks for catching this, I chose the wrong gen_pending_request_types! between the two former existing one.

noahjoeris · 2026-08-10T10:27:48Z

+        if let Some(start_height) = self.start_height {
+            params.push(start_height.into());
+        }
+
+        if let Some(labels) = &self.labels {
+            params.push(serde_json::Value::Null);
+            params.push(labels.clone().into());
+        }


This is not correct like this.

Suggested change

if let Some(start_height) = self.start_height {

params.push(start_height.into());

}

if let Some(labels) = &self.labels {

params.push(serde_json::Value::Null);

params.push(labels.clone().into());

}

match (self.start_height, &self.labels) {

(Some(start_height), Some(labels)) => {

params.extend([start_height.into(), labels.clone().into()]);

}

(Some(start_height), None) => params.push(start_height.into()),

(None, Some(labels)) => {

params.extend([serde_json::Value::Null, labels.clone().into()]);

}

(None, None) => {}

}

noahjoeris · 2026-08-10T10:39:44Z

+#[derive(Debug, Clone, Copy, PartialEq, Eq)]
+pub struct SpUnsubscribe {
+    pub scan_priv_key: bitcoin::secp256k1::SecretKey,
+    pub scan_pub_key: bitcoin::secp256k1::PublicKey,


This needs to be spend_pub_key

noahjoeris · 2026-08-10T10:56:23Z

+/// A request to subscribe to payment outputs belonging to the provided keys
+///
+/// This corresponds to the `"blockchain.silentpayments.subscribe"` Frigate Electrum RPC method.
+/// It returns The silent payment address that has been subscribed.


Suggested change

/// It returns The silent payment address that has been subscribed.

/// It returns the silent payment address that has been subscribed.

noahjoeris · 2026-08-10T11:01:09Z

+/// It returns The silent payment address that has been subscribed.This should cancel any scans that
+/// may be currently running for this address.


Suggested change

/// It returns The silent payment address that has been subscribed.This should cancel any scans that

/// may be currently running for this address.

/// It returns the silent payment address that has been unsubscribed. This should cancel any scans

/// that may be currently running for this address.

noahjoeris · 2026-08-10T11:02:00Z

+///
+/// Supported Frigate version <= 1.4.1
+///
+/// See: See: https://github.com/sparrowwallet/frigate/tree/1.4.1#blockchainsilentpaymentsunsubscribe


Suggested change

/// See: See: https://github.com/sparrowwallet/frigate/tree/1.4.1#blockchainsilentpaymentsunsubscribe

/// See: https://github.com/sparrowwallet/frigate/tree/1.4.1#blockchainsilentpaymentsunsubscribe

noahjoeris · 2026-08-10T11:09:58Z

+    }
+}
+
+/// A request to unsubscribe to payment outputs belonging to the provided keys


Suggested change

/// A request to unsubscribe to payment outputs belonging to the provided keys

/// A request to unsubscribe from payment outputs belonging to the provided keys

noahjoeris · 2026-08-10T11:12:50Z

 //!
 //! - [`Notification::Header`] for `"blockchain.headers.subscribe"`
 //! - [`Notification::ScriptHash`] for `"blockchain.scripthash.subscribe"`
+//! - [`Notification::SpSubscribe`] for `"blockchain.silentpayments.subscribe"`


This will not resolve without the frigate feature.
maybe use:

//! - `"blockchain.silentpayments.subscribe"` (requires the `frigate` feature)

noahjoeris · 2026-08-10T11:15:51Z

+///
+/// Supported Frigate version: <= 1.4.1
+///
+/// See: https://github.com/sparrowwallet/frigate/tree/1.4.1#blockchainsilentpaymentssubscribe


Suggested change

/// See: https://github.com/sparrowwallet/frigate/tree/1.4.1#blockchainsilentpaymentssubscribe

/// See: <https://github.com/sparrowwallet/frigate/tree/1.4.1#blockchainsilentpaymentssubscribe>

noahjoeris · 2026-08-10T11:18:18Z

+/// A notification indicating new confirmed transactions
+///
+/// Corresponds to `"blockchain.silentpayments.subscribe"` Frigate Electrum notification method


Suggested change

/// A notification indicating new confirmed transactions

///

/// Corresponds to `"blockchain.silentpayments.subscribe"` Frigate Electrum notification method

/// A notification indicating new transactions.

///

/// Corresponds to `"blockchain.silentpayments.subscribe"` Frigate Electrum notification method.

sdmg15 changed the title ~~feat: add server.version, blockchain.silentpayments.subscribe and blockchain.silentpayments.unsubscribe~~ feat: add frigate electrum based RPC methods Apr 29, 2026

sdmg15 force-pushed the master branch 2 times, most recently from 225fc0c to 885cd2f Compare April 30, 2026 17:00

sdmg15 marked this pull request as ready for review May 1, 2026 14:32

notmandatory mentioned this pull request May 7, 2026

Socratic Seminar #43 NashBitDevs/nashbitdevs.org#134

Closed

evanlinjin requested changes May 7, 2026

View reviewed changes

sdmg15 force-pushed the master branch from 885cd2f to 7ffabc2 Compare May 7, 2026 14:30

sdmg15 requested a review from oleonardolima as a code owner May 7, 2026 14:30

feat: add server.version, blockchain.silentpayments.subscribe and…

4c80f38

… `blockchain.silentpayments.unsubscribe`

sdmg15 force-pushed the master branch from 7ffabc2 to 4c80f38 Compare May 7, 2026 15:14

sdmg15 requested a review from evanlinjin May 14, 2026 15:01

oleonardolima reviewed May 26, 2026

View reviewed changes

Comment thread src/request.rs Outdated

Comment thread src/request.rs

oleonardolima assigned sdmg15 May 26, 2026

oleonardolima added the enhancement New feature or request label May 26, 2026

sdmg15 requested a review from oleonardolima July 3, 2026 12:44

noahjoeris requested changes Jul 21, 2026

View reviewed changes

Comment thread src/notification.rs

Comment thread src/notification.rs Outdated

Comment thread src/request.rs

fix: consistency with current implementation

3a63c94

sdmg15 requested a review from noahjoeris August 3, 2026 08:26

noahjoeris requested changes Aug 3, 2026

View reviewed changes

Comment thread src/request.rs Outdated

Comment thread src/notification.rs Outdated

Comment thread src/request.rs Outdated

Comment thread src/request.rs Outdated

Comment thread src/pending_request.rs Outdated

Comment thread src/request.rs Outdated

sdmg15 added 2 commits August 4, 2026 08:58

feat: allow gen_pending_request_types to support cfg feature attribute

99312db

fix: remove server.version, make comment doc clear about supported ve…

df15c6b

…rsion

noahjoeris requested changes Aug 10, 2026

View reviewed changes

fix: doc comments and logic fix

120356e

-        if let Some(start_height) = self.start_height {
-            params.push(start_height.into());
-        }
-        if let Some(labels) = &self.labels {
-            params.push(serde_json::Value::Null);
-            params.push(labels.clone().into());
-        }
+       match (self.start_height, &self.labels) {
+            (Some(start_height), Some(labels)) => {
+                params.extend([start_height.into(), labels.clone().into()]);
+            }
+            (Some(start_height), None) => params.push(start_height.into()),
+            (None, Some(labels)) => {
+                params.extend([serde_json::Value::Null, labels.clone().into()]);
+            }
+            (None, None) => {}
+        }

	/// It returns The silent payment address that has been subscribed.
	/// It returns the silent payment address that has been subscribed.

		/// It returns The silent payment address that has been subscribed.This should cancel any scans that
		/// may be currently running for this address.

	/// See: See: https://github.com/sparrowwallet/frigate/tree/1.4.1#blockchainsilentpaymentsunsubscribe
	/// See: https://github.com/sparrowwallet/frigate/tree/1.4.1#blockchainsilentpaymentsunsubscribe

	/// A request to unsubscribe to payment outputs belonging to the provided keys
	/// A request to unsubscribe from payment outputs belonging to the provided keys

	/// See: https://github.com/sparrowwallet/frigate/tree/1.4.1#blockchainsilentpaymentssubscribe
	/// See: <https://github.com/sparrowwallet/frigate/tree/1.4.1#blockchainsilentpaymentssubscribe>

Uh oh!

Conversation

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

Uh oh!

Uh oh!

evanlinjin commented May 6, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

oleonardolima left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

oleonardolima commented Jul 14, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

noahjoeris left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sdmg15 commented Aug 4, 2026

Uh oh!

noahjoeris left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sdmg15 Aug 10, 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!

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!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

sdmg15 commented Apr 29, 2026 •

edited

Loading

sdmg15 Aug 10, 2026 •

edited

Loading