_ Git - ldk-java/blob - c_sharp/src/org/ldk/structs/OnionMessenger.cs

   1 using org.ldk.impl;
   2 using org.ldk.enums;
   3 using org.ldk.util;
   4 using System;
   5
   6 namespace org { namespace ldk { namespace structs {
   7
   8
   9 /**
  10  * A sender, receiver and forwarder of [`OnionMessage`]s.
  11  *
  12  * # Handling Messages
  13  *
  14  * `OnionMessenger` implements [`OnionMessageHandler`], making it responsible for either forwarding
  15  * messages to peers or delegating to the appropriate handler for the message type. Currently, the
  16  * available handlers are:
  17  * [`OffersMessageHandler`], for responding to [`InvoiceRequest`]s and paying [`Bolt12Invoice`]s
  18  * [`CustomOnionMessageHandler`], for handling user-defined message types
  19  *
  20  * # Sending Messages
  21  *
  22  * [`OnionMessage`]s are sent initially using [`OnionMessenger::send_onion_message`]. When handling
  23  * a message, the matched handler may return a response message which `OnionMessenger` will send
  24  * on its behalf.
  25  *
  26  * # Example
  27  *
  28  * ```
  29  * # extern crate bitcoin;
  30  * # use bitcoin::hashes::_export::_core::time::Duration;
  31  * # use bitcoin::hashes::hex::FromHex;
  32  * # use bitcoin::secp256k1::{PublicKey, Secp256k1, SecretKey, self};
  33  * # use lightning::blinded_path::BlindedPath;
  34  * # use lightning::sign::{EntropySource, KeysManager};
  35  * # use lightning::ln::peer_handler::IgnoringMessageHandler;
  36  * # use lightning::onion_message::messenger::{Destination, MessageRouter, OnionMessagePath, OnionMessenger};
  37  * # use lightning::onion_message::packet::OnionMessageContents;
  38  * # use lightning::util::logger::{Logger, Record};
  39  * # use lightning::util::ser::{Writeable, Writer};
  40  * # use lightning::io;
  41  * # use std::sync::Arc;
  42  * # struct FakeLogger;
  43  * # impl Logger for FakeLogger {
  44  * #     fn log(&self, record: Record) { println!(\"{:?}\" , record); }
  45  * # }
  46  * # struct FakeMessageRouter {}
  47  * # impl MessageRouter for FakeMessageRouter {
  48  * #     fn find_path(&self, sender: PublicKey, peers: Vec<PublicKey>, destination: Destination) -> Result<OnionMessagePath, ()> {
  49  * #         let secp_ctx = Secp256k1::new();
  50  * #         let node_secret = SecretKey::from_slice(&<Vec<u8>>::from_hex(\"0101010101010101010101010101010101010101010101010101010101010101\").unwrap()[..]).unwrap();
  51  * #         let hop_node_id1 = PublicKey::from_secret_key(&secp_ctx, &node_secret);
  52  * #         let hop_node_id2 = hop_node_id1;
  53  * #         Ok(OnionMessagePath {
  54  * #             intermediate_nodes: vec![hop_node_id1, hop_node_id2],
  55  * #             destination,
  56  * #             first_node_addresses: None,
  57  * #         })
  58  * #     }
  59  * #     fn create_blinded_paths<T: secp256k1::Signing + secp256k1::Verification>(
  60  * #         &self, _recipient: PublicKey, _peers: Vec<PublicKey>, _secp_ctx: &Secp256k1<T>
  61  * #     ) -> Result<Vec<BlindedPath>, ()> {
  62  * #         unreachable!()
  63  * #     }
  64  * # }
  65  * # let seed = [42u8; 32];
  66  * # let time = Duration::from_secs(123456);
  67  * # let keys_manager = KeysManager::new(&seed, time.as_secs(), time.subsec_nanos());
  68  * # let logger = Arc::new(FakeLogger {});
  69  * # let node_secret = SecretKey::from_slice(&<Vec<u8>>::from_hex(\"0101010101010101010101010101010101010101010101010101010101010101\").unwrap()[..]).unwrap();
  70  * # let secp_ctx = Secp256k1::new();
  71  * # let hop_node_id1 = PublicKey::from_secret_key(&secp_ctx, &node_secret);
  72  * # let (hop_node_id3, hop_node_id4) = (hop_node_id1, hop_node_id1);
  73  * # let destination_node_id = hop_node_id1;
  74  * # let message_router = Arc::new(FakeMessageRouter {});
  75  * # let custom_message_handler = IgnoringMessageHandler {};
  76  * # let offers_message_handler = IgnoringMessageHandler {};
  77  * Create the onion messenger. This must use the same `keys_manager` as is passed to your
  78  * ChannelManager.
  79  * let onion_messenger = OnionMessenger::new(
  80  * &keys_manager, &keys_manager, logger, message_router, &offers_message_handler,
  81  * &custom_message_handler
  82  * );
  83  *
  84  * # #[derive(Debug, Clone)]
  85  * # struct YourCustomMessage {}
  86  * impl Writeable for YourCustomMessage {
  87  * \tfn write<W: Writer>(&self, w: &mut W) -> Result<(), io::Error> {
  88  * \t\t# Ok(())
  89  * \t\t// Write your custom onion message to `w`
  90  * \t}
  91  * }
  92  * impl OnionMessageContents for YourCustomMessage {
  93  * \tfn tlv_type(&self) -> u64 {
  94  * \t\t# let your_custom_message_type = 42;
  95  * \t\tyour_custom_message_type
  96  * \t}
  97  * }
  98  * Send a custom onion message to a node id.
  99  * let destination = Destination::Node(destination_node_id);
 100  * let reply_path = None;
 101  * # let message = YourCustomMessage {};
 102  * onion_messenger.send_onion_message(message, destination, reply_path);
 103  *
 104  * Create a blinded path to yourself, for someone to send an onion message to.
 105  * # let your_node_id = hop_node_id1;
 106  * let hops = [hop_node_id3, hop_node_id4, your_node_id];
 107  * let blinded_path = BlindedPath::new_for_message(&hops, &keys_manager, &secp_ctx).unwrap();
 108  *
 109  * Send a custom onion message to a blinded path.
 110  * let destination = Destination::BlindedPath(blinded_path);
 111  * let reply_path = None;
 112  * # let message = YourCustomMessage {};
 113  * onion_messenger.send_onion_message(message, destination, reply_path);
 114  * ```
 115  *
 116  * [`InvoiceRequest`]: crate::offers::invoice_request::InvoiceRequest
 117  * [`Bolt12Invoice`]: crate::offers::invoice::Bolt12Invoice
 118  */
 119 public class OnionMessenger : CommonBase {
 120         internal OnionMessenger(object _dummy, long ptr) : base(ptr) { }
 121         ~OnionMessenger() {
 122                 if (ptr != 0) { bindings.OnionMessenger_free(ptr); }
 123         }
 124
 125         /**
 126          * Constructs a new `OnionMessenger` to send, forward, and delegate received onion messages to
 127          * their respective handlers.
 128          */
 129         public static OnionMessenger of(org.ldk.structs.EntropySource entropy_source, org.ldk.structs.NodeSigner node_signer, org.ldk.structs.Logger logger, org.ldk.structs.MessageRouter message_router, org.ldk.structs.OffersMessageHandler offers_handler, org.ldk.structs.CustomOnionMessageHandler custom_handler) {
 130                 long ret = bindings.OnionMessenger_new(entropy_source.ptr, node_signer.ptr, logger.ptr, message_router.ptr, offers_handler.ptr, custom_handler.ptr);
 131                 GC.KeepAlive(entropy_source);
 132                 GC.KeepAlive(node_signer);
 133                 GC.KeepAlive(logger);
 134                 GC.KeepAlive(message_router);
 135                 GC.KeepAlive(offers_handler);
 136                 GC.KeepAlive(custom_handler);
 137                 if (ret >= 0 && ret <= 4096) { return null; }
 138                 org.ldk.structs.OnionMessenger ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.OnionMessenger(null, ret); }
 139                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.AddLast(ret_hu_conv); };
 140                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.AddLast(entropy_source); };
 141                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.AddLast(node_signer); };
 142                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.AddLast(logger); };
 143                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.AddLast(message_router); };
 144                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.AddLast(offers_handler); };
 145                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.AddLast(custom_handler); };
 146                 return ret_hu_conv;
 147         }
 148
 149         /**
 150          * Sends an [`OnionMessage`] with the given `contents` to `destination`.
 151          *
 152          * See [`OnionMessenger`] for example usage.
 153          *
 154          * Note that reply_path (or a relevant inner pointer) may be NULL or all-0s to represent None
 155          */
 156         public Result_SendSuccessSendErrorZ send_onion_message(org.ldk.structs.OnionMessageContents contents, org.ldk.structs.Destination destination, org.ldk.structs.BlindedPath reply_path) {
 157                 long ret = bindings.OnionMessenger_send_onion_message(this.ptr, contents.ptr, destination.ptr, reply_path == null ? 0 : reply_path.ptr);
 158                 GC.KeepAlive(this);
 159                 GC.KeepAlive(contents);
 160                 GC.KeepAlive(destination);
 161                 GC.KeepAlive(reply_path);
 162                 if (ret >= 0 && ret <= 4096) { return null; }
 163                 Result_SendSuccessSendErrorZ ret_hu_conv = Result_SendSuccessSendErrorZ.constr_from_ptr(ret);
 164                 if (this != null) { this.ptrs_to.AddLast(contents); };
 165                 if (this != null) { this.ptrs_to.AddLast(destination); };
 166                 if (this != null) { this.ptrs_to.AddLast(reply_path); };
 167                 return ret_hu_conv;
 168         }
 169
 170         /**
 171          * Constructs a new OnionMessageHandler which calls the relevant methods on this_arg.
 172          * This copies the `inner` pointer in this_arg and thus the returned OnionMessageHandler must be freed before this_arg is
 173          */
 174         public OnionMessageHandler as_OnionMessageHandler() {
 175                 long ret = bindings.OnionMessenger_as_OnionMessageHandler(this.ptr);
 176                 GC.KeepAlive(this);
 177                 if (ret >= 0 && ret <= 4096) { return null; }
 178                 OnionMessageHandler ret_hu_conv = new OnionMessageHandler(null, ret);
 179                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.AddLast(this); };
 180                 return ret_hu_conv;
 181         }
 182
 183 }
 184 } } }