Merge pull request RGB-Tools#94 from Arshia-r-m/batch_transfer

zoedberg · web-flow · commit 0c86852a49af · 2026-02-17T11:50:53.000+01:00
feat: expose batch transfer for rgb assets
diff --git a/README.md b/README.md
@@ -244,10 +244,10 @@ The node currently exposes the following APIs:
 - `/restore` (POST)
 - `/revoketoken` (POST)
 - `/rgbinvoice` (POST)
-- `/sendasset` (POST)
 - `/sendbtc` (POST)
 - `/sendonionmessage` (POST)
 - `/sendpayment` (POST)
+- `/sendrgb` (POST)
 - `/shutdown` (POST)
 - `/signmessage` (POST)
 - `/sync` (POST)
diff --git a/openapi.yaml b/openapi.yaml
@@ -820,24 +820,6 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/RgbInvoiceResponse'
-  /sendasset:
-    post:
-      tags:
-        - RGB
-      summary: Send assets
-      description: Send RGB assets on-chain
-      requestBody:
-        content:
-          application/json:
-            schema:
-              $ref: '#/components/schemas/SendAssetRequest'
-      responses:
-        '200':
-          description: Successful operation
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/SendAssetResponse'
   /sendbtc:
     post:
       tags:
@@ -892,6 +874,24 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/SendPaymentResponse'
+  /sendrgb:
+    post:
+      tags:
+        - RGB
+      summary: Send RGB assets
+      description: Send RGB assets on-chain, supporting batch transfers to multiple recipients and/or multiple assets in a single transaction
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/SendRgbRequest'
+      responses:
+        '200':
+          description: Successful operation
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/SendRgbResponse'
   /shutdown:
     post:
       tags:
@@ -2003,6 +2003,21 @@ components:
           items:
             type: integer
           example: [6, 36, 87, 13, 5, 17]
+    Recipient:
+      type: object
+      properties:
+        recipient_id:
+          type: string
+          example: bcrt:utxob:2FZsSuk-iyVQLVuU4-Gc6J4qkE8-mLS17N4jd-MEx6cWz9F-MFkyE1n
+        witness_data:
+          $ref: '#/components/schemas/WitnessData'
+        assignment:
+          $ref: '#/components/schemas/Assignment'
+        transport_endpoints:
+          type: array
+          items:
+            type: string
+            example: rpc://127.0.0.1:3000/json-rpc
     RecipientType:
       type: string
       enum:
@@ -2072,42 +2087,6 @@ components:
         batch_transfer_idx:
           type: integer
           example: 1
-    SendAssetRequest:
-      type: object
-      properties:
-        asset_id:
-          type: string
-          example: rgb:CJkb4YZw-jRiz2sk-~PARPio-wtVYI1c-XAEYCqO-wTfvRZ8
-        assignment:
-          $ref: '#/components/schemas/AssignmentFungible'
-        recipient_id:
-          type: string
-          example: bcrt:utxob:2FZsSuk-iyVQLVuU4-Gc6J4qkE8-mLS17N4jd-MEx6cWz9F-MFkyE1n
-        witness_data:
-          $ref: '#/components/schemas/WitnessData'
-        donation:
-          type: boolean
-          example: false
-        fee_rate:
-          type: number
-          example: 5
-        min_confirmations:
-          type: integer
-          example: 1
-        transport_endpoints:
-          type: array
-          items:
-            type: string
-            example: rpc://127.0.0.1:3000/json-rpc
-        skip_sync:
-          type: boolean
-          example: false
-    SendAssetResponse:
-      type: object
-      properties:
-        txid:
-          type: string
-          example: 7c2c95b9c2aa0a7d140495b664de7973b76561de833f0dd84def3efa08941664
     SendBtcRequest:
       type: object
       properties:
@@ -2160,6 +2139,51 @@ components:
           example: 777a7756c620868199ed5fdc35bee4095b5709d543e5c2bf0494396bf27d2ea2
         status:
           $ref: '#/components/schemas/HTLCStatus'
+    SendRgbRequest:
+      type: object
+      properties:
+        donation:
+          type: boolean
+          example: false
+        fee_rate:
+          type: number
+          example: 5
+        min_confirmations:
+          type: integer
+          example: 1
+        recipient_map:
+          type: object
+          additionalProperties:
+            type: array
+            items:
+              $ref: '#/components/schemas/Recipient'
+          example:
+            rgb:CJkb4YZw-jRiz2sk-~PARPio-wtVYI1c-XAEYCqO-wTfvRZ8:
+              - recipient_id: "utxob:2FjRqgQ-eEWCVHY5-zmpFtYzT-gGm3MdR-sTnxNcS-7RtUbY9-4NYuuh"
+                assignment:
+                  Fungible: 400
+                transport_endpoints:
+                  - rpc://127.0.0.1:3000/json-rpc
+              - recipient_id: "utxob:3GkRrhR-fFXDLIZ6-0anqGuzU-hHn4NeS-tUoyOdT-8SuVcZ0-5OZvvi"
+                assignment:
+                  Fungible: 200
+                transport_endpoints:
+                  - rpc://127.0.0.1:3000/json-rpc
+            rgb:d8qDVS5X-ICVG2uM-CPr3yO4-lfBhgjt-7FN1EPE-ApY1LcM:
+              - recipient_id: "utxob:4HlSsiS-gGYEMKA7-1borHvaV-iIo5OfT-uVpzPeU-9TvWdA1-6PAwwj"
+                assignment:
+                  Fungible: 100
+                transport_endpoints:
+                  - rpc://127.0.0.1:3000/json-rpc
+        skip_sync:
+          type: boolean
+          example: false
+    SendRgbResponse:
+      type: object
+      properties:
+        txid:
+          type: string
+          example: 7c2c95b9c2aa0a7d140495b664de7973b76561de833f0dd84def3efa08941664
     SignMessageRequest:
       type: object
       properties:
