fixup! sim_node/feat: track payment path with in flight

Author: chuksys

simln-lib/src/cln.rs

@@ -160,7 +160,7 @@ impl LightningNode for ClnNode {
     }
 
     async fn send_payment(
-        &mut self,
+        &self,
         dest: PublicKey,
         amount_msat: u64,
     ) -> Result<PaymentHash, LightningError> {
@@ -194,7 +194,7 @@ impl LightningNode for ClnNode {
     }
 
     async fn track_payment(
-        &mut self,
+        &self,
         hash: &PaymentHash,
         shutdown: Listener,
     ) -> Result<PaymentResult, LightningError> {

simln-lib/src/eclair.rs

@@ -133,7 +133,7 @@ impl LightningNode for EclairNode {
     }
 
     async fn send_payment(
-        &mut self,
+        &self,
         dest: PublicKey,
         amount_msat: u64,
     ) -> Result<PaymentHash, LightningError> {
@@ -164,7 +164,7 @@ impl LightningNode for EclairNode {
     }
 
     async fn track_payment(
-        &mut self,
+        &self,
         hash: &PaymentHash,
         shutdown: Listener,
     ) -> Result<PaymentResult, LightningError> {

simln-lib/src/lib.rs

@@ -330,13 +330,13 @@ pub trait LightningNode: Send {
     fn get_network(&self) -> Network;
     /// Keysend payment worth `amount_msat` from a source node to the destination node.
     async fn send_payment(
-        &mut self,
+        &self,
         dest: PublicKey,
         amount_msat: u64,
     ) -> Result<PaymentHash, LightningError>;
     /// Track a payment with the specified hash.
     async fn track_payment(
-        &mut self,
+        &self,
         hash: &PaymentHash,
         shutdown: Listener,
     ) -> Result<PaymentResult, LightningError>;
@@ -1154,7 +1154,7 @@ async fn consume_events(
                 if let Some(event) = simulation_event {
                     match event {
                         SimulationEvent::SendPayment(dest, amt_msat) => {
-                            let mut node = node.lock().await;
+                            let node = node.lock().await;
 
                             let mut payment = Payment {
                                 source: node.get_info().pubkey,
@@ -1506,7 +1506,7 @@ async fn track_payment_result(
 ) -> Result<(), SimulationError> {
     log::trace!("Payment result tracker starting.");
 
-    let mut node = node.lock().await;
+    let node = node.lock().await;
 
     let res = match payment.hash {
         Some(hash) => {

simln-lib/src/lnd.rs

@@ -131,7 +131,7 @@ impl LightningNode for LndNode {
     }
 
     async fn send_payment(
-        &mut self,
+        &self,
         dest: PublicKey,
         amount_msat: u64,
     ) -> Result<PaymentHash, LightningError> {
@@ -170,7 +170,7 @@ impl LightningNode for LndNode {
     }
 
     async fn track_payment(
-        &mut self,
+        &self,
         hash: &PaymentHash,
         shutdown: Listener,
     ) -> Result<PaymentResult, LightningError> {

simln-lib/src/sim_node.rs

@@ -507,7 +507,7 @@ pub struct SimNode<T: SimNetwork, C: Clock> {
     /// The underlying execution network that will be responsible for dispatching payments.
     network: Arc<Mutex<T>>,
     /// Tracks the channel that will provide updates for payments by hash.
-    in_flight: HashMap<PaymentHash, InFlightPayment>,
+    in_flight: Mutex<HashMap<PaymentHash, InFlightPayment>>,
     /// A read-only graph used for pathfinding.
     pathfinding_graph: Arc<LdkNetworkGraph>,
     /// Probabilistic scorer used to rank paths through the network for routing. This is reused across
@@ -538,7 +538,7 @@ impl<T: SimNetwork, C: Clock> SimNode<T, C> {
         Ok(SimNode {
             info,
             network: payment_network,
-            in_flight: HashMap::new(),
+            in_flight: Mutex::new(HashMap::new()),
             pathfinding_graph,
             scorer,
             clock,
@@ -569,7 +569,7 @@ impl<T: SimNetwork, C: Clock> SimNode<T, C> {
         }
 
         // Check for payment hash collision, failing the payment if we happen to repeat one.
-        match self.in_flight.entry(payment_hash) {
+        match self.in_flight.lock().await.entry(payment_hash) {
             Entry::Occupied(_) => {
                 return Err(LightningError::SendPaymentError(
                     "payment hash exists".to_string(),
@@ -651,7 +651,7 @@ impl<T: SimNetwork, C: Clock> LightningNode for SimNode<T, C> {
     /// send_payment picks a random preimage for a payment, dispatches it in the network and adds a tracking channel
     /// to our node state to be used for subsequent track_payment calls.
     async fn send_payment(
-        &mut self,
+        &self,
         dest: PublicKey,
         amount_msat: u64,
     ) -> Result<PaymentHash, LightningError> {
@@ -662,7 +662,8 @@ impl<T: SimNetwork, C: Clock> LightningNode for SimNode<T, C> {
         let payment_hash = preimage.into();
 
         // Check for payment hash collision, failing the payment if we happen to repeat one.
-        let entry = match self.in_flight.entry(payment_hash) {
+        let mut in_flight_guard = self.in_flight.lock().await;
+        let entry = match in_flight_guard.entry(payment_hash) {
             Entry::Occupied(_) => {
                 return Err(LightningError::SendPaymentError(
                     "payment hash exists".to_string(),
@@ -724,11 +725,11 @@ impl<T: SimNetwork, C: Clock> LightningNode for SimNode<T, C> {
     /// provided is triggered. This call will fail if the hash provided was not obtained from send_payment or passed
     /// into send_to_route first.
     async fn track_payment(
-        &mut self,
+        &self,
         hash: &PaymentHash,
         listener: Listener,
     ) -> Result<PaymentResult, LightningError> {
-        match self.in_flight.remove(hash) {
+        match self.in_flight.lock().await.remove(hash) {
             Some(in_flight) => {
                 select! {
                     biased;
@@ -2050,7 +2051,7 @@ mod tests {
 
         // Create a simulated node for the first channel in our network.
         let pk = channels[0].node_1.policy.pubkey;
-        let mut node = SimNode::new(
+        let node = SimNode::new(
             node_info(pk, String::default()),
             sim_network.clone(),
             Arc::new(graph),

simln-lib/src/test_utils.rs

@@ -78,12 +78,12 @@ mock! {
         fn get_info(&self) -> &NodeInfo;
         fn get_network(&self) -> bitcoin::Network;
         async fn send_payment(
-                &mut self,
+                &self,
                 dest: bitcoin::secp256k1::PublicKey,
                 amount_msat: u64,
             ) -> Result<lightning::ln::PaymentHash, LightningError>;
         async fn track_payment(
-                &mut self,
+                &self,
                 hash: &lightning::ln::PaymentHash,
                 shutdown: triggered::Listener,
             ) -> Result<crate::PaymentResult, LightningError>;