wallet: implement GetInfo endpoint (#170)

Author: torkelrogstad

cusf_sidechain_proto

@@ -47,8 +47,9 @@ use crate::{
             GetBlockInfoResponse, GetBmmHStarCommitmentRequest, GetBmmHStarCommitmentResponse,
             GetChainInfoRequest, GetChainInfoResponse, GetChainTipRequest, GetChainTipResponse,
             GetCoinbasePsbtRequest, GetCoinbasePsbtResponse, GetCtipRequest, GetCtipResponse,
-            GetSidechainProposalsRequest, GetSidechainProposalsResponse, GetSidechainsRequest,
-            GetSidechainsResponse, GetTwoWayPegDataRequest, GetTwoWayPegDataResponse,
+            GetInfoRequest, GetInfoResponse, GetSidechainProposalsRequest,
+            GetSidechainProposalsResponse, GetSidechainsRequest, GetSidechainsResponse,
+            GetTwoWayPegDataRequest, GetTwoWayPegDataResponse,
             ListSidechainDepositTransactionsRequest, ListSidechainDepositTransactionsResponse,
             ListTransactionsRequest, ListTransactionsResponse, ListUnspentOutputsRequest,
             ListUnspentOutputsResponse, Network, SendTransactionRequest, SendTransactionResponse,
@@ -697,6 +698,36 @@ impl WalletService for crate::wallet::Wallet {
 
     type GenerateBlocksStream = BoxStream<'static, Result<GenerateBlocksResponse, tonic::Status>>;
 
+    async fn get_info(
+        &self,
+        _request: tonic::Request<GetInfoRequest>,
+    ) -> Result<tonic::Response<GetInfoResponse>, tonic::Status> {
+        let info = self
+            .get_wallet_info()
+            .await
+            .map_err(|err| err.into_status())?;
+
+        let response = GetInfoResponse {
+            network: info.network.to_string(),
+            transaction_count: info.transaction_count as u32,
+            unspent_output_count: info.unspent_output_count as u32,
+            descriptors: info
+                .keychain_descriptors
+                .iter()
+                .map(|(kind, descriptor)| {
+                    (
+                        match kind {
+                            bdk_wallet::KeychainKind::External => "external".to_string(),
+                            bdk_wallet::KeychainKind::Internal => "internal".to_string(),
+                        },
+                        descriptor.to_string(),
+                    )
+                })
+                .collect(),
+        };
+        Ok(tonic::Response::new(response))
+    }
+
     async fn create_sidechain_proposal(
         &self,
         request: tonic::Request<CreateSidechainProposalRequest>,

lib/server.rs

@@ -705,6 +705,17 @@ pub struct CreateTransactionParams {
     pub required_utxos: Vec<bdk_wallet::bitcoin::OutPoint>,
 }
 
+pub struct WalletInfo {
+    // Public (i.e. without private keys) descriptors for the wallet
+    pub keychain_descriptors: std::collections::HashMap<
+        bdk_wallet::KeychainKind,
+        bdk_wallet::descriptor::ExtendedDescriptor,
+    >,
+    pub network: bdk_wallet::bitcoin::Network,
+    pub transaction_count: usize,
+    pub unspent_output_count: usize,
+}
+
 /// Cheap to clone, since it uses Arc internally
 #[derive(Clone)]
 pub struct Wallet {
@@ -1737,6 +1748,21 @@ impl Wallet {
         }
     }
 
+    pub async fn get_wallet_info(&self) -> Result<WalletInfo> {
+        let w = self.inner.read_wallet().await?;
+        let mut keychain_descriptors = std::collections::HashMap::new();
+        for (kind, _) in w.keychains() {
+            keychain_descriptors.insert(kind, w.public_descriptor(kind).clone());
+        }
+
+        Ok(WalletInfo {
+            keychain_descriptors,
+            network: w.network(),
+            transaction_count: w.transactions().count(),
+            unspent_output_count: w.list_unspent().count(),
+        })
+    }
+
     #[allow(clippy::significant_drop_tightening)]
     pub async fn get_new_address(&self) -> Result<bdk_wallet::bitcoin::Address> {
         // Using next_unused_address here means that we get a new address