diff --git a/src/main.rs b/src/main.rs
@@ -49,8 +49,8 @@ use crate::routes::{
     issue_asset_nia, issue_asset_uda, keysend, list_assets, list_channels, list_payments,
     list_peers, list_swaps, list_transactions, list_transfers, list_unspents, ln_invoice, lock,
     maker_execute, maker_init, network_info, node_info, open_channel, post_asset_media,
-    refresh_transfers, restore, revoke_token, rgb_invoice, send_asset, send_btc,
-    send_onion_message, send_payment, shutdown, sign_message, sync, taker, unlock,
+    refresh_transfers, restore, revoke_token, rgb_invoice, send_btc, send_onion_message,
+    send_payment, send_rgb, shutdown, sign_message, sync, taker, unlock,
 };
 use crate::utils::{start_daemon, AppState, LOGS_DIR};
 
@@ -149,10 +149,10 @@ pub(crate) async fn app(args: UserArgs) -> Result<(Router, Arc<AppState>), AppEr
         .route("/restore", post(restore))
         .route("/revoketoken", post(revoke_token))
         .route("/rgbinvoice", post(rgb_invoice))
-        .route("/sendasset", post(send_asset))
         .route("/sendbtc", post(send_btc))
         .route("/sendonionmessage", post(send_onion_message))
         .route("/sendpayment", post(send_payment))
+        .route("/sendrgb", post(send_rgb))
         .route("/shutdown", post(shutdown))
         .route("/signmessage", post(sign_message))
         .route("/sync", post(sync))
diff --git a/src/routes.rs b/src/routes.rs
@@ -52,9 +52,9 @@ use rgb_lib::{
         },
         AssetCFA as RgbLibAssetCFA, AssetNIA as RgbLibAssetNIA, AssetUDA as RgbLibAssetUDA,
         Balance as RgbLibBalance, EmbeddedMedia as RgbLibEmbeddedMedia, Invoice as RgbLibInvoice,
-        Media as RgbLibMedia, ProofOfReserves as RgbLibProofOfReserves, Recipient, RecipientInfo,
-        RecipientType as RgbLibRecipientType, Token as RgbLibToken, TokenLight as RgbLibTokenLight,
-        WitnessData as RgbLibWitnessData,
+        Media as RgbLibMedia, ProofOfReserves as RgbLibProofOfReserves,
+        Recipient as RgbLibRecipient, RecipientInfo, RecipientType as RgbLibRecipientType,
+        Token as RgbLibToken, TokenLight as RgbLibTokenLight, WitnessData as RgbLibWitnessData,
     },
     AssetSchema as RgbLibAssetSchema, Assignment as RgbLibAssignment,
     BitcoinNetwork as RgbLibNetwork, ContractId, RgbTransport,
@@ -918,6 +918,25 @@ pub(crate) struct RevokeTokenRequest {
     pub(crate) token: String,
 }
 
