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;
58 function get_chanman() {
59 const fee_est = ldk.FeeEstimator.new_impl({
60 get_est_sat_per_1000_weight(confirmation_target: ldk.ConfirmationTarget): number {
63 } as ldk.FeeEstimatorInterface);
65 const tx_broadcasted: Promise<Uint8Array> = new Promise((resolve, reject) => {
66 tx_broadcaster = ldk.BroadcasterInterface.new_impl({
67 broadcast_transaction(tx: Uint8Array): void { console.log("Tx Broadcast: " + tx); resolve(tx); }
68 } as ldk.BroadcasterInterfaceInterface);
70 const logger = ldk.Logger.new_impl({
71 log(record: ldk.Record): void {
72 console.log(record.get_module_path() + ": " + record.get_args());
74 } as ldk.LoggerInterface);
76 const persister = ldk.Persist.new_impl({
77 persist_new_channel(channel_id: ldk.OutPoint, data: ldk.ChannelMonitor, update_id: ldk.MonitorUpdateId): ldk.Result_NoneChannelMonitorUpdateErrZ {
78 return ldk.Result_NoneChannelMonitorUpdateErrZ.constructor_ok();
80 update_persisted_channel(channel_id: ldk.OutPoint, update: ldk.ChannelMonitorUpdate, data: ldk.ChannelMonitor, update_id: ldk.MonitorUpdateId): ldk.Result_NoneChannelMonitorUpdateErrZ {
81 return ldk.Result_NoneChannelMonitorUpdateErrZ.constructor_ok();
83 } as ldk.PersistInterface);
85 const chain_monitor = ldk.ChainMonitor.constructor_new(ldk.Option_FilterZ.constructor_none(), tx_broadcaster, logger, fee_est, persister);
86 const chain_watch: ldk.Watch = chain_monitor.as_Watch();
88 const seed = new Uint8Array(32);
89 seed.fill(seed_counter);
91 const keys_manager = ldk.KeysManager.constructor_new(seed, BigInt(42), 42);
92 const keys_interface = keys_manager.as_KeysInterface();
93 const config = ldk.UserConfig.constructor_default();
94 const params = ldk.ChainParameters.constructor_new(ldk.Network.LDKNetwork_Testnet, ldk.BestBlock.constructor_from_genesis(ldk.Network.LDKNetwork_Testnet));
96 return [ldk.ChannelManager.constructor_new(fee_est, chain_watch, tx_broadcaster, logger, keys_interface, config, params), tx_broadcasted];
99 function exchange_messages(a: ldk.ChannelManager, b: ldk.ChannelManager) {
100 var found_msgs = true;
102 const as_msgs = a.as_MessageSendEventsProvider().get_and_clear_pending_msg_events();
103 const bs_msgs = b.as_MessageSendEventsProvider().get_and_clear_pending_msg_events();
104 found_msgs = as_msgs.length != 0 || bs_msgs.length != 0;
105 for (var i = 0; i < 2; i++) {
106 var to: ldk.ChannelManager; var from: ldk.ChannelManager; var msgs: ldk.MessageSendEvent[];
107 if (i == 0) { from = a; to = b; msgs = as_msgs; } else { from = b; to = a; msgs = bs_msgs; }
108 for (var j = 0; j < msgs.length; j++) {
110 if (msg instanceof ldk.MessageSendEvent_SendOpenChannel) {
111 if (!array_eq(msg.node_id, to.get_our_node_id())) return false;
112 to.as_ChannelMessageHandler().handle_open_channel(from.get_our_node_id(), ldk.InitFeatures.constructor_known(), msg.msg);
113 } else if (msg instanceof ldk.MessageSendEvent_SendAcceptChannel) {
114 if (!array_eq(msg.node_id, to.get_our_node_id())) return false;
115 to.as_ChannelMessageHandler().handle_accept_channel(from.get_our_node_id(), ldk.InitFeatures.constructor_known(), msg.msg);
116 } else if (msg instanceof ldk.MessageSendEvent_SendFundingCreated) {
117 if (!array_eq(msg.node_id, to.get_our_node_id())) return false;
118 to.as_ChannelMessageHandler().handle_funding_created(from.get_our_node_id(), msg.msg);
119 } else if (msg instanceof ldk.MessageSendEvent_SendFundingSigned) {
120 if (!array_eq(msg.node_id, to.get_our_node_id())) return false;
121 to.as_ChannelMessageHandler().handle_funding_signed(from.get_our_node_id(), msg.msg);
131 function assign_u64(arr: Uint8Array, offset: number, value: bigint) {
132 arr[offset + 0] = Number((value >> BigInt(8 * 0)) & BigInt(0xff));
133 arr[offset + 1] = Number((value >> BigInt(8 * 1)) & BigInt(0xff));
134 arr[offset + 2] = Number((value >> BigInt(8 * 2)) & BigInt(0xff));
135 arr[offset + 3] = Number((value >> BigInt(8 * 3)) & BigInt(0xff));
136 arr[offset + 4] = Number((value >> BigInt(8 * 4)) & BigInt(0xff));
137 arr[offset + 5] = Number((value >> BigInt(8 * 5)) & BigInt(0xff));
138 arr[offset + 6] = Number((value >> BigInt(8 * 6)) & BigInt(0xff));
139 arr[offset + 7] = Number((value >> BigInt(8 * 7)) & BigInt(0xff));
142 tests.push(async () => {
143 const peer_a = get_chanman();
144 const peer_b = get_chanman();
145 const chan_man_a: ldk.ChannelManager = peer_a[0] as ldk.ChannelManager;
146 const chan_man_b: ldk.ChannelManager = peer_b[0] as ldk.ChannelManager;
148 chan_man_a.as_ChannelMessageHandler().peer_connected(chan_man_b.get_our_node_id(), ldk.Init.constructor_new(ldk.InitFeatures.constructor_known(), ldk.Option_NetAddressZ.constructor_none()));
149 chan_man_b.as_ChannelMessageHandler().peer_connected(chan_man_a.get_our_node_id(), ldk.Init.constructor_new(ldk.InitFeatures.constructor_known(), ldk.Option_NetAddressZ.constructor_none()));
151 const chan_create_err = chan_man_a.create_channel(chan_man_b.get_our_node_id(), BigInt(0), BigInt(400), BigInt(0), ldk.UserConfig.constructor_default());
152 if (chan_create_err.is_ok()) return false;
153 if (!(chan_create_err instanceof ldk.Result__u832APIErrorZ_Err)) return false;
154 if (!(chan_create_err.err instanceof ldk.APIError_APIMisuseError)) return false;
155 if (chan_create_err.err.err != "Channel value must be at least 1000 satoshis. It was 0") return false;
157 const chan_create_res = chan_man_a.create_channel(chan_man_b.get_our_node_id(), BigInt(1000000), BigInt(400), BigInt(0), ldk.UserConfig.constructor_default());
158 if (!chan_create_res.is_ok()) return false;
160 if (!exchange_messages(chan_man_a, chan_man_b)) return false;
162 const events: Array<ldk.Event> = [];
163 const event_handler = ldk.EventHandler.new_impl({
164 handle_event(event: ldk.Event): void {
167 } as ldk.EventHandlerInterface);
169 chan_man_a.as_EventsProvider().process_pending_events(event_handler);
170 if (events.length != 1) return false;
171 if (!(events[0] instanceof ldk.Event_FundingGenerationReady)) return false;
173 // (very) manually create a funding transaction
174 const witness_pos = events[0].output_script.length + 58;
175 const funding_tx = new Uint8Array(witness_pos + 7);
176 funding_tx[0] = 2; // 4-byte tx version 2
177 funding_tx[4] = 0; funding_tx[5] = 1; // segwit magic bytes
178 funding_tx[6] = 1; // 1-byte input count 1
179 // 36 bytes previous outpoint all-0s
180 funding_tx[43] = 0; // 1-byte input script length 0
181 funding_tx[44] = 0xff; funding_tx[45] = 0xff; funding_tx[46] = 0xff; funding_tx[47] = 0xff; // 4-byte nSequence
182 funding_tx[48] = 1; // one output
183 assign_u64(funding_tx, 49, events[0].channel_value_satoshis);
184 funding_tx[57] = events[0].output_script.length; // 1-byte output script length
185 funding_tx.set(events[0].output_script, 58);
186 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
187 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
189 const funding_res = chan_man_a.funding_transaction_generated(events[0].temporary_channel_id, funding_tx);
190 if (!(funding_res instanceof ldk.Result_NoneAPIErrorZ_OK)) return false;
192 if (!exchange_messages(chan_man_a, chan_man_b)) return false;
194 const tx_broadcasted: Uint8Array = (await peer_a[1]) as Uint8Array;
195 if (!array_eq(tx_broadcasted, funding_tx)) return false;
200 async function run_tests(check_leaks: boolean) {
202 for (const test of tests) {
203 test_runs.push(test());
205 const results = await Promise.all(test_runs);
206 console.log("test results: " + results);
207 const result = results.every((v) => { return v === true });
208 console.log("all tests passed: " + result);
209 if (result !== true || !check_leaks) { return result; }
211 const allocs_finished = new Promise((resolve, reject) => {
213 const interval_id = setInterval(() => {
214 const alloc_count = rawldk.getRemainingAllocationCount();
215 if (loop_count % 20 == 0)
216 console.log("Remaining LDK allocation count: " + alloc_count);
218 // chromium with --js-flags="--expose-gc" exposes a `window.gc()` which we call if we can
219 // @ts-ignore window.gc is considered a type error in TS
220 if (typeof window !== "undefined" && typeof window.gc !== "undefined") window.gc();
222 // Note that there are currently 9 leaks in the above tests. At least some are known - look for XXX in bindings.c
223 if (alloc_count <= 10) { clearInterval(interval_id); rawldk.debugPrintRemainingAllocs(); resolve(true); }
225 if (loop_count > 30*2) { clearInterval(interval_id); rawldk.debugPrintRemainingAllocs(); resolve(false); }
228 return allocs_finished;
231 export async function run_tests_web(wasm_path: string, check_leaks: boolean = true) {
232 await ldk.initializeWasmWebFetch(wasm_path);
233 return await run_tests(check_leaks);
236 export async function run_tests_node(wasm_file: Uint8Array, check_leaks: boolean = true) {
237 await ldk.initializeWasmFromBinary(wasm_file);
238 return await run_tests(check_leaks);