1 import * as rawldk from "../bindings.mjs";
2 import * as ldk from "../index.mjs";
4 const tests: Array<Function> = [];
6 function array_eq(a: Uint8Array, b: Uint8Array): boolean {
7 return a.length == b.length && a.every((v, idx) => v == b[idx]);
10 tests.push(async () => {
11 const result = rawldk.CResult_boolLightningErrorZ_ok(true);
12 console.assert(rawldk.CResult_boolLightningErrorZ_is_ok(result));
13 console.assert(rawldk.CResult_boolLightningErrorZ_get_ok(result));
14 rawldk.CResult_boolLightningErrorZ_free(result);
15 const second_res = rawldk.CResult_boolLightningErrorZ_ok(false);
16 console.assert(rawldk.CResult_boolLightningErrorZ_is_ok(second_res));
17 console.assert(!rawldk.CResult_boolLightningErrorZ_get_ok(second_res));
18 rawldk.CResult_boolLightningErrorZ_free(second_res);
23 tests.push(async () => {
24 const ping = ldk.Ping.constructor_new(10, 2);
25 const new_ping = ldk.Ping.constructor_read(ping.write());
26 if (!(new_ping instanceof ldk.Result_PingDecodeErrorZ_OK)) return false;
27 if (!new_ping.is_ok()) return false;
28 if (new_ping.res.get_byteslen() != 2) return false;
29 if (new_ping.res.get_ponglen() != 10) return false;
33 tests.push(async () => {
34 const outpoint = ldk.OutPoint.constructor_new(new Uint8Array(32), 4);
35 const read_outpoint = ldk.OutPoint.constructor_read(outpoint.write());
36 if (!(read_outpoint instanceof ldk.Result_OutPointDecodeErrorZ_OK)) return false;
37 if (!read_outpoint.res.eq(outpoint)) return false;
38 if (read_outpoint.res.hash() != outpoint.hash()) return false;
39 const chan_id = read_outpoint.res.to_channel_id();
40 if (chan_id.length != 32) return false;
41 if (chan_id[31] != 4) return false;
45 tests.push(async () => {
46 const outpoint = ldk.OutPoint.constructor_new(new Uint8Array(32), 4);
47 const read_outpoint = ldk.OutPoint.constructor_read(outpoint.write());
48 if (!(read_outpoint instanceof ldk.Result_OutPointDecodeErrorZ_OK)) return false;
49 if (!read_outpoint.res.eq(outpoint)) return false;
50 if (read_outpoint.res.hash() != outpoint.hash()) return false;
51 const chan_id = read_outpoint.res.to_channel_id();
52 if (chan_id.length != 32) return false;
53 if (chan_id[31] != 4) return false;
60 node_secret: Uint8Array;
61 constructor(public chan_man: ldk.ChannelManager, public tx_broadcasted: Promise<Uint8Array>,
62 public logger: ldk.Logger, public keys_interface: ldk.KeysInterface) {
63 this.node_id = chan_man.get_our_node_id();
64 this.node_secret = (keys_interface.get_node_secret(ldk.Recipient.LDKRecipient_Node) as ldk.Result_SecretKeyNoneZ_OK).res;
67 function get_chanman(): Node {
68 const fee_est = ldk.FeeEstimator.new_impl({
69 get_est_sat_per_1000_weight(confirmation_target: ldk.ConfirmationTarget): number {
72 } as ldk.FeeEstimatorInterface);
74 const tx_broadcasted: Promise<Uint8Array> = new Promise((resolve, reject) => {
75 tx_broadcaster = ldk.BroadcasterInterface.new_impl({
76 broadcast_transaction(tx: Uint8Array): void { console.log("Tx Broadcast: " + tx); resolve(tx); }
77 } as ldk.BroadcasterInterfaceInterface);
79 const logger = ldk.Logger.new_impl({
80 log(record: ldk.Record): void {
81 console.log(record.get_module_path() + ": " + record.get_args());
83 } as ldk.LoggerInterface);
85 const persister = ldk.Persist.new_impl({
86 persist_new_channel(channel_id: ldk.OutPoint, data: ldk.ChannelMonitor, update_id: ldk.MonitorUpdateId): ldk.Result_NoneChannelMonitorUpdateErrZ {
87 return ldk.Result_NoneChannelMonitorUpdateErrZ.constructor_ok();
89 update_persisted_channel(channel_id: ldk.OutPoint, update: ldk.ChannelMonitorUpdate, data: ldk.ChannelMonitor, update_id: ldk.MonitorUpdateId): ldk.Result_NoneChannelMonitorUpdateErrZ {
90 return ldk.Result_NoneChannelMonitorUpdateErrZ.constructor_ok();
92 } as ldk.PersistInterface);
94 const chain_monitor = ldk.ChainMonitor.constructor_new(ldk.Option_FilterZ.constructor_none(), tx_broadcaster, logger, fee_est, persister);
95 const chain_watch: ldk.Watch = chain_monitor.as_Watch();
97 const seed = new Uint8Array(32);
98 seed.fill(seed_counter);
100 const keys_manager = ldk.KeysManager.constructor_new(seed, BigInt(42), 42);
101 const keys_interface = keys_manager.as_KeysInterface();
102 const config = ldk.UserConfig.constructor_default();
103 const params = ldk.ChainParameters.constructor_new(ldk.Network.LDKNetwork_Testnet, ldk.BestBlock.constructor_from_genesis(ldk.Network.LDKNetwork_Testnet));
105 const chan_man = ldk.ChannelManager.constructor_new(fee_est, chain_watch, tx_broadcaster, logger, keys_interface, config, params);
106 return new Node(chan_man, tx_broadcasted, logger, keys_interface);
109 function exchange_messages(a: ldk.ChannelManager, b: ldk.ChannelManager) {
110 var found_msgs = true;
112 const as_msgs = a.as_MessageSendEventsProvider().get_and_clear_pending_msg_events();
113 const bs_msgs = b.as_MessageSendEventsProvider().get_and_clear_pending_msg_events();
114 found_msgs = as_msgs.length != 0 || bs_msgs.length != 0;
115 for (var i = 0; i < 2; i++) {
116 var to: ldk.ChannelManager; var from: ldk.ChannelManager; var msgs: ldk.MessageSendEvent[];
117 if (i == 0) { from = a; to = b; msgs = as_msgs; } else { from = b; to = a; msgs = bs_msgs; }
118 for (var j = 0; j < msgs.length; j++) {
120 if (msg instanceof ldk.MessageSendEvent_SendOpenChannel) {
121 if (!array_eq(msg.node_id, to.get_our_node_id())) return false;
122 to.as_ChannelMessageHandler().handle_open_channel(from.get_our_node_id(), ldk.InitFeatures.constructor_known(), msg.msg);
123 } else if (msg instanceof ldk.MessageSendEvent_SendAcceptChannel) {
124 if (!array_eq(msg.node_id, to.get_our_node_id())) return false;
125 to.as_ChannelMessageHandler().handle_accept_channel(from.get_our_node_id(), ldk.InitFeatures.constructor_known(), msg.msg);
126 } else if (msg instanceof ldk.MessageSendEvent_SendFundingCreated) {
127 if (!array_eq(msg.node_id, to.get_our_node_id())) return false;
128 to.as_ChannelMessageHandler().handle_funding_created(from.get_our_node_id(), msg.msg);
129 } else if (msg instanceof ldk.MessageSendEvent_SendFundingSigned) {
130 if (!array_eq(msg.node_id, to.get_our_node_id())) return false;
131 to.as_ChannelMessageHandler().handle_funding_signed(from.get_our_node_id(), msg.msg);
141 function assign_u64(arr: Uint8Array, offset: number, value: bigint) {
142 arr[offset + 0] = Number((value >> BigInt(8 * 0)) & BigInt(0xff));
143 arr[offset + 1] = Number((value >> BigInt(8 * 1)) & BigInt(0xff));
144 arr[offset + 2] = Number((value >> BigInt(8 * 2)) & BigInt(0xff));
145 arr[offset + 3] = Number((value >> BigInt(8 * 3)) & BigInt(0xff));
146 arr[offset + 4] = Number((value >> BigInt(8 * 4)) & BigInt(0xff));
147 arr[offset + 5] = Number((value >> BigInt(8 * 5)) & BigInt(0xff));
148 arr[offset + 6] = Number((value >> BigInt(8 * 6)) & BigInt(0xff));
149 arr[offset + 7] = Number((value >> BigInt(8 * 7)) & BigInt(0xff));
152 function get_event(chan_man: ldk.ChannelManager): ldk.Event {
153 const events: Array<ldk.Event> = [];
154 const event_handler = ldk.EventHandler.new_impl({
155 handle_event(event: ldk.Event): void {
158 } as ldk.EventHandlerInterface);
160 chan_man.as_EventsProvider().process_pending_events(event_handler);
161 console.assert(events.length == 1);
165 tests.push(async () => {
166 const a = get_chanman();
167 const b = get_chanman();
169 a.chan_man.as_ChannelMessageHandler().peer_connected(b.chan_man.get_our_node_id(), ldk.Init.constructor_new(ldk.InitFeatures.constructor_known(), ldk.Option_NetAddressZ.constructor_none()));
170 b.chan_man.as_ChannelMessageHandler().peer_connected(a.chan_man.get_our_node_id(), ldk.Init.constructor_new(ldk.InitFeatures.constructor_known(), ldk.Option_NetAddressZ.constructor_none()));
172 const chan_create_err = a.chan_man.create_channel(b.chan_man.get_our_node_id(), BigInt(0), BigInt(400), BigInt(0), ldk.UserConfig.constructor_default());
173 if (chan_create_err.is_ok()) return false;
174 if (!(chan_create_err instanceof ldk.Result__u832APIErrorZ_Err)) return false;
175 if (!(chan_create_err.err instanceof ldk.APIError_APIMisuseError)) return false;
176 if (chan_create_err.err.err != "Channel value must be at least 1000 satoshis. It was 0") return false;
178 const chan_create_res = a.chan_man.create_channel(b.chan_man.get_our_node_id(), BigInt(1000000), BigInt(400), BigInt(0), ldk.UserConfig.constructor_default());
179 if (!chan_create_res.is_ok()) return false;
181 if (!exchange_messages(a.chan_man, b.chan_man)) return false;
183 const event = get_event(a.chan_man) as ldk.Event_FundingGenerationReady;
185 // (very) manually create a funding transaction
186 const witness_pos = event.output_script.length + 58;
187 const funding_tx = new Uint8Array(witness_pos + 7);
188 funding_tx[0] = 2; // 4-byte tx version 2
189 funding_tx[4] = 0; funding_tx[5] = 1; // segwit magic bytes
190 funding_tx[6] = 1; // 1-byte input count 1
191 // 36 bytes previous outpoint all-0s
192 funding_tx[43] = 0; // 1-byte input script length 0
193 funding_tx[44] = 0xff; funding_tx[45] = 0xff; funding_tx[46] = 0xff; funding_tx[47] = 0xff; // 4-byte nSequence
194 funding_tx[48] = 1; // one output
195 assign_u64(funding_tx, 49, event.channel_value_satoshis);
196 funding_tx[57] = event.output_script.length; // 1-byte output script length
197 funding_tx.set(event.output_script, 58);
198 funding_tx[witness_pos] = 1; funding_tx[witness_pos + 1] = 1; funding_tx[witness_pos + 2] = 0xff; // one witness element of size 1 with contents 0xff
199 funding_tx[witness_pos + 3] = 0; funding_tx[witness_pos + 4] = 0; funding_tx[witness_pos + 5] = 0; funding_tx[witness_pos + 6] = 0; // lock time 0
201 const funding_res = a.chan_man.funding_transaction_generated(event.temporary_channel_id, event.counterparty_node_id, funding_tx);
202 if (!(funding_res instanceof ldk.Result_NoneAPIErrorZ_OK)) return false;
204 if (!exchange_messages(a.chan_man, b.chan_man)) return false;
206 const tx_broadcasted: Uint8Array = (await a.tx_broadcasted);
207 if (!array_eq(tx_broadcasted, funding_tx)) return false;
212 tests.push(async () => {
213 const a = get_chanman();
214 const b = get_chanman();
216 const ignorer = ldk.IgnoringMessageHandler.constructor_new();
217 const pm_a = ldk.PeerManager.constructor_new(a.chan_man.as_ChannelMessageHandler(), ignorer.as_RoutingMessageHandler(), ignorer.as_OnionMessageHandler(), a.node_secret, 0xdeadbeefn, a.node_secret, a.logger, ignorer.as_CustomMessageHandler());
218 const pm_b = ldk.PeerManager.constructor_new(b.chan_man.as_ChannelMessageHandler(), ignorer.as_RoutingMessageHandler(), ignorer.as_OnionMessageHandler(), b.node_secret, 0xdeadbeefn, b.node_secret, b.logger, ignorer.as_CustomMessageHandler());
220 var sock_b: ldk.SocketDescriptor;
221 const sock_a = ldk.SocketDescriptor.new_impl({
222 send_data(data: Uint8Array, resume_read: boolean): number {
223 console.assert(pm_b.read_event(sock_b, data) instanceof ldk.Result_boolPeerHandleErrorZ_OK);
226 disconnect_socket(): void {
227 console.assert(false);
229 eq(other: ldk.SocketDescriptor): boolean {
230 return other.hash() == this.hash();
235 } as ldk.SocketDescriptorInterface);
236 sock_b = ldk.SocketDescriptor.new_impl({
237 send_data(data: Uint8Array, resume_read: boolean): number {
238 console.assert(pm_a.read_event(sock_a, data) instanceof ldk.Result_boolPeerHandleErrorZ_OK);
241 disconnect_socket(): void {
242 console.assert(false);
244 eq(other: ldk.SocketDescriptor): boolean {
245 return other.hash() == this.hash();
250 } as ldk.SocketDescriptorInterface);
252 const v4_netaddr = ldk.NetAddress.constructor_ipv4(Uint8Array.from([42,0,42,1]), 9735);
253 console.assert(pm_b.new_inbound_connection(sock_b, ldk.Option_NetAddressZ.constructor_some(v4_netaddr)) instanceof ldk.Result_NonePeerHandleErrorZ_OK);
254 const init_bytes = pm_a.new_outbound_connection(b.node_id, sock_a, ldk.Option_NetAddressZ.constructor_none());
255 if (!(init_bytes instanceof ldk.Result_CVec_u8ZPeerHandleErrorZ_OK)) return false;
256 console.assert(pm_b.read_event(sock_b, init_bytes.res) instanceof ldk.Result_boolPeerHandleErrorZ_OK);
258 console.assert(pm_a.get_peer_node_ids().length == 0);
259 console.assert(pm_b.get_peer_node_ids().length == 0);
261 pm_b.process_events();
262 pm_a.process_events();
263 pm_b.process_events();
265 console.assert(pm_a.get_peer_node_ids().length == 1);
266 console.assert(pm_b.get_peer_node_ids().length == 1);
268 const chan_create_res = a.chan_man.create_channel(b.node_id, BigInt(1000000), BigInt(400), BigInt(0), ldk.UserConfig.constructor_default());
269 if (!chan_create_res.is_ok()) return false;
271 pm_a.process_events();
272 pm_b.process_events();
274 const event = get_event(a.chan_man);
275 if (!(event instanceof ldk.Event_FundingGenerationReady)) return false;
280 tests.push(async () => {
281 // Test passing onion messages through a custom trait implementation.
282 const a = get_chanman();
283 const b = get_chanman();
285 const ignorer = ldk.IgnoringMessageHandler.constructor_new();
287 const underlying_om_a = ldk.OnionMessenger.constructor_new(a.keys_interface, a.logger);
288 const om_provider_a = {
289 next_onion_message_for_peer(peer_node_id: Uint8Array): ldk.OnionMessage {
290 return underlying_om_a.as_OnionMessageProvider().next_onion_message_for_peer(peer_node_id);
292 } as ldk.OnionMessageProviderInterface;
293 const om_a = ldk.OnionMessageHandler.new_impl({
294 handle_onion_message(peer_node_id: Uint8Array, msg: ldk.OnionMessage) {
295 underlying_om_a.as_OnionMessageHandler().handle_onion_message(peer_node_id, msg);
297 peer_connected(their_node_id: Uint8Array, init: ldk.Init) {
298 underlying_om_a.as_OnionMessageHandler().peer_connected(their_node_id, init);
300 peer_disconnected(their_node_id: Uint8Array, no_connection_possible: boolean) {
301 underlying_om_a.as_OnionMessageHandler().peer_disconnected(their_node_id, no_connection_possible);
303 provided_node_features(): ldk.NodeFeatures {
304 return underlying_om_a.as_OnionMessageHandler().provided_node_features();
306 provided_init_features(their_node_id: Uint8Array): ldk.InitFeatures {
307 return underlying_om_a.as_OnionMessageHandler().provided_init_features(their_node_id);
309 } as ldk.OnionMessageHandlerInterface, om_provider_a);
311 const om_b = ldk.OnionMessenger.constructor_new(b.keys_interface, b.logger);
313 const pm_a = ldk.PeerManager.constructor_new(a.chan_man.as_ChannelMessageHandler(), ignorer.as_RoutingMessageHandler(), om_a, a.node_secret, 0xdeadbeefn, a.node_secret, a.logger, ignorer.as_CustomMessageHandler());
314 const pm_b = ldk.PeerManager.constructor_new(b.chan_man.as_ChannelMessageHandler(), ignorer.as_RoutingMessageHandler(), om_b.as_OnionMessageHandler(), b.node_secret, 0xdeadbeefn, b.node_secret, b.logger, ignorer.as_CustomMessageHandler());
316 var sock_b: ldk.SocketDescriptor;
317 const sock_a = ldk.SocketDescriptor.new_impl({
318 send_data(data: Uint8Array, resume_read: boolean): number {
319 console.assert(pm_b.read_event(sock_b, data) instanceof ldk.Result_boolPeerHandleErrorZ_OK);
322 disconnect_socket(): void {
323 console.assert(false);
325 eq(other: ldk.SocketDescriptor): boolean {
326 return other.hash() == this.hash();
331 } as ldk.SocketDescriptorInterface);
332 sock_b = ldk.SocketDescriptor.new_impl({
333 send_data(data: Uint8Array, resume_read: boolean): number {
334 console.assert(pm_a.read_event(sock_a, data) instanceof ldk.Result_boolPeerHandleErrorZ_OK);
337 disconnect_socket(): void {
338 console.assert(false);
340 eq(other: ldk.SocketDescriptor): boolean {
341 return other.hash() == this.hash();
346 } as ldk.SocketDescriptorInterface);
348 const v4_netaddr = ldk.NetAddress.constructor_ipv4(Uint8Array.from([42,0,42,1]), 9735);
349 console.assert(pm_b.new_inbound_connection(sock_b, ldk.Option_NetAddressZ.constructor_some(v4_netaddr)) instanceof ldk.Result_NonePeerHandleErrorZ_OK);
350 const init_bytes = pm_a.new_outbound_connection(b.node_id, sock_a, ldk.Option_NetAddressZ.constructor_none());
351 if (!(init_bytes instanceof ldk.Result_CVec_u8ZPeerHandleErrorZ_OK)) return false;
352 console.assert(pm_b.read_event(sock_b, init_bytes.res) instanceof ldk.Result_boolPeerHandleErrorZ_OK);
354 console.assert(pm_a.get_peer_node_ids().length == 0);
355 console.assert(pm_b.get_peer_node_ids().length == 0);
357 pm_b.process_events();
358 pm_a.process_events();
359 pm_b.process_events();
361 console.assert(pm_a.get_peer_node_ids().length == 1);
362 console.assert(pm_b.get_peer_node_ids().length == 1);
364 underlying_om_a.send_onion_message([], ldk.Destination.constructor_node(b.node_id), null);
365 pm_a.process_events();
366 om_b.send_onion_message([], ldk.Destination.constructor_node(a.node_id), null);
367 pm_b.process_events();
369 // TODO: Once OnionMessenger supports actually passing messages up, check that we received the
375 tests.push(async () => {
376 // Test that we can do basic locking of a NetworkGraph
377 const genesis_hash = new Uint8Array([0x00, 0x00, 0x00, 0x00, 0x00, 0x19, 0xd6, 0x68, 0x9c, 0x08, 0x5a, 0xe1, 0x65, 0x83, 0x1e, 0x93, 0x4f, 0xf7, 0x63, 0xae, 0x46, 0xa2, 0xa6, 0xc1, 0x72, 0xb3, 0xf1, 0xb6, 0x0a, 0x8c, 0xe2, 0x6f]);
378 const logger = ldk.Logger.new_impl({
379 log(record: ldk.Record): void {
380 if (record.get_level() != ldk.Level.LDKLevel_Gossip)
381 console.log(record.get_module_path() + ": " + record.get_args());
383 } as ldk.LoggerInterface);
384 const network_graph = ldk.NetworkGraph.constructor_new(genesis_hash, logger);
385 const graph_lock_1 = network_graph.read_only();
387 const graph_lock_2 = network_graph.read_only();
393 async function run_tests(check_leaks: boolean) {
395 for (const test of tests) {
396 test_runs.push(test());
398 const results = await Promise.all(test_runs);
399 console.log("test results: " + results);
400 const result = results.every((v) => { return v === true });
401 console.log("all tests passed: " + result);
402 if (result !== true || !check_leaks) { return result; }
404 const allocs_finished = new Promise((resolve, reject) => {
406 const interval_id = setInterval(() => {
407 const alloc_count = rawldk.getRemainingAllocationCount();
408 if (loop_count % 20 == 0)
409 console.log("Remaining LDK allocation count: " + alloc_count);
411 // chromium with --js-flags="--expose-gc" exposes a `window.gc()` which we call if we can
412 // @ts-ignore window.gc is considered a type error in TS
413 if (typeof window !== "undefined" && typeof window.gc !== "undefined") window.gc();
415 // Note that there are currently 9 leaks in the above tests. At least some are known - look for XXX in bindings.c
416 if (alloc_count <= 10) { clearInterval(interval_id); rawldk.debugPrintRemainingAllocs(); resolve(true); }
418 if (loop_count > 30*2) { clearInterval(interval_id); rawldk.debugPrintRemainingAllocs(); resolve(false); }
421 return allocs_finished;
424 export async function run_tests_web(wasm_path: string, check_leaks: boolean = true) {
425 await ldk.initializeWasmWebFetch(wasm_path);
426 return await run_tests(check_leaks);
429 export async function run_tests_node(wasm_file: Uint8Array, check_leaks: boolean = true) {
430 await ldk.initializeWasmFromBinary(wasm_file);
431 return await run_tests(check_leaks);