Skip to content

batteries: Allow wrapping the MessageRouter in ChannelManagerConstructor #183

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
Synesso wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

batteries: Allow wrapping the MessageRouter in ChannelManagerConstructor #183

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
64 changes: 58 additions & 6 deletions src/main/java/org/ldk/batteries/ChannelManagerConstructor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ public static class InvalidSerializedDataException extends Exception {
private final EntropySource entropy_source;
private final NodeSigner node_signer;
private final Router router;
private final DefaultMessageRouter msg_router;
private final MessageRouter msg_router;

/**
* Exposes the `ProbabilisticScorer` wrapped inside a lock. Don't forget to `close` this lock when you're done with
Expand Down Expand Up @@ -126,13 +126,36 @@ Result_RouteLightningErrorZ find_route(byte[] payer_node_id, RouteParameters rou
InFlightHtlcs inflight_htlcs, @Nullable byte[] payment_hash, @Nullable byte[] payment_id, DefaultRouter default_router);
}

/**
* A simple interface to provide onion message paths to LDK.
*/
public interface MessageRouterWrapper {
/**
* Finds a path for an onion message to the given destination.
*
* @param default_message_router Provides a message router which uses the LDK path-finder backed by the
* network graph. You may use this to fetch a "default" path, modifying or
* storing it as you wish before returning it to LDK.
*/
Result_OnionMessagePathNoneZ find_path(byte[] sender, byte[][] peers, Destination destination,
DefaultMessageRouter default_message_router);

/**
* Creates blinded message paths to the recipient. Implementations which only wish to customize
* [`find_path`] should delegate to `default_message_router`.
*/
Result_CVec_BlindedMessagePathZNoneZ create_blinded_paths(byte[] recipient, MessageContext context,
byte[][] peers, DefaultMessageRouter default_message_router);
}

/**
* Deserializes a channel manager and a set of channel monitors from the given serialized copies and interface implementations
*
* @param filter If provided, the outputs which were previously registered to be monitored for will be loaded into the filter.
* Note that if the provided Watch is a ChainWatch and has an associated filter, the previously registered
* outputs will be loaded when chain_sync_completed is called.
* @param router_wrapper If provided, routes will be fetched by calling the given router rather than an LDK `DefaultRouter`.
* @param message_router_wrapper If provided, onion message paths will be fetched by calling the given router rather than an LDK `DefaultMessageRouter`.
*/
public ChannelManagerConstructor(byte[] channel_manager_serialized, byte[][] channel_monitors_serialized, UserConfig config,
EntropySource entropy_source, NodeSigner node_signer, SignerProvider signer_provider,
Expand All @@ -141,6 +164,7 @@ public ChannelManagerConstructor(byte[] channel_manager_serialized, byte[][] cha
ProbabilisticScoringDecayParameters scoring_decay_params,
ProbabilisticScoringFeeParameters scoring_fee_params,
byte[] probabilistic_scorer_bytes, @Nullable RouterWrapper router_wrapper,
@Nullable MessageRouterWrapper message_router_wrapper,
BroadcasterInterface tx_broadcaster, Logger logger) throws InvalidSerializedDataException {
this.entropy_source = entropy_source;
this.node_signer = node_signer;
Expand Down Expand Up @@ -181,7 +205,20 @@ public Result_CVec_BlindedPaymentPathZNoneZ create_blinded_payment_paths(byte[]
} else {
router = default_router.as_Router();
}
msg_router = DefaultMessageRouter.of(this.net_graph, entropy_source);
DefaultMessageRouter default_msg_router = DefaultMessageRouter.of(this.net_graph, entropy_source);
if (message_router_wrapper != null) {
msg_router = MessageRouter.new_impl(new MessageRouter.MessageRouterInterface() {
@Override public Result_OnionMessagePathNoneZ find_path(byte[] sender, byte[][] peers, Destination destination) {
return message_router_wrapper.find_path(sender, peers, destination, default_msg_router);
}

@Override public Result_CVec_BlindedMessagePathZNoneZ create_blinded_paths(byte[] recipient, MessageContext context, byte[][] peers) {
return message_router_wrapper.create_blinded_paths(recipient, context, peers, default_msg_router);
}
});
} else {
msg_router = default_msg_router.as_MessageRouter();
}

final ChannelMonitor[] monitors = new ChannelMonitor[channel_monitors_serialized.length];
this.channel_monitors = new TwoTuple_ThirtyTwoBytesChannelMonitorZ[monitors.length];
Expand All @@ -200,7 +237,7 @@ public Result_CVec_BlindedPaymentPathZNoneZ create_blinded_payment_paths(byte[]
Result_C2Tuple_ThirtyTwoBytesChannelManagerZDecodeErrorZ res =
UtilMethods.C2Tuple_ThirtyTwoBytesChannelManagerZ_read(channel_manager_serialized, entropy_source,
node_signer, signer_provider, fee_estimator, chain_monitor.as_Watch(),
tx_broadcaster, router, this.msg_router.as_MessageRouter(), logger, config, monitors);
tx_broadcaster, router, this.msg_router, logger, config, monitors);
if (!res.is_ok()) {
throw new InvalidSerializedDataException("Serialized ChannelManager was corrupt");
}
Expand All @@ -219,13 +256,15 @@ public Result_CVec_BlindedPaymentPathZNoneZ create_blinded_payment_paths(byte[]
* Constructs a channel manager from the given interface implementations
*
* @param router_wrapper If provided, routes will be fetched by calling the given router rather than an LDK `DefaultRouter`.
* @param message_router_wrapper If provided, onion message paths will be fetched by calling the given router rather than an LDK `DefaultMessageRouter`.
*/
public ChannelManagerConstructor(Network network, UserConfig config, byte[] current_blockchain_tip_hash, int current_blockchain_tip_height,
EntropySource entropy_source, NodeSigner node_signer, SignerProvider signer_provider,
FeeEstimator fee_estimator, ChainMonitor chain_monitor,
NetworkGraph net_graph, ProbabilisticScoringDecayParameters scoring_decay_params,
ProbabilisticScoringFeeParameters scoring_fee_params,
@Nullable RouterWrapper router_wrapper,
@Nullable MessageRouterWrapper message_router_wrapper,
BroadcasterInterface tx_broadcaster, Logger logger) {
this.entropy_source = entropy_source;
this.node_signer = node_signer;
Expand Down Expand Up @@ -253,14 +292,27 @@ public Result_CVec_BlindedPaymentPathZNoneZ create_blinded_payment_paths(byte[]
} else {
router = default_router.as_Router();
}
msg_router = DefaultMessageRouter.of(this.net_graph, entropy_source);
DefaultMessageRouter default_msg_router = DefaultMessageRouter.of(this.net_graph, entropy_source);
if (message_router_wrapper != null) {
msg_router = MessageRouter.new_impl(new MessageRouter.MessageRouterInterface() {
@Override public Result_OnionMessagePathNoneZ find_path(byte[] sender, byte[][] peers, Destination destination) {
return message_router_wrapper.find_path(sender, peers, destination, default_msg_router);
}

@Override public Result_CVec_BlindedMessagePathZNoneZ create_blinded_paths(byte[] recipient, MessageContext context, byte[][] peers) {
return message_router_wrapper.create_blinded_paths(recipient, context, peers, default_msg_router);
}
});
} else {
msg_router = default_msg_router.as_MessageRouter();
}
channel_monitors = new TwoTuple_ThirtyTwoBytesChannelMonitorZ[0];
channel_manager_latest_block_hash = null;
this.chain_monitor = chain_monitor;
BestBlock block = BestBlock.of(current_blockchain_tip_hash, current_blockchain_tip_height);
ChainParameters params = ChainParameters.of(network, block);
channel_manager = ChannelManager.of(fee_estimator, chain_monitor.as_Watch(), tx_broadcaster, router,
this.msg_router.as_MessageRouter(), logger, entropy_source, node_signer, signer_provider, config, params,
this.msg_router, logger, entropy_source, node_signer, signer_provider, config, params,
(int) (System.currentTimeMillis() / 1000));
this.logger = logger;
}
Expand Down Expand Up @@ -305,7 +357,7 @@ public void chain_sync_completed(EventHandler event_handler, boolean use_p2p_gra
else
routing_msg_handler = ignoring_handler.as_RoutingMessageHandler();
OnionMessenger messenger = OnionMessenger.of(this.entropy_source, this.node_signer, this.logger,
this.channel_manager.as_NodeIdLookUp(), this.msg_router.as_MessageRouter(),
this.channel_manager.as_NodeIdLookUp(), this.msg_router,
channel_manager.as_OffersMessageHandler(), IgnoringMessageHandler.of().as_AsyncPaymentsMessageHandler(),
channel_manager.as_DNSResolverMessageHandler(),
IgnoringMessageHandler.of().as_CustomOnionMessageHandler());
Expand Down
Loading