add hook for freeing trait instances

Author: arik-so

bindings/LDK/Bindings.swift

@@ -65,6 +65,15 @@ open class NativeTypeWrapper: Hashable {
 
 }
 
+open class NativeTraitWrapper: NativeTypeWrapper {
+
+    public func activate() -> Self {
+        Bindings.cacheInstance(instance: self)
+        return self
+    }
+
+}
+
 public class Bindings {
 
 	internal static var minimumPrintSeverity: PrintSeverity = .WARNING
@@ -6233,7 +6242,7 @@ withUnsafePointer(to: network.cOpaqueStruct!) { (networkPointer: UnsafePointer<L
 withUnsafePointer(to: scorer.cOpaqueStruct!) { (scorerPointer: UnsafePointer<LDKScore>) in
 withUnsafePointer(to: Bindings.array_to_tuple32(array: random_seed_bytes)) { (random_seed_bytesPointer: UnsafePointer<(UInt8,UInt8,UInt8,UInt8,UInt8,UInt8,UInt8,UInt8,UInt8,UInt8,UInt8,UInt8,UInt8,UInt8,UInt8,UInt8,UInt8,UInt8,UInt8,UInt8,UInt8,UInt8,UInt8,UInt8,UInt8,UInt8,UInt8,UInt8,UInt8,UInt8,UInt8,UInt8)>) in
 
-				Result_RouteLightningErrorZ(pointer: find_route(Bindings.new_LDKPublicKey(array: our_node_pubkey), route_paramsPointer, networkPointer, first_hopsPointer, logger.cOpaqueStruct!, scorerPointer, random_seed_bytesPointer))
+				Result_RouteLightningErrorZ(pointer: find_route(Bindings.new_LDKPublicKey(array: our_node_pubkey), route_paramsPointer, networkPointer, first_hopsPointer, logger.activate().cOpaqueStruct!, scorerPointer, random_seed_bytesPointer))
 
 }
 }
@@ -6255,7 +6264,7 @@ withUnsafePointer(to: Bindings.array_to_tuple32(array: random_seed_bytes)) { (ra
 						}
 
 				return 
-				Result_InvoiceSignOrCreationErrorZ(pointer: create_phantom_invoice(amt_msat.danglingClone().cOpaqueStruct!, Bindings.new_LDKStr(string: description, chars_is_owned: true), Bindings.new_LDKThirtyTwoBytes(array: payment_hash), Bindings.new_LDKThirtyTwoBytes(array: payment_secret), phantom_route_hintsWrapper.dangle().cOpaqueStruct!, keys_manager.cOpaqueStruct!, network))
+				Result_InvoiceSignOrCreationErrorZ(pointer: create_phantom_invoice(amt_msat.danglingClone().cOpaqueStruct!, Bindings.new_LDKStr(string: description, chars_is_owned: true), Bindings.new_LDKThirtyTwoBytes(array: payment_hash), Bindings.new_LDKThirtyTwoBytes(array: payment_secret), phantom_route_hintsWrapper.dangle().cOpaqueStruct!, keys_manager.activate().cOpaqueStruct!, network))
 
 
 	}
@@ -6273,7 +6282,7 @@ withUnsafePointer(to: Bindings.array_to_tuple32(array: random_seed_bytes)) { (ra
 						}
 
 				return 
-				Result_InvoiceSignOrCreationErrorZ(pointer: create_phantom_invoice_with_description_hash(amt_msat.danglingClone().cOpaqueStruct!, description_hash.danglingClone().cOpaqueStruct!, Bindings.new_LDKThirtyTwoBytes(array: payment_hash), Bindings.new_LDKThirtyTwoBytes(array: payment_secret), phantom_route_hintsWrapper.dangle().cOpaqueStruct!, keys_manager.cOpaqueStruct!, network))
+				Result_InvoiceSignOrCreationErrorZ(pointer: create_phantom_invoice_with_description_hash(amt_msat.danglingClone().cOpaqueStruct!, description_hash.danglingClone().cOpaqueStruct!, Bindings.new_LDKThirtyTwoBytes(array: payment_hash), Bindings.new_LDKThirtyTwoBytes(array: payment_secret), phantom_route_hintsWrapper.dangle().cOpaqueStruct!, keys_manager.activate().cOpaqueStruct!, network))
 
 
 	}
@@ -6282,7 +6291,7 @@ withUnsafePointer(to: Bindings.array_to_tuple32(array: random_seed_bytes)) { (ra
 
 				return withUnsafePointer(to: channelmanager.cOpaqueStruct!) { (channelmanagerPointer: UnsafePointer<LDKChannelManager>) in
 
-				Result_InvoiceSignOrCreationErrorZ(pointer: create_invoice_from_channelmanager(channelmanagerPointer, keys_manager.cOpaqueStruct!, network, amt_msat.danglingClone().cOpaqueStruct!, Bindings.new_LDKStr(string: description, chars_is_owned: true)))
+				Result_InvoiceSignOrCreationErrorZ(pointer: create_invoice_from_channelmanager(channelmanagerPointer, keys_manager.activate().cOpaqueStruct!, network, amt_msat.danglingClone().cOpaqueStruct!, Bindings.new_LDKStr(string: description, chars_is_owned: true)))
 
 }
 
@@ -6292,7 +6301,7 @@ withUnsafePointer(to: Bindings.array_to_tuple32(array: random_seed_bytes)) { (ra
 
 				return withUnsafePointer(to: channelmanager.cOpaqueStruct!) { (channelmanagerPointer: UnsafePointer<LDKChannelManager>) in
 
-				Result_InvoiceSignOrCreationErrorZ(pointer: create_invoice_from_channelmanager_with_description_hash(channelmanagerPointer, keys_manager.cOpaqueStruct!, network, amt_msat.danglingClone().cOpaqueStruct!, description_hash.danglingClone().cOpaqueStruct!))
+				Result_InvoiceSignOrCreationErrorZ(pointer: create_invoice_from_channelmanager_with_description_hash(channelmanagerPointer, keys_manager.activate().cOpaqueStruct!, network, amt_msat.danglingClone().cOpaqueStruct!, description_hash.danglingClone().cOpaqueStruct!))
 
 }
 
@@ -6302,7 +6311,7 @@ withUnsafePointer(to: Bindings.array_to_tuple32(array: random_seed_bytes)) { (ra
 
 				return withUnsafePointer(to: channelmanager.cOpaqueStruct!) { (channelmanagerPointer: UnsafePointer<LDKChannelManager>) in
 
-				Result_InvoiceSignOrCreationErrorZ(pointer: create_invoice_from_channelmanager_with_description_hash_and_duration_since_epoch(channelmanagerPointer, keys_manager.cOpaqueStruct!, network, amt_msat.danglingClone().cOpaqueStruct!, description_hash.danglingClone().cOpaqueStruct!, duration_since_epoch))
+				Result_InvoiceSignOrCreationErrorZ(pointer: create_invoice_from_channelmanager_with_description_hash_and_duration_since_epoch(channelmanagerPointer, keys_manager.activate().cOpaqueStruct!, network, amt_msat.danglingClone().cOpaqueStruct!, description_hash.danglingClone().cOpaqueStruct!, duration_since_epoch))
 
 }
 
@@ -6312,39 +6321,35 @@ withUnsafePointer(to: Bindings.array_to_tuple32(array: random_seed_bytes)) { (ra
 
 				return withUnsafePointer(to: channelmanager.cOpaqueStruct!) { (channelmanagerPointer: UnsafePointer<LDKChannelManager>) in
 
-				Result_InvoiceSignOrCreationErrorZ(pointer: create_invoice_from_channelmanager_and_duration_since_epoch(channelmanagerPointer, keys_manager.cOpaqueStruct!, network, amt_msat.danglingClone().cOpaqueStruct!, Bindings.new_LDKStr(string: description, chars_is_owned: true), duration_since_epoch))
+				Result_InvoiceSignOrCreationErrorZ(pointer: create_invoice_from_channelmanager_and_duration_since_epoch(channelmanagerPointer, keys_manager.activate().cOpaqueStruct!, network, amt_msat.danglingClone().cOpaqueStruct!, Bindings.new_LDKStr(string: description, chars_is_owned: true), duration_since_epoch))
 
 }
 
 	}
 
 	/* STATIC_METHODS_END */
 
-	static var nativelyExposedInstances = [String: NativeTypeWrapper]()
+	static var nativelyExposedInstances = [UInt: NativeTraitWrapper]()
 
-	public class func instanceToPointer(instance: NativeTypeWrapper) -> UnsafeMutableRawPointer {
-		let pointer = Unmanaged.passUnretained(instance).toOpaque()
-        instance.pointerDebugDescription = pointer.debugDescription
-		Self.nativelyExposedInstances[pointer.debugDescription] = instance
+	public class func cacheInstance(instance: NativeTraitWrapper) {
+        Self.nativelyExposedInstances[instance.globalInstanceNumber] = instance
+    }
+
+	public class func instanceToPointer(instance: NativeTraitWrapper) -> UnsafeMutableRawPointer {
+        let pointer = UnsafeMutableRawPointer(bitPattern: instance.globalInstanceNumber)!
+		// don't automatically cache the trait instance
+		// Self.nativelyExposedInstances[instance.globalInstanceNumber] = instance
 		return pointer
 	}
 
-	public class func pointerToInstance<T: NativeTypeWrapper>(pointer: UnsafeRawPointer, sourceMarker: String?) -> T{
-
-		let callStack = Thread.callStackSymbols
-		let caller = sourceMarker ?? callStack[1]
-		// print("Retrieving instance from pointer for caller: \(caller)")
-		// let value = Unmanaged<T>.fromOpaque(pointer).takeUnretainedValue()
-		let value = Self.nativelyExposedInstances[pointer.debugDescription] as! T
-		// print("Instance retrieved for caller: \(caller)")
+	public class func pointerToInstance<T: NativeTraitWrapper>(pointer: UnsafeRawPointer, sourceMarker: String?) -> T{
+        let key = UInt(bitPattern: pointer)
+		let value = Self.nativelyExposedInstances[key] as! T
 		return value
 	}
 
     public class func removeInstancePointer(instance: NativeTypeWrapper) -> Bool {
-        guard let debugDescription = instance.pointerDebugDescription else {
-            return false
-        }
-        Self.nativelyExposedInstances.removeValue(forKey: debugDescription)
+        Self.nativelyExposedInstances.removeValue(forKey: instance.globalInstanceNumber)
         instance.pointerDebugDescription = nil
         return true
     }
@@ -6491,14 +6496,14 @@ withUnsafePointer(to: Bindings.array_to_tuple32(array: random_seed_bytes)) { (ra
 		}
 	}
 	*/
-	
+
 	public class func get_ldk_swift_bindings_version() -> String {
-        return "e8cb2170ad6613f76c8a5a95941b8b8e2f90b5e1"
+        return "b058a25ba435d31e8885e804c0a65425e456ea10"
     }
 
 }
 
-public class InstanceCrashSimulator: NativeTypeWrapper {
+public class InstanceCrashSimulator: NativeTraitWrapper {
 
     public init() {
 		super.init(conflictAvoidingVariableName: 0)

bindings/LDK/options/MonitorEvent.swift

@@ -63,7 +63,7 @@ public class MonitorEvent: NativeTypeWrapper {
 				self.cOpaqueStruct!.commitment_tx_confirmed;
 				if cStruct.inner == nil {
 					return nil
-				}	
+				}
 				return OutPoint(pointer: cStruct, anchor: self)
 				}()
 
@@ -86,7 +86,7 @@ public class MonitorEvent: NativeTypeWrapper {
 				self.cOpaqueStruct!.update_failed;
 				if cStruct.inner == nil {
 					return nil
-				}	
+				}
 				return OutPoint(pointer: cStruct, anchor: self)
 				}()
 
@@ -192,7 +192,7 @@ MonitorEvent_write(objPointer)
 				self.cOpaqueStruct!.funding_txo;
 				if cStruct.inner == nil {
 					return nil
-				}	
+				}
 				return OutPoint(pointer: cStruct, anchor: self)
 				}()
 

bindings/LDK/options/Option_AccessZ.swift

@@ -59,7 +59,7 @@ public class Option_AccessZ: NativeTypeWrapper {
 
     public class func some(o: Access) -> Option_AccessZ {
 
-        return Option_AccessZ(pointer: COption_AccessZ_some(o.cOpaqueStruct!));
+        return Option_AccessZ(pointer: COption_AccessZ_some(o.activate().cOpaqueStruct!));
     }
 
     public class func none() -> Option_AccessZ {

bindings/LDK/options/Option_FilterZ.swift

@@ -59,7 +59,7 @@ public class Option_FilterZ: NativeTypeWrapper {
 
     public class func some(o: Filter) -> Option_FilterZ {
 
-        return Option_FilterZ(pointer: COption_FilterZ_some(o.cOpaqueStruct!));
+        return Option_FilterZ(pointer: COption_FilterZ_some(o.activate().cOpaqueStruct!));
     }
 
     public class func none() -> Option_FilterZ {

bindings/LDK/options/SpendableOutputDescriptor.swift

@@ -160,7 +160,7 @@ SpendableOutputDescriptor_write(objPointer)
 				self.cOpaqueStruct!.outpoint;
 				if cStruct.inner == nil {
 					return nil
-				}	
+				}
 				return OutPoint(pointer: cStruct, anchor: self)
 				}()
 

bindings/LDK/results/Result_OutPointDecodeErrorZ.swift

@@ -53,7 +53,7 @@ public class Result_OutPointDecodeErrorZ: NativeTypeWrapper {
 				self.cOpaqueStruct!.contents.result.pointee;
 				if cStruct.inner == nil {
 					return nil
-				}	
+				}
 				return OutPoint(pointer: cStruct, anchor: self)
 				}()
 

bindings/LDK/structs/BackgroundProcessor.swift

@@ -18,7 +18,7 @@ let graphMessageHandler = net_graph_msg_handler?.cOpaqueStruct! ?? LDKNetGraphMs
         self.cOpaqueStruct = withUnsafePointer(to: chain_monitor.cOpaqueStruct!) { (chain_monitorPointer: UnsafePointer<LDKChainMonitor>) in
 withUnsafePointer(to: channel_manager.cOpaqueStruct!) { (channel_managerPointer: UnsafePointer<LDKChannelManager>) in
 withUnsafePointer(to: peer_manager.cOpaqueStruct!) { (peer_managerPointer: UnsafePointer<LDKPeerManager>) in
-BackgroundProcessor_start(persister.cOpaqueStruct!, event_handler.cOpaqueStruct!, chain_monitorPointer, channel_managerPointer, graphMessageHandler, peer_managerPointer, logger.cOpaqueStruct!)
+BackgroundProcessor_start(persister.activate().cOpaqueStruct!, event_handler.activate().cOpaqueStruct!, chain_monitorPointer, channel_managerPointer, graphMessageHandler, peer_managerPointer, logger.activate().cOpaqueStruct!)
 }
 }
 }

bindings/LDK/structs/ChainMonitor.swift

@@ -13,7 +13,7 @@ public init(chain_source: Option_FilterZ, broadcaster: BroadcasterInterface, log
     	Self.instanceCounter += 1
 		self.instanceNumber = Self.instanceCounter
 
-        self.cOpaqueStruct = ChainMonitor_new(chain_source.cOpaqueStruct!, broadcaster.cOpaqueStruct!, logger.cOpaqueStruct!, feeest.cOpaqueStruct!, persister.cOpaqueStruct!)
+        self.cOpaqueStruct = ChainMonitor_new(chain_source.cOpaqueStruct!, broadcaster.activate().cOpaqueStruct!, logger.activate().cOpaqueStruct!, feeest.activate().cOpaqueStruct!, persister.activate().cOpaqueStruct!)
         super.init(conflictAvoidingVariableName: 0)
         try? self.addAnchor(anchor: chain_source)
 try? self.addAnchor(anchor: broadcaster)

bindings/LDK/structs/ChannelDetails.swift

@@ -75,7 +75,7 @@ ChannelDetails_get_funding_txo(this_ptrPointer)
 };
 				if cStruct.inner == nil {
 					return nil
-				}	
+				}
 				return OutPoint(pointer: cStruct)
 				}()
 			;

bindings/LDK/structs/ChannelManager.swift

@@ -11,7 +11,7 @@ public class ChannelManager: NativeTypeWrapper {
     	Self.instanceCounter += 1
 		self.instanceNumber = Self.instanceCounter
 
-        self.cOpaqueStruct = ChannelManager_new(fee_est.cOpaqueStruct!, chain_monitor.cOpaqueStruct!, tx_broadcaster.cOpaqueStruct!, logger.cOpaqueStruct!, keys_manager.cOpaqueStruct!, config.danglingClone().cOpaqueStruct!, params.danglingClone().cOpaqueStruct!)
+        self.cOpaqueStruct = ChannelManager_new(fee_est.activate().cOpaqueStruct!, chain_monitor.activate().cOpaqueStruct!, tx_broadcaster.activate().cOpaqueStruct!, logger.activate().cOpaqueStruct!, keys_manager.activate().cOpaqueStruct!, config.danglingClone().cOpaqueStruct!, params.danglingClone().cOpaqueStruct!)
         super.init(conflictAvoidingVariableName: 0)
         try? self.addAnchor(anchor: fee_est)
 try? self.addAnchor(anchor: chain_monitor)