add assignment to /rgbinvoice

Author: Arshia-r-m

openapi.yaml

@@ -2038,6 +2038,8 @@ components:
         asset_id:
           type: string
           example: rgb:CJkb4YZw-jRiz2sk-~PARPio-wtVYI1c-XAEYCqO-wTfvRZ8
+        assignment:
+          $ref: '#/components/schemas/Assignment'
         duration_seconds:
           type: integer
           example: 86400

src/ldk.rs

@@ -1282,7 +1282,13 @@ impl OutputSpender for RgbOutputSpender {
                 new_asset = true;
                 let receive_data = self
                     .rgb_wallet_wrapper
-                    .witness_receive(None, None, vec![self.proxy_endpoint.clone()], 0)
+                    .witness_receive(
+                        None,
+                        Assignment::Any,
+                        None,
+                        vec![self.proxy_endpoint.clone()],
+                        0,
+                    )
                     .unwrap();
                 let script_pubkey = script_buf_from_recipient_id(receive_data.recipient_id.clone())
                     .unwrap()

src/rgb.rs

@@ -34,12 +34,14 @@ impl UnlockedAppState {
     pub(crate) fn rgb_blind_receive(
         &self,
         asset_id: Option<String>,
+        assignment: Assignment,
         duration_seconds: Option<u32>,
         transport_endpoints: Vec<String>,
         min_confirmations: u8,
     ) -> Result<ReceiveData, RgbLibError> {
         self.rgb_wallet_wrapper.blind_receive(
             asset_id,
+            assignment,
             duration_seconds,
             transport_endpoints,
             min_confirmations,
@@ -280,12 +282,14 @@ impl UnlockedAppState {
     pub(crate) fn rgb_witness_receive(
         &self,
         asset_id: Option<String>,
+        assignment: Assignment,
         duration_seconds: Option<u32>,
         transport_endpoints: Vec<String>,
         min_confirmations: u8,
     ) -> Result<ReceiveData, RgbLibError> {
         self.rgb_wallet_wrapper.witness_receive(
             asset_id,
+            assignment,
             duration_seconds,
             transport_endpoints,
             min_confirmations,
@@ -314,13 +318,14 @@ impl RgbLibWalletWrapper {
     pub(crate) fn blind_receive(
         &self,
         asset_id: Option<String>,
+        assignment: Assignment,
         duration_seconds: Option<u32>,
         transport_endpoints: Vec<String>,
         min_confirmations: u8,
     ) -> Result<ReceiveData, RgbLibError> {
         self.get_rgb_wallet().blind_receive(
             asset_id,
-            Assignment::Any,
+            assignment,
             duration_seconds,
             transport_endpoints,
             min_confirmations,
@@ -614,13 +619,14 @@ impl RgbLibWalletWrapper {
     pub(crate) fn witness_receive(
         &self,
         asset_id: Option<String>,
+        assignment: Assignment,
         duration_seconds: Option<u32>,
         transport_endpoints: Vec<String>,
         min_confirmations: u8,
     ) -> Result<ReceiveData, RgbLibError> {
         self.get_rgb_wallet().witness_receive(
             asset_id,
-            Assignment::Any,
+            assignment,
             duration_seconds,
             transport_endpoints,
             min_confirmations,

src/routes.rs

@@ -911,6 +911,7 @@ pub(crate) struct RgbAllocation {
 #[derive(Deserialize, Serialize)]
 pub(crate) struct RgbInvoiceRequest {
     pub(crate) asset_id: Option<String>,
+    pub(crate) assignment: Option<Assignment>,
     pub(crate) duration_seconds: Option<u32>,
     pub(crate) min_confirmations: u8,
     pub(crate) witness: bool,
@@ -3226,16 +3227,20 @@ pub(crate) async fn rgb_invoice(
             return Err(APIError::OpenChannelInProgress);
         }
 
+        let assignment = payload.assignment.unwrap_or(Assignment::Any).into();
+
         let receive_data = if payload.witness {
             unlocked_state.rgb_witness_receive(
                 payload.asset_id,
+                assignment,
                 payload.duration_seconds,
                 vec![unlocked_state.proxy_endpoint.clone()],
                 payload.min_confirmations,
             )?
         } else {
             unlocked_state.rgb_blind_receive(
                 payload.asset_id,
+                assignment,
                 payload.duration_seconds,
                 vec![unlocked_state.proxy_endpoint.clone()],
                 payload.min_confirmations,

src/test/mod.rs

@@ -1217,6 +1217,15 @@ async fn rgb_invoice(
     node_address: SocketAddr,
     asset_id: Option<String>,
     witness: bool,
+) -> RgbInvoiceResponse {
+    rgb_invoice_with_assignment(node_address, asset_id, None, witness).await
+}
+
+async fn rgb_invoice_with_assignment(
+    node_address: SocketAddr,
+    asset_id: Option<String>,
+    assignment: Option<Assignment>,
+    witness: bool,
 ) -> RgbInvoiceResponse {
     println!(
         "generating RGB invoice{} for node {node_address}",
@@ -1229,6 +1238,7 @@ async fn rgb_invoice(
     let payload = RgbInvoiceRequest {
         min_confirmations: 1,
         asset_id,
+        assignment,
         duration_seconds: None,
         witness,
     };
@@ -1723,6 +1733,7 @@ mod openchannel_optional_addr;
 mod payment;
 mod refuse_high_fees;
 mod restart;
+mod rgb_invoice_assignment;
 mod send_receive;
 mod swap_assets_liquidity_both_ways;
 mod swap_reverse_same_channel;

src/test/rgb_invoice_assignment.rs

@@ -0,0 +1,78 @@
+use super::*;
+
+const TEST_DIR_BASE: &str = "tmp/rgb_invoice_assignment/";
+
+#[serial_test::serial]
+#[tokio::test(flavor = "multi_thread", worker_threads = 1)]
+#[traced_test]
+async fn rgb_invoice_assignment() {
+    initialize();
+
+    let test_dir_node1 = format!("{TEST_DIR_BASE}node1");
+    let test_dir_node2 = format!("{TEST_DIR_BASE}node2");
+    let (node1_addr, _) = start_node(&test_dir_node1, NODE1_PEER_PORT, false).await;
+    let (node2_addr, _) = start_node(&test_dir_node2, NODE2_PEER_PORT, false).await;
+
+    fund_and_create_utxos(node1_addr, None).await;
+    fund_and_create_utxos(node2_addr, None).await;
+
+    let asset_id = issue_asset_nia(node1_addr).await.asset_id;
+
+    let requested_amount = 400;
+    let RgbInvoiceResponse {
+        recipient_id,
+        invoice,
+        ..
+    } = rgb_invoice_with_assignment(
+        node1_addr,
+        None,
+        Some(Assignment::Fungible(requested_amount)),
+        true,
+    )
+    .await;
+
+    let decoded = decode_rgb_invoice(node1_addr, &invoice).await;
+    assert_eq!(decoded.recipient_id, recipient_id);
+    assert!(decoded.asset_schema.is_none());
+    assert!(decoded.asset_id.is_none());
+    assert_eq!(decoded.assignment, Assignment::Fungible(requested_amount));
+
+    let RgbInvoiceResponse {
+        recipient_id,
+        invoice,
+        ..
+    } = rgb_invoice_with_assignment(
+        node2_addr,
+        None,
+        Some(Assignment::Fungible(requested_amount)),
+        false,
+    )
+    .await;
+
+    let decoded = decode_rgb_invoice(node1_addr, &invoice).await;
+    assert_eq!(decoded.recipient_id, recipient_id);
+    assert!(decoded.asset_schema.is_none());
+    assert!(decoded.asset_id.is_none());
+    assert_eq!(decoded.assignment, Assignment::Fungible(requested_amount));
+
+    send_asset(
+        node1_addr,
+        &asset_id,
+        Assignment::Fungible(requested_amount),
+        recipient_id,
+    )
+    .await;
+    mine(false);
+    refresh_transfers(node2_addr).await;
+    refresh_transfers(node2_addr).await;
+    refresh_transfers(node1_addr).await;
+
+    assert_eq!(
+        asset_balance_spendable(node1_addr, &asset_id).await,
+        1000 - requested_amount
+    );
+    assert_eq!(
+        asset_balance_spendable(node2_addr, &asset_id).await,
+        requested_amount
+    );
+}