complete listunspents and refresh APIs

Author: zoedberg

openapi.yaml

@@ -2263,8 +2263,12 @@ components:
     ListUnspentsRequest:
       type: object
       required:
+        - settled_only
         - skip_sync
       properties:
+        settled_only:
+          type: boolean
+          example: false
         skip_sync:
           type: boolean
           example: false
@@ -2638,14 +2642,39 @@ components:
       enum:
         - Blind
         - Witness
+    RefreshFilter:
+      type: object
+      required:
+        - status
+        - incoming
+      properties:
+        status:
+          $ref: '#/components/schemas/RefreshTransferStatus'
+        incoming:
+          type: boolean
     RefreshRequest:
       type: object
       required:
+        - filter
         - skip_sync
       properties:
+        asset_id:
+          type: string
+          nullable: true
+          example: rgb:2dkSTbr-jFhznbPmo-TQafzswCN-av4gTsJjX-ttx6CNou5-M98k8Zd
+        filter:
+          type: array
+          items:
+            $ref: '#/components/schemas/RefreshFilter'
+          example: []
         skip_sync:
           type: boolean
           example: false
+    RefreshTransferStatus:
+      type: string
+      enum:
+        - WaitingCounterparty
+        - WaitingConfirmations
     RestoreRequest:
       type: object
       required:

src/ldk.rs

@@ -1306,8 +1306,8 @@ async fn handle_ldk_events(
             );
 
             tokio::task::spawn_blocking(move || {
-                unlocked_state.rgb_refresh(false).unwrap();
-                unlocked_state.rgb_refresh(true).unwrap()
+                unlocked_state.rgb_refresh(None, vec![], false).unwrap();
+                unlocked_state.rgb_refresh(None, vec![], true).unwrap()
             })
             .await
             .unwrap();

src/rgb.rs