+#[derive(Deserialize, Serialize)]
+pub(crate) struct Recipient {
+    pub(crate) recipient_id: String,
+    pub(crate) witness_data: Option<WitnessData>,
+    pub(crate) assignment: Assignment,
+    pub(crate) transport_endpoints: Vec<String>,
+}
+
+impl From<Recipient> for RgbLibRecipient {
+    fn from(value: Recipient) -> Self {
+        Self {
+            recipient_id: value.recipient_id,
+            witness_data: value.witness_data.map(|w| w.into()),
+            assignment: value.assignment.into(),
+            transport_endpoints: value.transport_endpoints,
+        }
+    }
+}
+
 #[derive(Deserialize, Serialize)]
 pub(crate) struct RgbAllocation {
     pub(crate) asset_id: Option<String>,
@@ -942,24 +961,6 @@ pub(crate) struct RgbInvoiceResponse {
     pub(crate) batch_transfer_idx: i32,
 }
 
-#[derive(Deserialize, Serialize)]
-pub(crate) struct SendAssetRequest {
-    pub(crate) asset_id: String,
-    pub(crate) assignment: Assignment,
-    pub(crate) recipient_id: String,
-    pub(crate) witness_data: Option<WitnessData>,
-    pub(crate) donation: bool,
-    pub(crate) fee_rate: u64,
-    pub(crate) min_confirmations: u8,
-    pub(crate) transport_endpoints: Vec<String>,
-    pub(crate) skip_sync: bool,
-}
-
-#[derive(Deserialize, Serialize)]
-pub(crate) struct SendAssetResponse {
-    pub(crate) txid: String,
-}
-
 #[derive(Deserialize, Serialize)]
 pub(crate) struct SendBtcRequest {
     pub(crate) amount: u64,
@@ -994,6 +995,20 @@ pub(crate) struct SendPaymentResponse {
     pub(crate) status: HTLCStatus,
 }
 
+#[derive(Deserialize, Serialize)]
+pub(crate) struct SendRgbRequest {
+    pub(crate) donation: bool,
+    pub(crate) fee_rate: u64,
+    pub(crate) min_confirmations: u8,
+    pub(crate) recipient_map: HashMap<String, Vec<Recipient>>,
+    pub(crate) skip_sync: bool,
+}
+
+#[derive(Deserialize, Serialize)]
+pub(crate) struct SendRgbResponse {
+    pub(crate) txid: String,
+}
+
 #[derive(Deserialize, Serialize)]
 pub(crate) struct SignMessageRequest {
     pub(crate) message: String,
@@ -3112,7 +3127,7 @@ pub(crate) async fn open_channel(
             };
 
             let recipient_map = map! {
-                asset_id => vec![Recipient {
+                asset_id => vec![RgbLibRecipient {
                     recipient_id,
                     witness_data: Some(RgbLibWitnessData {
                         amount_sat: payload.capacity_sat,
@@ -3357,48 +3372,6 @@ pub(crate) async fn rgb_invoice(
     .await
 }
 
-pub(crate) async fn send_asset(
-    State(state): State<Arc<AppState>>,
-    WithRejection(Json(payload), _): WithRejection<Json<SendAssetRequest>, APIError>,
-) -> Result<Json<SendAssetResponse>, APIError> {
-    no_cancel(async move {
-        let guard = state.check_unlocked().await?;
-        let unlocked_state = guard.as_ref().unwrap();
-
-        if *unlocked_state.rgb_send_lock.lock().unwrap() {
-            return Err(APIError::OpenChannelInProgress);
-        }
-
-        RecipientInfo::new(payload.recipient_id.clone())?;
-        let recipient_map = map! {
-            payload.asset_id => vec![Recipient {
-                recipient_id: payload.recipient_id,
-                witness_data: payload.witness_data.map(|w| w.into()),
-                assignment: payload.assignment.into(),
-                transport_endpoints: payload.transport_endpoints,
-            }]
-        };
-
-        let unlocked_state_copy = unlocked_state.clone();
-        let send_result = tokio::task::spawn_blocking(move || {
-            unlocked_state_copy.rgb_send(
-                recipient_map,
-                payload.donation,
-                payload.fee_rate,
-                payload.min_confirmations,
-                payload.skip_sync,
-            )
-        })
-        .await
-        .unwrap()?;
-
-        Ok(Json(SendAssetResponse {
-            txid: send_result.txid,
-        }))
-    })
-    .await
-}
-
 pub(crate) async fn send_btc(
     State(state): State<Arc<AppState>>,
     WithRejection(Json(payload), _): WithRejection<Json<SendBtcRequest>, APIError>,
@@ -3655,6 +3628,46 @@ pub(crate) async fn send_payment(
     .await
 }
 
+pub(crate) async fn send_rgb(
+    State(state): State<Arc<AppState>>,
+    WithRejection(Json(payload), _): WithRejection<Json<SendRgbRequest>, APIError>,
+) -> Result<Json<SendRgbResponse>, APIError> {
+    no_cancel(async move {
+        let guard = state.check_unlocked().await?;
+        let unlocked_state = guard.as_ref().unwrap();
+
+        if *unlocked_state.rgb_send_lock.lock().unwrap() {
+            return Err(APIError::OpenChannelInProgress);
+        }
+
+        let recipient_map: HashMap<String, Vec<RgbLibRecipient>> = payload
+            .recipient_map
+            .into_iter()
+            .map(|(asset_id, recipients)| {
+                (asset_id, recipients.into_iter().map(|r| r.into()).collect())
+            })
+            .collect();
+
+        let unlocked_state_copy = unlocked_state.clone();
+        let send_result = tokio::task::spawn_blocking(move || {
+            unlocked_state_copy.rgb_send(
+                recipient_map,
+                payload.donation,
+                payload.fee_rate,
+                payload.min_confirmations,
+                payload.skip_sync,
+            )
+        })
+        .await
+        .unwrap()?;
+
+        Ok(Json(SendRgbResponse {
+            txid: send_result.txid,
+        }))
+    })
+    .await
+}
+
 pub(crate) async fn shutdown(
     State(state): State<Arc<AppState>>,
 ) -> Result<Json<EmptyResponse>, APIError> {
diff --git a/src/test/mod.rs b/src/test/mod.rs
diff --git a/src/test/send_receive.rs b/src/test/send_receive.rs
