rust-bitcoin · tcharding · Jun 16, 2025 · Jun 1, 2025 · Jun 3, 2025
diff --git a/client/src/client_sync/v17/mod.rs b/client/src/client_sync/v17/mod.rs
@@ -79,6 +79,7 @@ crate::impl_client_v17__get_connection_count!();
 crate::impl_client_v17__get_net_totals!();
 crate::impl_client_v17__get_network_info!();
 crate::impl_client_v17__get_peer_info!();
+crate::impl_client_v17__list_banned!();
 crate::impl_client_v17__ping!();
 crate::impl_client_v17__set_ban!();
 crate::impl_client_v17__set_network_active!();

diff --git a/client/src/client_sync/v17/network.rs b/client/src/client_sync/v17/network.rs
@@ -119,6 +119,16 @@ macro_rules! impl_client_v17__get_peer_info {
     };
 }
 
+/// Implements Bitcoin Core JSON-RPC API method `listbanned`
+#[macro_export]
+macro_rules! impl_client_v17__list_banned {
+    () => {
+        impl Client {
+            pub fn list_banned(&self) -> Result<ListBanned> { self.call("listbanned", &[]) }
+        }
+    };
+}
+
 /// Implements Bitcoin Core JSON-RPC API method `ping`
 #[macro_export]
 macro_rules! impl_client_v17__ping {

diff --git a/client/src/client_sync/v18/mod.rs b/client/src/client_sync/v18/mod.rs
@@ -88,6 +88,7 @@ crate::impl_client_v17__get_net_totals!();
 crate::impl_client_v17__get_network_info!();
 crate::impl_client_v18__get_node_addresses!();
 crate::impl_client_v17__get_peer_info!();
+crate::impl_client_v17__list_banned!();
 crate::impl_client_v17__ping!();
 crate::impl_client_v17__set_ban!();
 crate::impl_client_v17__set_network_active!();

diff --git a/client/src/client_sync/v19/mod.rs b/client/src/client_sync/v19/mod.rs
@@ -83,6 +83,7 @@ crate::impl_client_v17__get_net_totals!();
 crate::impl_client_v17__get_network_info!();
 crate::impl_client_v18__get_node_addresses!();
 crate::impl_client_v17__get_peer_info!();
+crate::impl_client_v17__list_banned!();
 crate::impl_client_v17__ping!();
 crate::impl_client_v17__set_ban!();
 crate::impl_client_v17__set_network_active!();

diff --git a/client/src/client_sync/v20/mod.rs b/client/src/client_sync/v20/mod.rs
@@ -80,6 +80,7 @@ crate::impl_client_v17__get_net_totals!();
 crate::impl_client_v17__get_network_info!();
 crate::impl_client_v18__get_node_addresses!();
 crate::impl_client_v17__get_peer_info!();
+crate::impl_client_v17__list_banned!();
 crate::impl_client_v17__ping!();
 crate::impl_client_v17__set_ban!();
 crate::impl_client_v17__set_network_active!();

diff --git a/client/src/client_sync/v21/mod.rs b/client/src/client_sync/v21/mod.rs
@@ -82,6 +82,7 @@ crate::impl_client_v17__get_net_totals!();
 crate::impl_client_v17__get_network_info!();
 crate::impl_client_v18__get_node_addresses!();
 crate::impl_client_v17__get_peer_info!();
+crate::impl_client_v17__list_banned!();
 crate::impl_client_v17__ping!();
 crate::impl_client_v17__set_ban!();
 crate::impl_client_v17__set_network_active!();

diff --git a/client/src/client_sync/v22/mod.rs b/client/src/client_sync/v22/mod.rs
@@ -82,6 +82,7 @@ crate::impl_client_v17__get_net_totals!();
 crate::impl_client_v17__get_network_info!();
 crate::impl_client_v18__get_node_addresses!();
 crate::impl_client_v17__get_peer_info!();
+crate::impl_client_v17__list_banned!();
 crate::impl_client_v17__ping!();
 crate::impl_client_v17__set_ban!();
 crate::impl_client_v17__set_network_active!();

diff --git a/client/src/client_sync/v23/mod.rs b/client/src/client_sync/v23/mod.rs
@@ -84,6 +84,7 @@ crate::impl_client_v17__get_net_totals!();
 crate::impl_client_v17__get_network_info!();
 crate::impl_client_v18__get_node_addresses!();
 crate::impl_client_v17__get_peer_info!();
+crate::impl_client_v17__list_banned!();
 crate::impl_client_v17__ping!();
 crate::impl_client_v17__set_ban!();
 crate::impl_client_v17__set_network_active!();

diff --git a/client/src/client_sync/v24/mod.rs b/client/src/client_sync/v24/mod.rs
@@ -81,6 +81,7 @@ crate::impl_client_v17__get_net_totals!();
 crate::impl_client_v17__get_network_info!();
 crate::impl_client_v18__get_node_addresses!();
 crate::impl_client_v17__get_peer_info!();
+crate::impl_client_v17__list_banned!();
 crate::impl_client_v17__ping!();
 crate::impl_client_v17__set_ban!();
 crate::impl_client_v17__set_network_active!();

diff --git a/client/src/client_sync/v25/mod.rs b/client/src/client_sync/v25/mod.rs
@@ -81,6 +81,7 @@ crate::impl_client_v17__get_net_totals!();
 crate::impl_client_v17__get_network_info!();
 crate::impl_client_v18__get_node_addresses!();
 crate::impl_client_v17__get_peer_info!();
+crate::impl_client_v17__list_banned!();
 crate::impl_client_v17__ping!();
 crate::impl_client_v17__set_ban!();
 crate::impl_client_v17__set_network_active!();

diff --git a/client/src/client_sync/v26/mod.rs b/client/src/client_sync/v26/mod.rs
@@ -86,6 +86,7 @@ crate::impl_client_v17__get_net_totals!();
 crate::impl_client_v17__get_network_info!();
 crate::impl_client_v18__get_node_addresses!();
 crate::impl_client_v17__get_peer_info!();
+crate::impl_client_v17__list_banned!();
 crate::impl_client_v17__ping!();
 crate::impl_client_v17__set_ban!();
 crate::impl_client_v17__set_network_active!();

diff --git a/client/src/client_sync/v27/mod.rs b/client/src/client_sync/v27/mod.rs
@@ -82,6 +82,7 @@ crate::impl_client_v17__get_net_totals!();
 crate::impl_client_v17__get_network_info!();
 crate::impl_client_v18__get_node_addresses!();
 crate::impl_client_v17__get_peer_info!();
+crate::impl_client_v17__list_banned!();
 crate::impl_client_v17__ping!();
 crate::impl_client_v17__set_ban!();
 crate::impl_client_v17__set_network_active!();

diff --git a/client/src/client_sync/v28/mod.rs b/client/src/client_sync/v28/mod.rs
@@ -84,6 +84,7 @@ crate::impl_client_v17__get_net_totals!();
 crate::impl_client_v17__get_network_info!();
 crate::impl_client_v18__get_node_addresses!();
 crate::impl_client_v17__get_peer_info!();
+crate::impl_client_v17__list_banned!();
 crate::impl_client_v17__ping!();
 crate::impl_client_v17__set_ban!();
 crate::impl_client_v17__set_network_active!();

diff --git a/client/src/client_sync/v29/mod.rs b/client/src/client_sync/v29/mod.rs
@@ -84,6 +84,7 @@ crate::impl_client_v17__get_net_totals!();
 crate::impl_client_v17__get_network_info!();
 crate::impl_client_v18__get_node_addresses!();
 crate::impl_client_v17__get_peer_info!();
+crate::impl_client_v17__list_banned!();
 crate::impl_client_v17__ping!();
 crate::impl_client_v17__set_ban!();
 crate::impl_client_v17__set_network_active!();

diff --git a/integration_test/tests/network.rs b/integration_test/tests/network.rs
@@ -113,6 +113,20 @@ fn get_peer_info_three_node_network() {
     assert!(node3.peers_connected() >= 1);
 }
 
+#[test]
+fn network__list_banned() {
+    let node = Node::with_wallet(Wallet::None, &[]);
+    let dummy_subnet = "192.0.2.5/32";
+
+    node.client.set_ban(dummy_subnet, SetBanCommand::Add).expect("setban add");
+    let json: ListBanned = node.client.list_banned().expect("listbanned");
+    assert!(json.0.iter().any(|item| item.address == dummy_subnet));
+
+    node.client.set_ban(dummy_subnet, SetBanCommand::Remove).expect("setban remove");
+    let json: ListBanned = node.client.list_banned().expect("listbanned");
+    assert!(json.0.iter().all(|item| item.address != dummy_subnet));
+}
+
 #[test]
 fn network__ping() {
     let node = Node::with_wallet(Wallet::None, &[]);

diff --git a/types/src/v17/mod.rs b/types/src/v17/mod.rs
@@ -102,7 +102,7 @@
 //! | getnettotals                       | version         |                                        |
 //! | getnetworkinfo                     | version + model |                                        |
 //! | getpeerinfo                        | version         |                                        |
-//! | listbanned                         | returns string  |                                        |
+//! | listbanned                         | version         |                                        |
 //! | ping                               | returns nothing |                                        |
 //! | setban                             | returns nothing |                                        |
 //! | setnetworkactive                   | version         |                                        |

diff --git a/types/src/v17/network/mod.rs b/types/src/v17/network/mod.rs
@@ -263,7 +263,17 @@ pub struct ListBanned(pub Vec<Banned>);
 
 /// An item from the list returned by the JSON-RPC method `listbanned`
 #[derive(Clone, Debug, PartialEq, Deserialize, Serialize)]
-pub struct Banned(String); // FIXME: The docs are empty so I don't know what shape this is.
+pub struct Banned {
+    // NOTE: Shape taken from Core source code,as method is undocumented in the Bitcoin RPC CLI for version 17 to 20.
+    /// The IP/Subnet of the banned node.
+    pub address: String,
+    /// The UNIX epoch time the ban was expires.
+    pub banned_until: u32,
+    /// The UNIX epoch time the ban was created.
+    pub ban_created: u32,
+    /// The reason for the ban.
+    pub ban_reason: String,
+}
 
 /// Result of JSON-RPC method `setnetworkactive`.
 ///

diff --git a/types/src/v18/mod.rs b/types/src/v18/mod.rs
@@ -105,7 +105,7 @@
 //! | getnetworkinfo                     | version + model |                                        |
 //! | getnodeaddresses                   | version + model |                                        |
 //! | getpeerinfo                        | version         |                                        |
-//! | listbanned                         | returns string  |                                        |
+//! | listbanned                         | version         |                                        |
 //! | ping                               | returns nothing |                                        |
 //! | setban                             | returns nothing |                                        |
 //! | setnetworkactive                   | version         |                                        |

diff --git a/types/src/v19/mod.rs b/types/src/v19/mod.rs
@@ -105,7 +105,7 @@
 //! | getnetworkinfo                     | version + model |                                        |
 //! | getnodeaddresses                   | version + model |                                        |
 //! | getpeerinfo                        | version         |                                        |
-//! | listbanned                         | returns string  |                                        |
+//! | listbanned                         | version         |                                        |
 //! | ping                               | returns nothing |                                        |
 //! | setban                             | returns nothing |                                        |
 //! | setnetworkactive                   | version         |                                        |

diff --git a/types/src/v20/mod.rs b/types/src/v20/mod.rs
@@ -106,7 +106,7 @@
 //! | getnetworkinfo                     | version + model |                                        |
 //! | getnodeaddresses                   | version + model |                                        |
 //! | getpeerinfo                        | version         |                                        |
-//! | listbanned                         | returns string  |                                        |
+//! | listbanned                         | version         |                                        |
 //! | ping                               | returns nothing |                                        |
 //! | setban                             | returns nothing |                                        |
 //! | setnetworkactive                   | version         |                                        |
@@ -227,18 +227,22 @@
 
 // JSON-RPC types by API section.
 mod control;
+mod network;
 
 #[doc(inline)]
-pub use self::control::Logging;
+pub use self::{
+    control::Logging,
+    network::{Banned, ListBanned},
+};
 #[doc(inline)]
 pub use crate::{
     v17::{
         AbortRescan, AddMultisigAddress, AddMultisigAddressError, AddedNode, AddedNodeAddress,
-        AddressInformation, Banned, BumpFee, BumpFeeError, ChainTips, ChainTipsError,
-        ChainTipsStatus, CombinePsbt, CombineRawTransaction, ConvertToPsbt, CreateMultisig,
-        CreateMultisigError, CreatePsbt, CreateRawTransaction, CreateWallet, DecodePsbt,
-        DecodePsbtError, DecodeRawTransaction, DecodeScript, DecodeScriptError, DumpPrivKey,
-        DumpWallet, EstimateSmartFee, FinalizePsbt, FinalizePsbtError, FundRawTransaction,
+        AddressInformation, BumpFee, BumpFeeError, ChainTips, ChainTipsError, ChainTipsStatus,
+        CombinePsbt, CombineRawTransaction, ConvertToPsbt, CreateMultisig, CreateMultisigError,
+        CreatePsbt, CreateRawTransaction, CreateWallet, DecodePsbt, DecodePsbtError,
+        DecodeRawTransaction, DecodeScript, DecodeScriptError, DumpPrivKey, DumpWallet,
+        EstimateSmartFee, FinalizePsbt, FinalizePsbtError, FundRawTransaction,
         FundRawTransactionError, Generate, GenerateToAddress, GetAddedNodeInfo, GetAddressInfo,
         GetAddressInfoEmbedded, GetAddressInfoEmbeddedError, GetAddressInfoError,
         GetAddressInfoLabel, GetAddressesByLabel, GetBalance, GetBestBlockHash, GetBlockCount,
@@ -253,18 +257,18 @@ pub use crate::{
         GetReceivedByAddress, GetTransaction, GetTransactionDetail, GetTransactionDetailError,
         GetTransactionError, GetTxOut, GetTxOutError, GetTxOutSetInfo, GetTxOutSetInfoError,
         GetUnconfirmedBalance, GetWalletInfo, GetWalletInfoError, GetZmqNotifications,
-        ListAddressGroupings, ListAddressGroupingsError, ListAddressGroupingsItem, ListBanned,
-        ListLabels, ListLockUnspent, ListLockUnspentItem, ListLockUnspentItemError,
-        ListReceivedByAddress, ListReceivedByAddressError, ListReceivedByAddressItem,
-        ListSinceBlock, ListSinceBlockError, ListSinceBlockTransaction,
-        ListSinceBlockTransactionError, ListTransactions, ListTransactionsItem,
-        ListTransactionsItemError, ListUnspentItemError, ListWallets, LoadWallet, Locked, PeerInfo,
-        PruneBlockchain, RawTransactionError, RawTransactionInput, RawTransactionOutput,
-        RescanBlockchain, SendMany, SendRawTransaction, SendToAddress, SetNetworkActive,
-        SignMessage, SignMessageWithPrivKey, SignRawTransaction, SignRawTransactionError,
-        SoftforkReject, TestMempoolAccept, TransactionCategory, UploadTarget, ValidateAddress,
-        ValidateAddressError, VerifyChain, VerifyMessage, VerifyTxOutProof, WalletCreateFundedPsbt,
-        WalletCreateFundedPsbtError, WalletProcessPsbt, WitnessUtxo,
+        ListAddressGroupings, ListAddressGroupingsError, ListAddressGroupingsItem, ListLabels,
+        ListLockUnspent, ListLockUnspentItem, ListLockUnspentItemError, ListReceivedByAddress,
+        ListReceivedByAddressError, ListReceivedByAddressItem, ListSinceBlock, ListSinceBlockError,
+        ListSinceBlockTransaction, ListSinceBlockTransactionError, ListTransactions,
+        ListTransactionsItem, ListTransactionsItemError, ListUnspentItemError, ListWallets,
+        LoadWallet, Locked, PeerInfo, PruneBlockchain, RawTransactionError, RawTransactionInput,
+        RawTransactionOutput, RescanBlockchain, SendMany, SendRawTransaction, SendToAddress,
+        SetNetworkActive, SignMessage, SignMessageWithPrivKey, SignRawTransaction,
+        SignRawTransactionError, SoftforkReject, TestMempoolAccept, TransactionCategory,
+        UploadTarget, ValidateAddress, ValidateAddressError, VerifyChain, VerifyMessage,
+        VerifyTxOutProof, WalletCreateFundedPsbt, WalletCreateFundedPsbtError, WalletProcessPsbt,
+        WitnessUtxo,
     },
     v18::{
         ActiveCommand, AnalyzePsbt, AnalyzePsbtError, AnalyzePsbtInput, AnalyzePsbtInputMissing,

diff --git a/types/src/v20/network.rs b/types/src/v20/network.rs
@@ -0,0 +1,26 @@
+// SPDX-License-Identifier: CC0-1.0
+
+//! The JSON-RPC API for Bitcoin Core `v0.20.2` - network.
+//!
+//! Types for methods found under the `== Network ==` section of the API docs.
+
+use serde::{Deserialize, Serialize};
+
+/// Result of JSON-RPC method `listbanned`.
+///
+/// > listbanned
+///
+/// > List all banned IPs/Subnets.
+#[derive(Clone, Debug, PartialEq, Deserialize, Serialize)]
+pub struct ListBanned(pub Vec<Banned>);
+
+/// An item from the list returned by the JSON-RPC method `listbanned`
+#[derive(Clone, Debug, PartialEq, Deserialize, Serialize)]
+pub struct Banned {
+    /// The IP/Subnet of the banned node.
+    pub address: String,
+    /// The UNIX epoch time the ban was expires.
+    pub banned_until: u32,
+    /// The UNIX epoch time the ban was created.
+    pub ban_created: u32,
+}
diff --git a/types/src/v21/mod.rs b/types/src/v21/mod.rs
@@ -107,7 +107,7 @@
 //! | getnetworkinfo                     | version + model |                                        |
 //! | getnodeaddresses                   | version + model |                                        |
 //! | getpeerinfo                        | version         |                                        |
-//! | listbanned                         | returns string  |                                        |
+//! | listbanned                         | version         |                                        |
 //! | ping                               | returns nothing |                                        |
 //! | setban                             | returns nothing |                                        |
 //! | setnetworkactive                   | version         |                                        |
@@ -240,11 +240,11 @@ pub use self::wallet::UnloadWallet;
 pub use crate::{
     v17::{
         AbortRescan, AddMultisigAddress, AddMultisigAddressError, AddedNode, AddedNodeAddress,
-        AddressInformation, Banned, BumpFee, BumpFeeError, ChainTips, ChainTipsError,
-        ChainTipsStatus, CombinePsbt, CombineRawTransaction, ConvertToPsbt, CreateMultisig,
-        CreateMultisigError, CreatePsbt, CreateRawTransaction, CreateWallet, DecodePsbt,
-        DecodePsbtError, DecodeRawTransaction, DecodeScript, DecodeScriptError, DumpPrivKey,
-        DumpWallet, EstimateSmartFee, FinalizePsbt, FinalizePsbtError, FundRawTransaction,
+        AddressInformation, BumpFee, BumpFeeError, ChainTips, ChainTipsError, ChainTipsStatus,
+        CombinePsbt, CombineRawTransaction, ConvertToPsbt, CreateMultisig, CreateMultisigError,
+        CreatePsbt, CreateRawTransaction, CreateWallet, DecodePsbt, DecodePsbtError,
+        DecodeRawTransaction, DecodeScript, DecodeScriptError, DumpPrivKey, DumpWallet,
+        EstimateSmartFee, FinalizePsbt, FinalizePsbtError, FundRawTransaction,
         FundRawTransactionError, Generate, GenerateToAddress, GetAddedNodeInfo, GetAddressInfo,
         GetAddressInfoEmbedded, GetAddressInfoEmbeddedError, GetAddressInfoError,
         GetAddressInfoLabel, GetAddressesByLabel, GetBalance, GetBestBlockHash, GetBlockCount,
@@ -259,18 +259,18 @@ pub use crate::{
         GetReceivedByAddress, GetTransaction, GetTransactionDetail, GetTransactionDetailError,
         GetTransactionError, GetTxOut, GetTxOutError, GetTxOutSetInfo, GetTxOutSetInfoError,
         GetUnconfirmedBalance, GetWalletInfo, GetWalletInfoError, GetZmqNotifications,
-        ListAddressGroupings, ListAddressGroupingsError, ListAddressGroupingsItem, ListBanned,
-        ListLabels, ListLockUnspent, ListLockUnspentItem, ListLockUnspentItemError,
-        ListReceivedByAddress, ListReceivedByAddressError, ListReceivedByAddressItem,
-        ListSinceBlock, ListSinceBlockError, ListSinceBlockTransaction,
-        ListSinceBlockTransactionError, ListTransactions, ListTransactionsItem,
-        ListTransactionsItemError, ListUnspentItemError, ListWallets, LoadWallet, Locked, PeerInfo,
-        PruneBlockchain, RawTransactionError, RawTransactionInput, RawTransactionOutput,
-        RescanBlockchain, SendMany, SendRawTransaction, SendToAddress, SetNetworkActive,
-        SignMessage, SignMessageWithPrivKey, SignRawTransaction, SignRawTransactionError,
-        SoftforkReject, TestMempoolAccept, TransactionCategory, UploadTarget, ValidateAddress,
-        ValidateAddressError, VerifyChain, VerifyMessage, VerifyTxOutProof, WalletCreateFundedPsbt,
-        WalletCreateFundedPsbtError, WalletProcessPsbt, WitnessUtxo,
+        ListAddressGroupings, ListAddressGroupingsError, ListAddressGroupingsItem, ListLabels,
+        ListLockUnspent, ListLockUnspentItem, ListLockUnspentItemError, ListReceivedByAddress,
+        ListReceivedByAddressError, ListReceivedByAddressItem, ListSinceBlock, ListSinceBlockError,
+        ListSinceBlockTransaction, ListSinceBlockTransactionError, ListTransactions,
+        ListTransactionsItem, ListTransactionsItemError, ListUnspentItemError, ListWallets,
+        LoadWallet, Locked, PeerInfo, PruneBlockchain, RawTransactionError, RawTransactionInput,
+        RawTransactionOutput, RescanBlockchain, SendMany, SendRawTransaction, SendToAddress,
+        SetNetworkActive, SignMessage, SignMessageWithPrivKey, SignRawTransaction,
+        SignRawTransactionError, SoftforkReject, TestMempoolAccept, TransactionCategory,
+        UploadTarget, ValidateAddress, ValidateAddressError, VerifyChain, VerifyMessage,
+        VerifyTxOutProof, WalletCreateFundedPsbt, WalletCreateFundedPsbtError, WalletProcessPsbt,
+        WitnessUtxo,
     },
     v18::{
         ActiveCommand, AnalyzePsbt, AnalyzePsbtError, AnalyzePsbtInput, AnalyzePsbtInputMissing,
@@ -286,5 +286,5 @@ pub use crate::{
         MempoolEntry, MempoolEntryError, MempoolEntryFees, MempoolEntryFeesError, Softfork,
         SoftforkType,
     },
-    v20::Logging,
+    v20::{Banned, ListBanned, Logging},
 };