Return PaymentId from pay and make it useful as a hashtable key in bindings (#30)

Co-authored-by: Matt Corallo <git+macbook@bluematt.me>

Author: TheBlueMatt-macbook

orange-sdk/src/ffi/orange/mod.rs

@@ -62,7 +62,7 @@ impl Transaction {
 /// A PaymentId is a unique identifier for a payment. It can be either a Lightning payment or a
 /// Trusted payment. It is used to track the state of a payment and to provide information about
 /// the payment to the user.
-#[derive(Debug, Clone, Hash, PartialEq, Eq, uniffi::Object)]
+#[derive(Debug, Clone, Hash, PartialEq, Eq, uniffi::Enum)]
 pub enum PaymentId {
 	Lightning(String),
 	Trusted(String),
@@ -77,14 +77,6 @@ impl From<OrangePaymentId> for PaymentId {
 	}
 }
 
-#[uniffi::export]
-impl PaymentId {
-	/// Gets a string representation of this PaymentId
-	pub fn to_string(&self) -> String {
-		format!("{self:?}")
-	}
-}
-
 /// The status of a transaction. This is used to track the state of a transaction
 #[derive(Debug, Clone, Copy, PartialEq, Eq, uniffi::Enum)]
 pub enum TxStatus {
@@ -173,7 +165,7 @@ pub enum Event {
 	/// An outgoing payment was successful.
 	PaymentSuccessful {
 		/// A local identifier used to track the payment.
-		payment_id: Arc<PaymentId>,
+		payment_id: PaymentId,
 		/// The hash of the payment.
 		payment_hash: Vec<u8>,
 		/// The preimage to the `payment_hash`.
@@ -186,7 +178,7 @@ pub enum Event {
 	/// An outgoing payment has failed.
 	PaymentFailed {
 		/// A local identifier used to track the payment.
-		payment_id: Arc<PaymentId>,
+		payment_id: PaymentId,
 		/// The hash of the payment.
 		///
 		/// This will be `None` if the payment failed before receiving an invoice when paying a
@@ -202,7 +194,7 @@ pub enum Event {
 	/// A payment has been received.
 	PaymentReceived {
 		/// A local identifier used to track the payment.
-		payment_id: Arc<PaymentId>,
+		payment_id: PaymentId,
 		/// The hash of the payment.
 		payment_hash: Vec<u8>,
 		/// The value, in msats, that has been received.
@@ -216,7 +208,7 @@ pub enum Event {
 	/// A payment has been received.
 	OnchainPaymentReceived {
 		/// A local identifier used to track the payment.
-		payment_id: Arc<PaymentId>,
+		payment_id: PaymentId,
 		/// The transaction ID.
 		txid: Vec<u8>,
 		/// The value, in sats, that has been received.
@@ -252,7 +244,7 @@ pub enum Event {
 	/// A rebalance from our trusted wallet has been initiated.
 	RebalanceInitiated {
 		/// The `payment_id` of the transaction that triggered the rebalance.
-		trigger_payment_id: Arc<PaymentId>,
+		trigger_payment_id: PaymentId,
 		/// The `payment_id` of the rebalance payment sent from the trusted wallet.
 		trusted_rebalance_payment_id: Vec<u8>,
 		/// The amount, in msats, of the rebalance payment.
@@ -261,7 +253,7 @@ pub enum Event {
 	/// A rebalance from our trusted wallet was successful.
 	RebalanceSuccessful {
 		/// The `payment_id` of the transaction that triggered the rebalance.
-		trigger_payment_id: Arc<PaymentId>,
+		trigger_payment_id: PaymentId,
 		/// The `payment_id` of the rebalance payment sent from the trusted wallet.
 		trusted_rebalance_payment_id: Vec<u8>,
 		/// The `payment_id` of the rebalance payment sent to the LN wallet.
@@ -293,14 +285,14 @@ impl From<OrangeEvent> for Event {
 				payment_preimage,
 				fee_paid_msat,
 			} => Event::PaymentSuccessful {
-				payment_id: Arc::new(payment_id.into()),
+				payment_id: payment_id.into(),
 				payment_hash: payment_hash.0.to_vec(),
 				payment_preimage: payment_preimage.0.to_vec(),
 				fee_paid_msat,
 			},
 			OrangeEvent::PaymentFailed { payment_id, payment_hash, reason } => {
 				Event::PaymentFailed {
-					payment_id: Arc::new(payment_id.into()),
+					payment_id: payment_id.into(),
 					payment_hash: payment_hash.map(|h| h.0.to_vec()),
 					reason: reason.map(|r| format!("{:?}", r)),
 				}
@@ -312,15 +304,15 @@ impl From<OrangeEvent> for Event {
 				custom_records,
 				lsp_fee_msats,
 			} => Event::PaymentReceived {
-				payment_id: Arc::new(payment_id.into()),
+				payment_id: payment_id.into(),
 				payment_hash: payment_hash.0.to_vec(),
 				amount_msat,
 				custom_records: custom_records.into_iter().map(|r| r.value).collect(),
 				lsp_fee_msats,
 			},
 			OrangeEvent::OnchainPaymentReceived { payment_id, txid, amount_sat, status: _ } => {
 				Event::OnchainPaymentReceived {
-					payment_id: Arc::new(payment_id.into()),
+					payment_id: payment_id.into(),
 					txid: txid.to_byte_array().to_vec(),
 					amount_sat,
 				}
@@ -352,7 +344,7 @@ impl From<OrangeEvent> for Event {
 				trusted_rebalance_payment_id,
 				amount_msat,
 			} => Event::RebalanceInitiated {
-				trigger_payment_id: Arc::new(trigger_payment_id.into()),
+				trigger_payment_id: trigger_payment_id.into(),
 				trusted_rebalance_payment_id: trusted_rebalance_payment_id.to_vec(),
 				amount_msat,
 			},
@@ -363,7 +355,7 @@ impl From<OrangeEvent> for Event {
 				amount_msat,
 				fee_msat,
 			} => Event::RebalanceSuccessful {
-				trigger_payment_id: Arc::new(trigger_payment_id.into()),
+				trigger_payment_id: trigger_payment_id.into(),
 				trusted_rebalance_payment_id: trusted_rebalance_payment_id.to_vec(),
 				ln_rebalance_payment_id: ln_rebalance_payment_id.to_vec(),
 				amount_msat,

orange-sdk/src/ffi/orange/wallet.rs

@@ -156,9 +156,9 @@ impl Wallet {
 	///
 	/// Returns once the payment is pending. This does not mean the payment has completed -
 	/// it may still fail. Use event handlers or transaction listing to monitor payment status.
-	pub async fn pay(&self, payment_info: Arc<PaymentInfo>) -> Result<(), WalletError> {
-		self.inner.pay(&payment_info.0).await?;
-		Ok(())
+	pub async fn pay(&self, payment_info: Arc<PaymentInfo>) -> Result<super::PaymentId, WalletError> {
+		let id = self.inner.pay(&payment_info.0).await?;
+		Ok(id.into())
 	}
 
 	/// Estimates the fees required to pay using the provided PaymentInfo

orange-sdk/src/lib.rs

@@ -1056,9 +1056,9 @@ impl Wallet {
 	/// If applicable, this will also initiate a rebalance from the trusted wallet to the
 	/// lightning wallet based on the resulting balance and configured tunables.
 	///
-	/// Returns true once the payment is pending, however, this does not mean that the
+	/// Returns once the payment is pending, however, this does not mean that the
 	/// payment has been completed. The payment may still fail.
-	pub async fn pay(&self, instructions: &PaymentInfo) -> Result<(), WalletError> {
+	pub async fn pay(&self, instructions: &PaymentInfo) -> Result<PaymentId, WalletError> {
 		let trusted_balance = self.inner.trusted.get_balance().await?;
 		let ln_balance = self.inner.ln_wallet.get_balance();
 
@@ -1104,7 +1104,7 @@ impl Wallet {
 										.unwrap(),
 								},
 							);
-							return Ok(());
+							return Ok(PaymentId::Trusted(id));
 						},
 						Err(e) => {
 							log_debug!(self.inner.logger, "Trusted payment failed with {e:?}");
@@ -1149,7 +1149,7 @@ impl Wallet {
 								self.inner.runtime.spawn_cancellable_background_task(async move {
 									inner_ref.rebalancer.do_rebalance_if_needed().await;
 								});
-								return Ok(());
+								return Ok(PaymentId::SelfCustodial(id.0));
 							},
 							Err(e) => {
 								log_debug!(self.inner.logger, "LN payment failed with {:?}", e);
@@ -1183,23 +1183,21 @@ impl Wallet {
 		for method in methods.clone() {
 			match method {
 				PaymentMethod::LightningBolt11(_) => {
-					if pay_trusted(method, || PaymentType::OutgoingLightningBolt11 {
+					if let Ok(id) = pay_trusted(method, || PaymentType::OutgoingLightningBolt11 {
 						payment_preimage: None,
 					})
 					.await
-					.is_ok()
 					{
-						return Ok(());
+						return Ok(id);
 					};
 				},
 				PaymentMethod::LightningBolt12(_) => {
-					if pay_trusted(method, || PaymentType::OutgoingLightningBolt12 {
+					if let Ok(id) = pay_trusted(method, || PaymentType::OutgoingLightningBolt12 {
 						payment_preimage: None,
 					})
 					.await
-					.is_ok()
 					{
-						return Ok(());
+						return Ok(id);
 					}
 				},
 				PaymentMethod::OnChain { .. } => {},
@@ -1211,23 +1209,21 @@ impl Wallet {
 		for method in &methods {
 			match method {
 				PaymentMethod::LightningBolt11(_) => {
-					if pay_lightning(method, || PaymentType::OutgoingLightningBolt11 {
+					if let Ok(id) = pay_lightning(method, || PaymentType::OutgoingLightningBolt11 {
 						payment_preimage: None,
 					})
 					.await
-					.is_ok()
 					{
-						return Ok(());
+						return Ok(id);
 					}
 				},
 				PaymentMethod::LightningBolt12(_) => {
-					if pay_lightning(method, || PaymentType::OutgoingLightningBolt12 {
+					if let Ok(id) = pay_lightning(method, || PaymentType::OutgoingLightningBolt12 {
 						payment_preimage: None,
 					})
 					.await
-					.is_ok()
 					{
-						return Ok(());
+						return Ok(id);
 					}
 				},
 				PaymentMethod::OnChain { .. } => {},
@@ -1239,21 +1235,20 @@ impl Wallet {
 		// Finally, try trusted on-chain first,
 		for method in methods.clone() {
 			if let PaymentMethod::OnChain { .. } = method {
-				if pay_trusted(method, || PaymentType::OutgoingOnChain { txid: None }).await.is_ok()
+				if let Ok(id) = pay_trusted(method, || PaymentType::OutgoingOnChain { txid: None }).await
 				{
-					return Ok(());
+					return Ok(id);
 				};
 			}
 		}
 
 		// then pay on-chain out of the lightning wallet
 		for method in &methods {
 			if let PaymentMethod::OnChain { .. } = method {
-				if pay_lightning(method, || PaymentType::OutgoingOnChain { txid: None })
+				if let Ok(id) = pay_lightning(method, || PaymentType::OutgoingOnChain { txid: None })
 					.await
-					.is_ok()
 				{
-					return Ok(());
+					return Ok(id);
 				};
 			}
 		}

scripts/uniffi_bindgen_generate_swift.sh

@@ -17,11 +17,15 @@ rustup target add aarch64-apple-ios-sim --toolchain stable
 rustup target add aarch64-apple-darwin x86_64-apple-darwin --toolchain stable
 
 # Build rust target libs
+export IPHONEOS_DEPLOYMENT_TARGET=15.0
 cargo build --profile release-smaller --features uniffi || exit 1
 cargo build --profile release-smaller --target x86_64-apple-darwin --features uniffi || exit 1
 cargo build --profile release-smaller --target aarch64-apple-darwin --features uniffi || exit 1
+export CFLAGS_x86_64_apple_ios=-mios-version-min=$IPHONEOS_DEPLOYMENT_TARGET
 cargo build --profile release-smaller --target x86_64-apple-ios --features uniffi || exit 1
+export CFLAGS_aarch64_apple_ios=-mios-version-min=$IPHONEOS_DEPLOYMENT_TARGET
 cargo build --profile release-smaller --target aarch64-apple-ios --features uniffi || exit 1
+export CFLAGS_aarch64_apple_ios_sim=-mios-version-min=$IPHONEOS_DEPLOYMENT_TARGET
 cargo +stable build --release --target aarch64-apple-ios-sim --features uniffi || exit 1
 
 # Combine ios-sim and apple-darwin (macos) libs for x86_64 and aarch64 (m1)