@@ -18,7 +18,7 @@ use rgb_lib::{
     wallet::{
         rust_only::{check_proxy_url, ColoringInfo},
         AssetCFA, AssetIFA, AssetNIA, AssetUDA, Assets, Balance, BtcBalance, Metadata, Online,
-        OperationResult, ReceiveData, Recipient, RefreshResult, RgbWalletOpsOffline,
+        OperationResult, ReceiveData, Recipient, RefreshFilter, RefreshResult, RgbWalletOpsOffline,
         RgbWalletOpsOnline, SendBeginResult, SinglesigKeys, SyncOptions,
         Transaction as RgbLibTransaction, Transfer, TransportEndpoint, Unspent,
         Wallet as RgbLibWallet,
@@ -226,8 +226,13 @@ impl UnlockedAppState {
         self.rgb_wallet_wrapper.list_transfers(asset_id)
     }
 
-    pub(crate) fn rgb_list_unspents(&self, skip_sync: bool) -> Result<Vec<Unspent>, RgbLibError> {
-        self.rgb_wallet_wrapper.list_unspents(skip_sync)
+    pub(crate) fn rgb_list_unspents(
+        &self,
+        settled_only: bool,
+        skip_sync: bool,
+    ) -> Result<Vec<Unspent>, RgbLibError> {
+        self.rgb_wallet_wrapper
+            .list_unspents(settled_only, skip_sync)
     }
 
     pub(crate) fn rgb_post_consignment<P: AsRef<Path>>(
@@ -247,8 +252,13 @@ impl UnlockedAppState {
         )
     }
 
-    pub(crate) fn rgb_refresh(&self, skip_sync: bool) -> Result<RefreshResult, RgbLibError> {
-        self.rgb_wallet_wrapper.refresh(skip_sync)
+    pub(crate) fn rgb_refresh(
+        &self,
+        asset_id: Option<String>,
+        filter: Vec<RefreshFilter>,
+        skip_sync: bool,
+    ) -> Result<RefreshResult, RgbLibError> {
+        self.rgb_wallet_wrapper.refresh(asset_id, filter, skip_sync)
     }
 
     pub(crate) fn rgb_save_new_asset(
@@ -597,10 +607,14 @@ impl RgbLibWalletWrapper {
         self.get_rgb_wallet().list_transfers(Some(asset_id))
     }
 
-    pub(crate) fn list_unspents(&self, skip_sync: bool) -> Result<Vec<Unspent>, RgbLibError> {
+    pub(crate) fn list_unspents(
+        &self,
+        settled_only: bool,
+        skip_sync: bool,
+    ) -> Result<Vec<Unspent>, RgbLibError> {
         let online = if skip_sync { None } else { Some(self.online) };
         self.get_rgb_wallet()
-            .list_unspents(online, false, skip_sync)
+            .list_unspents(online, settled_only, skip_sync)
     }
 
     pub(crate) fn post_consignment<P: AsRef<Path>>(
@@ -620,9 +634,14 @@ impl RgbLibWalletWrapper {
         )
     }
 
-    pub(crate) fn refresh(&self, skip_sync: bool) -> Result<RefreshResult, RgbLibError> {
+    pub(crate) fn refresh(
+        &self,
+        asset_id: Option<String>,
+        filter: Vec<RefreshFilter>,
+        skip_sync: bool,
+    ) -> Result<RefreshResult, RgbLibError> {
         self.get_rgb_wallet()
-            .refresh(self.online, None, vec![], skip_sync)
+            .refresh(self.online, asset_id, filter, skip_sync)
     }
 
     pub(crate) fn save_new_asset(

src/routes.rs

@@ -54,6 +54,7 @@ use rgb_lib::{
         AssetUDA as RgbLibAssetUDA, Balance as RgbLibBalance, EmbeddedMedia as RgbLibEmbeddedMedia,
         Invoice as RgbLibInvoice, Media as RgbLibMedia, ProofOfReserves as RgbLibProofOfReserves,
         Recipient as RgbLibRecipient, RecipientInfo, RecipientType as RgbLibRecipientType,
+        RefreshFilter as RgbLibRefreshFilter, RefreshTransferStatus as RgbLibRefreshTransferStatus,
         SyncKeychain as RgbLibSyncKeychain, SyncOptions as RgbLibSyncOptions,
         SyncStrategy as RgbLibSyncStrategy, Token as RgbLibToken, TokenLight as RgbLibTokenLight,
         WitnessData as RgbLibWitnessData,
@@ -821,6 +822,7 @@ pub(crate) struct ListTransfersResponse {
 
 #[derive(Deserialize, Serialize)]
 pub(crate) struct ListUnspentsRequest {
+    pub(crate) settled_only: bool,
     pub(crate) skip_sync: bool,
 }
 
@@ -1007,8 +1009,40 @@ impl From<RgbLibRecipientType> for RecipientType {
     }
 }
 
+#[derive(Deserialize, Serialize)]
+pub(crate) struct RefreshFilter {
+    pub(crate) status: RefreshTransferStatus,
+    pub(crate) incoming: bool,
+}
+
+impl From<RefreshFilter> for RgbLibRefreshFilter {
+    fn from(value: RefreshFilter) -> Self {
+        Self {
+            status: value.status.into(),
+            incoming: value.incoming,
+        }
+    }
+}
+
+#[derive(Deserialize, Serialize)]
+pub(crate) enum RefreshTransferStatus {
+    WaitingCounterparty,
+    WaitingConfirmations,
+}
+
+impl From<RefreshTransferStatus> for RgbLibRefreshTransferStatus {
+    fn from(value: RefreshTransferStatus) -> Self {
+        match value {
+            RefreshTransferStatus::WaitingCounterparty => Self::WaitingCounterparty,
+            RefreshTransferStatus::WaitingConfirmations => Self::WaitingConfirmations,
+        }
+    }
+}
+
 #[derive(Deserialize, Serialize)]
 pub(crate) struct RefreshRequest {
+    pub(crate) asset_id: Option<String>,
+    pub(crate) filter: Vec<RefreshFilter>,
     pub(crate) skip_sync: bool,
 }
 
@@ -2720,7 +2754,7 @@ pub(crate) async fn list_unspents(
     let unlocked_state = guard.as_ref().unwrap();
 
     let mut unspents = vec![];
-    for unspent in unlocked_state.rgb_list_unspents(payload.skip_sync)? {
+    for unspent in unlocked_state.rgb_list_unspents(payload.settled_only, payload.skip_sync)? {
         unspents.push(Unspent {
             utxo: Utxo {
                 outpoint: unspent.utxo.outpoint.to_string(),
@@ -3479,9 +3513,12 @@ pub(crate) async fn refresh_transfers(
         let unlocked_state = guard.as_ref().unwrap();
         let unlocked_state_copy = unlocked_state.clone();
 
-        tokio::task::spawn_blocking(move || unlocked_state_copy.rgb_refresh(payload.skip_sync))
-            .await
-            .unwrap()?;
+        let filter = payload.filter.into_iter().map(|f| f.into()).collect();
+        tokio::task::spawn_blocking(move || {
+            unlocked_state_copy.rgb_refresh(payload.asset_id, filter, payload.skip_sync)
+        })
+        .await
+        .unwrap()?;
 
         tracing::info!("Refresh complete");
         Ok(Json(EmptyResponse {}))

src/test/mod.rs

@@ -1036,7 +1036,10 @@ async fn list_transfers(node_address: SocketAddr, asset_id: &str) -> Vec<Transfe
 
 async fn list_unspents(node_address: SocketAddr) -> Vec<Unspent> {
     println!("listing unspents for node {node_address}");
-    let payload = ListUnspentsRequest { skip_sync: false };
+    let payload = ListUnspentsRequest {
+        settled_only: false,
+        skip_sync: false,
+    };
     let res = reqwest::Client::new()
         .post(format!("http://{node_address}/listunspents"))
         .json(&payload)
@@ -1482,7 +1485,11 @@ async fn post_asset_media(node_address: SocketAddr, file_path: &str) -> String {
 
 async fn refresh_transfers(node_address: SocketAddr) {
     println!("refreshing transfers for node {node_address}");
-    let payload = RefreshRequest { skip_sync: false };
+    let payload = RefreshRequest {
+        asset_id: None,
+        filter: vec![],
+        skip_sync: false,
+    };
     let res = reqwest::Client::new()
         .post(format!("http://{node_address}/refreshtransfers"))
         .json(&payload)