1 from bindingstypes import ConvInfo
4 def first_to_lower(string: str) -> str:
6 return first.lower() + string[1:]
14 def __init__(self, DEBUG: bool, target: Target, outdir: str, **kwargs):
16 self.struct_file_suffixes = {}
17 self.function_ptr_counter = 0
18 self.function_ptrs = {}
19 self.c_type_map = dict(
20 uint8_t = ['number', 'number', 'Uint8Array'],
21 uint16_t = ['number', 'number', 'Uint16Array'],
22 uint32_t = ['number', 'number', 'Uint32Array'],
23 uint64_t = ['bigint', 'bigint', 'BigUint64Array'],
25 self.java_type_map = dict(
28 self.java_hu_type_map = dict(
32 self.to_hu_conv_templates = dict(
33 ptr = 'const {var_name}_hu_conv: {human_type} = new {human_type}(null, {var_name});',
34 default = 'const {var_name}_hu_conv: {human_type} = new {human_type}(null, {var_name});',
37 self.bindings_header = """
38 import * as version from './version.mjs';
39 import { UInt5, WitnessVersion } from './structs/CommonBase.mjs';
41 const imports: any = {};
44 var js_objs: Array<WeakRef<object>> = [];
45 var js_invoke: Function;
46 var getRandomValues: Function;
48 imports.wasi_snapshot_preview1 = {
49 "fd_write": (fd: number, iovec_array_ptr: number, iovec_array_len: number, bytes_written_ptr: number) => {
50 // This should generally only be used to print panic messages
51 const ptr_len_view = new Uint32Array(wasm.memory.buffer, iovec_array_ptr, iovec_array_len * 2);
52 var bytes_written = 0;
53 for (var i = 0; i < iovec_array_len; i++) {
54 const bytes_view = new Uint8Array(wasm.memory.buffer, ptr_len_view[i*2], ptr_len_view[i*2+1]);
55 console.log("[fd " + fd + "]: " + String.fromCharCode(...bytes_view));
56 bytes_written += ptr_len_view[i*2+1];
58 const written_view = new Uint32Array(wasm.memory.buffer, bytes_written_ptr, 1);
59 written_view[0] = bytes_written;
62 "fd_close": (_fd: number) => {
63 // This is not generally called, but may be referenced in debug builds
64 console.log("wasi_snapshot_preview1:fd_close");
65 return 58; // Not Supported
67 "fd_seek": (_fd: number, _offset: bigint, _whence: number, _new_offset: number) => {
68 // This is not generally called, but may be referenced in debug builds
69 console.log("wasi_snapshot_preview1:fd_seek");
70 return 58; // Not Supported
72 "random_get": (buf_ptr: number, buf_len: number) => {
73 const buf = new Uint8Array(wasm.memory.buffer, buf_ptr, buf_len);
77 "environ_sizes_get": (environ_var_count_ptr: number, environ_len_ptr: number) => {
78 // This is called before fd_write to format + print panic messages
79 const out_count_view = new Uint32Array(wasm.memory.buffer, environ_var_count_ptr, 1);
80 out_count_view[0] = 0;
81 const out_len_view = new Uint32Array(wasm.memory.buffer, environ_len_ptr, 1);
85 "environ_get": (environ_ptr: number, environ_buf_ptr: number) => {
86 // This is called before fd_write to format + print panic messages,
87 // but only if we have variables in environ_sizes_get, so shouldn't ever actually happen!
88 console.log("wasi_snapshot_preview1:environ_get");
89 return 58; // Note supported - we said there were 0 environment entries!
92 console.log("wasi_snapshot_preview1:proc_exit");
97 let isWasmInitialized: boolean = false;
99 async function finishInitializeWasm(wasmInstance: WebAssembly.Instance) {
100 if (typeof crypto === "undefined") {
101 var crypto_import = (await import('crypto')).webcrypto;
102 getRandomValues = crypto_import.getRandomValues.bind(crypto_import);
104 getRandomValues = crypto.getRandomValues.bind(crypto);
107 wasm = wasmInstance.exports;
108 if (!wasm.test_bigint_pass_deadbeef0badf00d(BigInt("0xdeadbeef0badf00d"))) {
109 throw new Error(\"Currently need BigInt-as-u64 support, try ----experimental-wasm-bigint");
112 if (decodeString(wasm.TS_get_lib_version_string()) !== version.get_ldk_java_bindings_version())
113 throw new Error(\"Compiled LDK library and LDK class files do not match\");
114 // Fetching the LDK versions from C also checks that the header and binaries match
115 const c_bindings_ver: number = wasm.TS_get_ldk_c_bindings_version();
116 const ldk_ver: number = wasm.TS_get_ldk_version();
117 if (c_bindings_ver == 0)
118 throw new Error(\"LDK version did not match the header we built against\");
120 throw new Error(\"LDK C bindings version did not match the header we built against\");
121 const c_bindings_version: string = decodeString(c_bindings_ver)
122 const ldk_version: string = decodeString(ldk_ver);
123 console.log(\"Loaded LDK-Java Bindings with LDK \" + ldk_version + \" and LDK-C-Bindings \" + c_bindings_version);
125 isWasmInitialized = true;
128 const fn_list = ["uuuuuu", "buuuuu", "bbbbbb", "ubuuuu", "uubuuu"];
131 export async function initializeWasmFromUint8Array(wasmBinary: Uint8Array) {
132 for (const fn of fn_list) { imports.env["js_invoke_function_" + fn] = js_invoke; }
133 const { instance: wasmInstance } = await WebAssembly.instantiate(wasmBinary, imports);
134 await finishInitializeWasm(wasmInstance);
138 export async function initializeWasmFetch(uri: string) {
139 for (const fn of fn_list) { imports.env["js_invoke_function_" + fn] = js_invoke; }
140 const stream = fetch(uri);
141 const { instance: wasmInstance } = await WebAssembly.instantiateStreaming(stream, imports);
142 await finishInitializeWasm(wasmInstance);
145 self.bindings_header += """
149 export function uint5ArrToBytes(inputArray: Array<UInt5>): Uint8Array {
150 const arr = new Uint8Array(inputArray.length);
151 for (var i = 0; i < inputArray.length; i++) {
152 arr[i] = inputArray[i].getVal();
158 export function WitnessVersionArrToBytes(inputArray: Array<WitnessVersion>): Uint8Array {
159 const arr = new Uint8Array(inputArray.length);
160 for (var i = 0; i < inputArray.length; i++) {
161 arr[i] = inputArray[i].getVal();
169 export function encodeUint8Array (inputArray: Uint8Array): number {
170 const cArrayPointer = wasm.TS_malloc(inputArray.length + 4);
171 const arrayLengthView = new Uint32Array(wasm.memory.buffer, cArrayPointer, 1);
172 arrayLengthView[0] = inputArray.length;
173 const arrayMemoryView = new Uint8Array(wasm.memory.buffer, cArrayPointer + 4, inputArray.length);
174 arrayMemoryView.set(inputArray);
175 return cArrayPointer;
178 export function encodeUint32Array (inputArray: Uint32Array|Array<number>): number {
179 const cArrayPointer = wasm.TS_malloc((inputArray.length + 1) * 4);
180 const arrayMemoryView = new Uint32Array(wasm.memory.buffer, cArrayPointer, inputArray.length);
181 arrayMemoryView.set(inputArray, 1);
182 arrayMemoryView[0] = inputArray.length;
183 return cArrayPointer;
186 export function encodeUint64Array (inputArray: BigUint64Array|Array<bigint>): number {
187 const cArrayPointer = wasm.TS_malloc(inputArray.length * 8 + 1);
188 const arrayLengthView = new Uint32Array(wasm.memory.buffer, cArrayPointer, 1);
189 arrayLengthView[0] = inputArray.length;
190 const arrayMemoryView = new BigUint64Array(wasm.memory.buffer, cArrayPointer + 4, inputArray.length);
191 arrayMemoryView.set(inputArray);
192 return cArrayPointer;
196 export function check_arr_len(arr: Uint8Array, len: number): Uint8Array {
197 if (arr.length != len) { throw new Error("Expected array of length " + len + " got " + arr.length); }
202 export function getArrayLength(arrayPointer: number): number {
203 const arraySizeViewer = new Uint32Array(wasm.memory.buffer, arrayPointer, 1);
204 return arraySizeViewer[0];
207 export function decodeUint8Array (arrayPointer: number, free = true): Uint8Array {
208 const arraySize = getArrayLength(arrayPointer);
209 const actualArrayViewer = new Uint8Array(wasm.memory.buffer, arrayPointer + 4, arraySize);
210 // Clone the contents, TODO: In the future we should wrap the Viewer in a class that
211 // will free the underlying memory when it becomes unreachable instead of copying here.
212 // Note that doing so may have edge-case interactions with memory resizing (invalidating the buffer).
213 const actualArray = actualArrayViewer.slice(0, arraySize);
215 wasm.TS_free(arrayPointer);
219 const decodeUint32Array = (arrayPointer: number, free = true) => {
220 const arraySize = getArrayLength(arrayPointer);
221 const actualArrayViewer = new Uint32Array(
222 wasm.memory.buffer, // value
223 arrayPointer + 4, // offset (ignoring length bytes)
224 arraySize // uint32 count
226 // Clone the contents, TODO: In the future we should wrap the Viewer in a class that
227 // will free the underlying memory when it becomes unreachable instead of copying here.
228 const actualArray = actualArrayViewer.slice(0, arraySize);
230 wasm.TS_free(arrayPointer);
235 export function decodeUint64Array (arrayPointer: number, free = true): bigint[] {
236 const arraySize = getArrayLength(arrayPointer);
237 const actualArrayViewer = new BigUint64Array(
238 wasm.memory.buffer, // value
239 arrayPointer + 4, // offset (ignoring length bytes)
240 arraySize // uint32 count
242 // Clone the contents, TODO: In the future we should wrap the Viewer in a class that
243 // will free the underlying memory when it becomes unreachable instead of copying here.
244 const actualArray = new Array(arraySize);
245 for (var i = 0; i < arraySize; i++) actualArray[i] = actualArrayViewer[i];
247 wasm.TS_free(arrayPointer);
252 export function freeWasmMemory(pointer: number) { wasm.TS_free(pointer); }
255 export function getU32ArrayElem(arrayPointer: number, idx: number): number {
256 const actualArrayViewer = new Uint32Array(wasm.memory.buffer, arrayPointer + 4, idx + 1);
257 return actualArrayViewer[idx];
261 export function getU8ArrayElem(arrayPointer: number, idx: number): number {
262 const actualArrayViewer = new Uint8Array(wasm.memory.buffer, arrayPointer + 4, idx + 1);
263 return actualArrayViewer[idx];
268 export function encodeString(str: string): number {
269 const charArray = new TextEncoder().encode(str);
270 return encodeUint8Array(charArray);
274 export function decodeString(stringPointer: number, free = true): string {
275 const arraySize = getArrayLength(stringPointer);
276 const memoryView = new Uint8Array(wasm.memory.buffer, stringPointer + 4, arraySize);
277 const result = new TextDecoder("utf-8").decode(memoryView);
280 wasm.TS_free(stringPointer);
287 self.bindings_header += """
289 export function getRemainingAllocationCount(): number {
290 return wasm.TS_allocs_remaining();
293 export function debugPrintRemainingAllocs() {
294 wasm.TS_print_leaks();
298 self.bindings_header += "\n/* @internal */ export function getRemainingAllocationCount(): number { return 0; }\n"
299 self.bindings_header += "/* @internal */ export function debugPrintRemainingAllocs() { }\n"
301 with open(outdir + "/index.mts", 'a') as index:
302 index.write("""import { initializeWasmFetch, initializeWasmFromUint8Array } from './bindings.mjs';
303 /** Initializes the WASM backend by calling `fetch()` on the given URI - Browser only */
304 export async function initializeWasmWebFetch(uri: string) {
305 await initializeWasmFetch(uri);
307 /** Initializes the WASM backend given a Uint8Array of the .wasm binary file - Browser or Node.JS */
308 export async function initializeWasmFromBinary(bin: Uint8Array) {
309 await initializeWasmFromUint8Array(bin);
314 self.bindings_version_file = """export function get_ldk_java_bindings_version(): String {
315 return "<git_version_ldk_garbagecollected>";
318 self.bindings_footer = ""
320 self.common_base = """
321 function freer(f: () => void) { f() }
322 const finalizer = new FinalizationRegistry(freer);
323 function get_freeer(ptr: number, free_fn: (ptr: number) => void) {
329 export class CommonBase {
330 protected ptr: number;
331 protected ptrs_to: object[] = [];
332 protected constructor(ptr: number, free_fn: (ptr: number) => void) {
334 if (Number.isFinite(ptr) && ptr != 0){
335 finalizer.register(this, get_freeer(ptr, free_fn), this);
338 // In Java, protected means "any subclass can access fields on any other subclass'"
339 // In TypeScript, protected means "any subclass can access parent fields on instances of itself"
340 // To work around this, we add accessors for other instances' protected fields here.
341 protected static add_ref_from(holder: CommonBase, referent: object) {
342 holder.ptrs_to.push(referent);
344 protected static get_ptr_of(o: CommonBase) {
347 protected static set_null_skip_free(o: CommonBase) {
349 // @ts-ignore TypeScript is wrong about the returnvalue of unregister here!
350 const did_unregister: boolean = finalizer.unregister(o);
352 throw new Error("FinalizationRegistry unregister should always unregister unless you double-free'd");
357 public constructor(private val: number) {
358 if (val > 32 || val < 0) throw new Error("UInt5 value is out of range");
360 public getVal(): number {
365 export class WitnessVersion {
366 public constructor(private val: number) {
367 if (val > 16 || val < 0) throw new Error("WitnessVersion value is out of range");
369 public getVal(): number {
374 export class UnqualifiedError {
375 public constructor(val: number) {}
379 self.txout_defn = """export class TxOut extends CommonBase {
380 /** The script_pubkey in this output */
381 public script_pubkey: Uint8Array;
382 /** The value, in satoshis, of this output */
383 public value: bigint;
386 public constructor(_dummy: object, ptr: number) {
387 super(ptr, bindings.TxOut_free);
388 this.script_pubkey = bindings.decodeUint8Array(bindings.TxOut_get_script_pubkey(ptr));
389 this.value = bindings.TxOut_get_value(ptr);
391 public static constructor_new(value: bigint, script_pubkey: Uint8Array): TxOut {
392 return new TxOut(null, bindings.TxOut_new(bindings.encodeUint8Array(script_pubkey), value));
395 self.obj_defined(["TxOut"], "structs")
397 self.c_file_pfx = """#include "js-wasm.h"
398 #include <stdatomic.h>
399 #include <lightning.h>
401 // These should be provided...somehow...
402 void *memset(void *s, int c, size_t n);
403 void *memcpy(void *dest, const void *src, size_t n);
404 int memcmp(const void *s1, const void *s2, size_t n);
406 extern void __attribute__((noreturn)) abort(void);
407 static inline void assert(bool expression) {
408 if (!expression) { abort(); }
411 uint32_t __attribute__((export_name("test_bigint_pass_deadbeef0badf00d"))) test_bigint_pass_deadbeef0badf00d(uint64_t val) {
412 return val == 0xdeadbeef0badf00dULL;
418 self.c_file_pfx += """
419 void *malloc(size_t size);
420 void free(void *ptr);
422 #define MALLOC(a, _) malloc(a)
423 #define do_MALLOC(a, _b, _c) malloc(a)
424 #define FREE(p) if ((unsigned long)(p) > 4096) { free(p); }
425 #define DO_ASSERT(a) (void)(a)
427 #define CHECK_ACCESS(p)
428 #define CHECK_INNER_FIELD_ACCESS_OR_NULL(v)
431 self.c_file_pfx += """
432 extern int snprintf(char *str, size_t size, const char *format, ...);
433 typedef int32_t ssize_t;
434 ssize_t write(int fd, const void *buf, size_t count);
435 #define DEBUG_PRINT(...) do { \\
436 char debug_str[1024]; \\
437 int s_len = snprintf(debug_str, 1023, __VA_ARGS__); \\
438 write(2, debug_str, s_len); \\
441 // Always run a, then assert it is true:
442 #define DO_ASSERT(a) do { bool _assert_val = (a); assert(_assert_val); } while(0)
443 // Assert a is true or do nothing
444 #define CHECK(a) DO_ASSERT(a)
446 // Running a leak check across all the allocations and frees of the JDK is a mess,
447 // so instead we implement our own naive leak checker here, relying on the -wrap
448 // linker option to wrap malloc/calloc/realloc/free, tracking everyhing allocated
449 // and free'd in Rust or C across the generated bindings shared library.
452 typedef struct allocation {
453 struct allocation* next;
455 const char* struct_name;
458 static allocation* allocation_ll = NULL;
459 static allocation* freed_ll = NULL;
461 extern void* __real_malloc(size_t len);
462 extern void* __real_calloc(size_t nmemb, size_t len);
463 extern void* __real_aligned_alloc(size_t alignment, size_t size);
464 static void new_allocation(void* res, const char* struct_name, int lineno) {
465 allocation* new_alloc = __real_malloc(sizeof(allocation));
466 new_alloc->ptr = res;
467 new_alloc->struct_name = struct_name;
468 new_alloc->next = allocation_ll;
469 new_alloc->lineno = lineno;
470 allocation_ll = new_alloc;
472 static void* do_MALLOC(size_t len, const char* struct_name, int lineno) {
473 void* res = __real_malloc(len);
474 new_allocation(res, struct_name, lineno);
477 #define MALLOC(len, struct_name) do_MALLOC(len, struct_name, __LINE__)
479 void __real_free(void* ptr);
480 static void alloc_freed(void* ptr, int lineno) {
481 allocation* p = NULL;
482 allocation* it = allocation_ll;
483 while (it->ptr != ptr) {
484 p = it; it = it->next;
488 while (it && it->ptr != ptr) { p = it; it = it->next; }
490 DEBUG_PRINT("Tried to free unknown pointer %p at line %d.\\n", ptr, lineno);
492 DEBUG_PRINT("Tried to free unknown pointer %p at line %d.\\n Possibly double-free from %s, allocated on line %d.", ptr, lineno, it->struct_name, it->lineno);
497 if (p) { p->next = it->next; } else { allocation_ll = it->next; }
498 DO_ASSERT(it->ptr == ptr);
502 static void do_FREE(void* ptr, int lineno) {
503 if ((unsigned long)ptr <= 4096) return; // Rust loves to create pointers to the NULL page for dummys
504 alloc_freed(ptr, lineno);
507 #define FREE(ptr) do_FREE(ptr, __LINE__)
509 static void CHECK_ACCESS(const void* ptr) {
510 allocation* it = allocation_ll;
511 while (it->ptr != ptr) {
514 return; // addrsan should catch malloc-unknown and print more info than we have
518 #define CHECK_INNER_FIELD_ACCESS_OR_NULL(v) \\
519 if (v.is_owned && v.inner != NULL) { \\
520 const void *p = __unmangle_inner_ptr(v.inner); \\
526 void* __wrap_malloc(size_t len) {
527 void* res = __real_malloc(len);
528 new_allocation(res, "malloc call", 0);
531 void* __wrap_calloc(size_t nmemb, size_t len) {
532 void* res = __real_calloc(nmemb, len);
533 new_allocation(res, "calloc call", 0);
536 void* __wrap_aligned_alloc(size_t alignment, size_t size) {
537 void* res = __real_aligned_alloc(alignment, size);
538 new_allocation(res, "aligned_alloc call", 0);
541 void __wrap_free(void* ptr) {
542 if (ptr == NULL) return;
547 void* __real_realloc(void* ptr, size_t newlen);
548 void* __wrap_realloc(void* ptr, size_t len) {
549 if (ptr != NULL) alloc_freed(ptr, 0);
550 void* res = __real_realloc(ptr, len);
551 new_allocation(res, "realloc call", 0);
554 void __wrap_reallocarray(void* ptr, size_t new_sz) {
555 // Rust doesn't seem to use reallocarray currently
559 uint32_t __attribute__((export_name("TS_allocs_remaining"))) allocs_remaining() {
561 for (allocation* a = allocation_ll; a != NULL; a = a->next) {
566 void __attribute__((export_name("TS_print_leaks"))) print_leaks() {
567 for (allocation* a = allocation_ll; a != NULL; a = a->next) {
568 DEBUG_PRINT("%s %p remains. Allocated on line %d\\n", a->struct_name, a->ptr, a->lineno);
572 self.c_file_pfx = self.c_file_pfx + """
573 // We assume that CVec_u8Z and u8slice are the same size and layout (and thus pointers to the two can be mixed)
574 _Static_assert(sizeof(LDKCVec_u8Z) == sizeof(LDKu8slice), "Vec<u8> and [u8] need to have been mapped identically");
575 _Static_assert(offsetof(LDKCVec_u8Z, data) == offsetof(LDKu8slice, data), "Vec<u8> and [u8] need to have been mapped identically");
576 _Static_assert(offsetof(LDKCVec_u8Z, datalen) == offsetof(LDKu8slice, datalen), "Vec<u8> and [u8] need to have been mapped identically");
578 _Static_assert(sizeof(void*) == 4, "Pointers mut be 32 bits");
580 #define DECL_ARR_TYPE(ty, name) \\
581 struct name##array { \\
585 typedef struct name##array * name##Array; \\
586 static inline name##Array init_##name##Array(size_t arr_len, int lineno) { \\
587 name##Array arr = (name##Array)do_MALLOC(arr_len * sizeof(ty) + sizeof(uint32_t), #name" array init", lineno); \\
588 arr->arr_len = arr_len; \\
592 DECL_ARR_TYPE(int64_t, int64_t);
593 DECL_ARR_TYPE(int8_t, int8_t);
594 DECL_ARR_TYPE(uint32_t, uint32_t);
595 DECL_ARR_TYPE(void*, ptr);
596 DECL_ARR_TYPE(char, char);
597 typedef charArray jstring;
599 static inline jstring str_ref_to_ts(const char* chars, size_t len) {
600 charArray arr = init_charArray(len, __LINE__);
601 memcpy(arr->elems, chars, len);
604 static inline LDKStr str_ref_to_owned_c(const jstring str) {
605 char* newchars = MALLOC(str->arr_len + 1, "String chars");
606 memcpy(newchars, str->elems, str->arr_len);
607 newchars[str->arr_len] = 0;
611 .chars_is_owned = true
616 typedef bool jboolean;
618 uint32_t __attribute__((export_name("TS_malloc"))) TS_malloc(uint32_t size) {
619 return (uint32_t)MALLOC(size, "JS-Called malloc");
621 void __attribute__((export_name("TS_free"))) TS_free(uint32_t ptr) {
625 jstring __attribute__((export_name("TS_get_ldk_c_bindings_version"))) TS_get_ldk_c_bindings_version() {
626 const char *res = check_get_ldk_bindings_version();
627 if (res == NULL) return NULL;
628 return str_ref_to_ts(res, strlen(res));
630 jstring __attribute__((export_name("TS_get_ldk_version"))) get_ldk_version() {
631 const char *res = check_get_ldk_version();
632 if (res == NULL) return NULL;
633 return str_ref_to_ts(res, strlen(res));
638 self.c_version_file = """jstring __attribute__((export_name("TS_get_lib_version_string"))) TS_get_lib_version_string() {
639 return str_ref_to_ts("<git_version_ldk_garbagecollected>", strlen("<git_version_ldk_garbagecollected>"));
642 self.hu_struct_file_prefix = """
643 import { CommonBase, UInt5, WitnessVersion, UnqualifiedError } from './CommonBase.mjs';
644 import * as bindings from '../bindings.mjs'
647 self.util_fn_pfx = self.hu_struct_file_prefix + "\nexport class UtilMethods extends CommonBase {\n"
648 self.util_fn_sfx = "}"
649 self.c_fn_ty_pfx = ""
650 self.file_ext = ".mts"
651 self.ptr_c_ty = "uint32_t"
652 self.ptr_native_ty = "number"
653 self.result_c_ty = "uint32_t"
654 self.ptr_arr = "ptrArray"
655 self.is_arr_some_check = ("", " != 0")
656 self.get_native_arr_len_call = ("", "->arr_len")
658 def release_native_arr_ptr_call(self, ty_info, arr_var, arr_ptr_var):
660 def create_native_arr_call(self, arr_len, ty_info):
661 if ty_info.c_ty == "ptrArray":
662 assert ty_info.rust_obj == "LDKCVec_u5Z" or (ty_info.subty is not None and ty_info.subty.c_ty.endswith("Array"))
663 return "init_" + ty_info.c_ty + "(" + arr_len + ", __LINE__)"
664 def set_native_arr_contents(self, arr_name, arr_len, ty_info):
665 if ty_info.c_ty == "int8_tArray":
666 return ("memcpy(" + arr_name + "->elems, ", ", " + arr_len + ")")
669 def get_native_arr_contents(self, arr_name, dest_name, arr_len, ty_info, copy):
670 if ty_info.c_ty == "int8_tArray":
672 return "memcpy(" + dest_name + ", " + arr_name + "->elems, " + arr_len + "); FREE(" + arr_name + ")"
674 if ty_info.c_ty == "ptrArray":
675 return "(void*) " + arr_name + "->elems"
677 return arr_name + "->elems"
678 def get_native_arr_elem(self, arr_name, idxc, ty_info):
679 assert False # Only called if above is None
680 def get_native_arr_ptr_call(self, ty_info):
681 if ty_info.subty is not None:
682 return "(" + ty_info.subty.c_ty + "*)(((uint8_t*)", ") + 4)"
683 return "(" + ty_info.c_ty + "*)(((uint8_t*)", ") + 4)"
684 def get_native_arr_entry_call(self, ty_info, arr_name, idxc, entry_access):
686 def cleanup_native_arr_ref_contents(self, arr_name, dest_name, arr_len, ty_info):
687 if ty_info.c_ty == "int8_tArray":
688 return "FREE(" + arr_name + ");"
690 return "FREE(" + arr_name + ")"
692 def map_hu_array_elems(self, arr_name, conv_name, arr_ty, elem_ty):
693 if elem_ty.rust_obj == "LDKu5":
694 return arr_name + " != null ? bindings.uint5ArrToBytes(" + arr_name + ") : null"
695 assert elem_ty.c_ty == "uint32_t" or elem_ty.c_ty.endswith("Array")
696 return arr_name + " != null ? " + arr_name + ".map(" + conv_name + " => " + elem_ty.from_hu_conv[0] + ") : null"
698 def str_ref_to_native_call(self, var_name, str_len):
699 return "str_ref_to_ts(" + var_name + ", " + str_len + ")"
700 def str_ref_to_c_call(self, var_name):
701 return "str_ref_to_owned_c(" + var_name + ")"
702 def str_to_hu_conv(self, var_name):
703 return "const " + var_name + "_conv: string = bindings.decodeString(" + var_name + ");"
704 def str_from_hu_conv(self, var_name):
705 return ("bindings.encodeString(" + var_name + ")", "")
707 def c_fn_name_define_pfx(self, fn_name, have_args):
708 return " __attribute__((export_name(\"TS_" + fn_name + "\"))) TS_" + fn_name + "("
713 def get_java_arr_len(self, arr_name):
714 return "bindings.getArrayLength(" + arr_name + ")"
715 def get_java_arr_elem(self, elem_ty, arr_name, idx):
716 if elem_ty.c_ty == "uint32_t" or elem_ty.c_ty == "uintptr_t" or elem_ty.c_ty.endswith("Array"):
717 return "bindings.getU32ArrayElem(" + arr_name + ", " + idx + ")"
718 elif elem_ty.rust_obj == "LDKu5":
719 return "bindings.getU8ArrayElem(" + arr_name + ", " + idx + ")"
722 def constr_hu_array(self, ty_info, arr_len):
723 return "new Array(" + arr_len + ").fill(null)"
724 def cleanup_converted_native_array(self, ty_info, arr_name):
725 return "bindings.freeWasmMemory(" + arr_name + ")"
727 def primitive_arr_from_hu(self, mapped_ty, fixed_len, arr_name):
729 if fixed_len is not None:
730 assert mapped_ty.c_ty == "int8_t"
731 inner = "bindings.check_arr_len(" + arr_name + ", " + fixed_len + ")"
732 if mapped_ty.c_ty.endswith("Array"):
733 return ("bindings.encodeUint32Array(" + inner + ")", "")
734 elif mapped_ty.c_ty == "uint8_t" or mapped_ty.c_ty == "int8_t":
735 return ("bindings.encodeUint8Array(" + inner + ")", "")
736 elif mapped_ty.c_ty == "uint32_t":
737 return ("bindings.encodeUint32Array(" + inner + ")", "")
738 elif mapped_ty.c_ty == "int64_t":
739 return ("bindings.encodeUint64Array(" + inner + ")", "")
741 print(mapped_ty.c_ty)
744 def primitive_arr_to_hu(self, mapped_ty, fixed_len, arr_name, conv_name):
745 if mapped_ty.c_ty == "uint8_t" or mapped_ty.c_ty == "int8_t":
746 return "const " + conv_name + ": Uint8Array = bindings.decodeUint8Array(" + arr_name + ");"
747 elif mapped_ty.c_ty == "uint64_t" or mapped_ty.c_ty == "int64_t":
748 return "const " + conv_name + ": bigint[] = bindings.decodeUint64Array(" + arr_name + ");"
752 def var_decl_statement(self, ty_string, var_name, statement):
753 return "const " + var_name + ": " + ty_string + " = " + statement
755 def java_arr_ty_str(self, elem_ty_str):
758 def for_n_in_range(self, n, minimum, maximum):
759 return "for (var " + n + " = " + minimum + "; " + n + " < " + maximum + "; " + n + "++) {"
760 def for_n_in_arr(self, n, arr_name, arr_elem_ty):
761 return (arr_name + ".forEach((" + n + ": " + arr_elem_ty.java_hu_ty + ") => { ", " })")
763 def get_ptr(self, var):
764 return "CommonBase.get_ptr_of(" + var + ")"
765 def set_null_skip_free(self, var):
766 return "CommonBase.set_null_skip_free(" + var + ");"
768 def add_ref(self, holder, referent):
769 return "CommonBase.add_ref_from(" + holder + ", " + referent + ")"
771 def obj_defined(self, struct_names, folder):
772 with open(self.outdir + "/index.mts", 'a') as index:
773 index.write(f"export * from './{folder}/{struct_names[0]}.mjs';\n")
774 with open(self.outdir + "/imports.mts.part", 'a') as imports:
775 imports.write(f"import {{ {', '.join(struct_names)} }} from '../{folder}/{struct_names[0]}.mjs';\n")
777 def fully_qualified_hu_ty_path(self, ty):
780 def native_c_unitary_enum_map(self, struct_name, variants, enum_doc_comment):
781 out_c = "static inline LDK" + struct_name + " LDK" + struct_name + "_from_js(int32_t ord) {\n"
782 out_c = out_c + "\tswitch (ord) {\n"
785 out_typescript_enum_fields = ""
787 for var, var_docs in variants:
788 out_c = out_c + "\t\tcase %d: return %s;\n" % (ord_v, var)
790 if var_docs is not None:
791 var_docs_repld = var_docs.replace("\n", "\n\t")
792 out_typescript_enum_fields += f"/**\n\t * {var_docs_repld}\n\t */\n"
793 out_typescript_enum_fields += f"\t{var},\n\t"
794 out_c = out_c + "\t}\n"
795 out_c = out_c + "\tabort();\n"
796 out_c = out_c + "}\n"
798 out_c = out_c + "static inline int32_t LDK" + struct_name + "_to_js(LDK" + struct_name + " val) {\n"
799 out_c = out_c + "\tswitch (val) {\n"
801 for var, _ in variants:
802 out_c = out_c + "\t\tcase " + var + ": return %d;\n" % ord_v
804 out_c = out_c + "\t\tdefault: abort();\n"
805 out_c = out_c + "\t}\n"
806 out_c = out_c + "}\n"
808 # Note that this is *not* marked /* @internal */ as we re-expose it directly in enums/
809 enum_comment_formatted = enum_doc_comment.replace("\n", "\n * ")
810 out_typescript = f"""
812 * {enum_comment_formatted}
814 export enum {struct_name} {{
815 {out_typescript_enum_fields}
818 out_typescript_enum = f"export {{ {struct_name} }} from \"../bindings.mjs\";"
819 self.obj_defined([struct_name], "enums")
820 return (out_c, out_typescript_enum, out_typescript)
822 def c_unitary_enum_to_native_call(self, ty_info):
823 return (ty_info.rust_obj + "_to_js(", ")")
824 def native_unitary_enum_to_c_call(self, ty_info):
825 return (ty_info.rust_obj + "_from_js(", ")")
827 def native_c_map_trait(self, struct_name, field_var_conversions, flattened_field_var_conversions, field_function_lines, trait_doc_comment):
828 out_typescript_bindings = ""
829 super_instantiator = ""
830 bindings_instantiator = ""
831 pointer_to_adder = ""
832 impl_constructor_arguments = ""
833 for var in flattened_field_var_conversions:
834 if isinstance(var, ConvInfo):
835 impl_constructor_arguments += f", {var.arg_name}: {var.java_hu_ty}"
836 super_instantiator += first_to_lower(var.arg_name) + ", "
837 if var.from_hu_conv is not None:
838 bindings_instantiator += ", " + var.from_hu_conv[0]
839 if var.from_hu_conv[1] != "":
840 pointer_to_adder += "\t\t\t" + var.from_hu_conv[1] + ";\n"
842 bindings_instantiator += ", " + first_to_lower(var.arg_name)
844 bindings_instantiator += ", " + first_to_lower(var[1]) + ".bindings_instance"
845 super_instantiator += first_to_lower(var[1]) + "_impl, "
846 pointer_to_adder += "\t\timpl_holder.held.ptrs_to.push(" + first_to_lower(var[1]) + ");\n"
847 impl_constructor_arguments += f", {first_to_lower(var[1])}_impl: {var[0].replace('LDK', '')}Interface"
849 super_constructor_statements = ""
850 trait_constructor_arguments = ""
851 for var in field_var_conversions:
852 if isinstance(var, ConvInfo):
853 trait_constructor_arguments += ", " + var.arg_name
855 super_constructor_statements += "\t\tconst " + first_to_lower(var[1]) + " = " + var[1] + ".new_impl(" + super_instantiator + ");\n"
856 trait_constructor_arguments += ", " + first_to_lower(var[1]) + ".bindings_instance"
857 for suparg in var[2]:
858 if isinstance(suparg, ConvInfo):
859 trait_constructor_arguments += ", " + suparg.arg_name
861 trait_constructor_arguments += ", " + suparg[1]
863 # BUILD INTERFACE METHODS
864 out_java_interface = ""
865 out_interface_implementation_overrides = ""
867 for fn_line in field_function_lines:
868 java_method_descriptor = ""
869 if fn_line.fn_name != "free" and fn_line.fn_name != "cloned":
870 out_java_interface += "\t/**" + fn_line.docs.replace("\n", "\n\t * ") + "\n\t */\n"
871 out_java_interface += "\t" + fn_line.fn_name + "("
872 out_interface_implementation_overrides += f"\t\t\t{fn_line.fn_name} ("
874 for idx, arg_conv_info in enumerate(fn_line.args_ty):
876 out_java_interface += ", "
877 out_interface_implementation_overrides += ", "
878 out_java_interface += f"{arg_conv_info.arg_name}: {arg_conv_info.java_hu_ty}"
879 out_interface_implementation_overrides += f"{arg_conv_info.arg_name}: {arg_conv_info.java_ty}"
880 java_method_descriptor += arg_conv_info.java_fn_ty_arg
881 out_java_interface += f"): {fn_line.ret_ty_info.java_hu_ty};\n"
882 java_method_descriptor += ")" + fn_line.ret_ty_info.java_fn_ty_arg
883 java_methods.append((fn_line.fn_name, java_method_descriptor))
885 out_interface_implementation_overrides += f"): {fn_line.ret_ty_info.java_ty} {{\n"
887 for arg_info in fn_line.args_ty:
888 if arg_info.to_hu_conv is not None:
889 out_interface_implementation_overrides += "\t\t\t\t" + arg_info.to_hu_conv.replace("\n", "\n\t\t\t\t") + "\n"
891 if fn_line.ret_ty_info.java_ty != "void":
892 out_interface_implementation_overrides += "\t\t\t\tconst ret: " + fn_line.ret_ty_info.java_hu_ty + " = arg." + fn_line.fn_name + "("
894 out_interface_implementation_overrides += f"\t\t\t\targ." + fn_line.fn_name + "("
896 for idx, arg_info in enumerate(fn_line.args_ty):
898 out_interface_implementation_overrides += ", "
899 if arg_info.to_hu_conv_name is not None:
900 out_interface_implementation_overrides += arg_info.to_hu_conv_name
902 out_interface_implementation_overrides += arg_info.arg_name
904 out_interface_implementation_overrides += ");\n"
905 if fn_line.ret_ty_info.java_ty != "void":
906 if fn_line.ret_ty_info.from_hu_conv is not None:
907 out_interface_implementation_overrides += "\t\t\t\t" + f"const result: {fn_line.ret_ty_info.java_ty} = " + fn_line.ret_ty_info.from_hu_conv[0].replace("\n", "\n\t\t\t\t") + ";\n"
908 if fn_line.ret_ty_info.from_hu_conv[1] != "":
909 out_interface_implementation_overrides += "\t\t\t\t" + fn_line.ret_ty_info.from_hu_conv[1].replace("this", "impl_holder.held").replace("\n", "\n\t\t\t\t") + ";\n"
910 #if fn_line.ret_ty_info.rust_obj in result_types:
911 # XXX: We need to handle this in conversion logic so that its cross-language!
912 # Avoid double-free by breaking the result - we should learn to clone these and then we can be safe instead
913 # out_interface_implementation_overrides = out_interface_implementation_overrides + "\t\t\t\tret.ptr = 0;\n"
914 out_interface_implementation_overrides += "\t\t\t\treturn result;\n"
916 out_interface_implementation_overrides += "\t\t\t\treturn ret;\n"
917 out_interface_implementation_overrides += f"\t\t\t}},\n"
919 formatted_trait_docs = trait_doc_comment.replace("\n", "\n * ")
920 out_typescript_human = f"""
921 {self.hu_struct_file_prefix}
923 /** An implementation of {struct_name.replace("LDK","")} */
924 export interface {struct_name.replace("LDK", "")}Interface {{
925 {out_java_interface}}}
927 class {struct_name}Holder {{
928 held: {struct_name.replace("LDK", "")};
932 * {formatted_trait_docs}
934 export class {struct_name.replace("LDK","")} extends CommonBase {{
936 public bindings_instance?: bindings.{struct_name};
939 constructor(_dummy: object, ptr: number) {{
940 super(ptr, bindings.{struct_name.replace("LDK","")}_free);
941 this.bindings_instance = null;
944 /** Creates a new instance of {struct_name.replace("LDK","")} from a given implementation */
945 public static new_impl(arg: {struct_name.replace("LDK", "")}Interface{impl_constructor_arguments}): {struct_name.replace("LDK", "")} {{
946 const impl_holder: {struct_name}Holder = new {struct_name}Holder();
947 let structImplementation = {{
948 {out_interface_implementation_overrides} }} as bindings.{struct_name};
949 {super_constructor_statements} const ptr: number = bindings.{struct_name}_new(structImplementation{bindings_instantiator});
951 impl_holder.held = new {struct_name.replace("LDK", "")}(null, ptr);
952 impl_holder.held.bindings_instance = structImplementation;
953 {pointer_to_adder} return impl_holder.held;
957 self.obj_defined([struct_name.replace("LDK", ""), struct_name.replace("LDK", "") + "Interface"], "structs")
959 out_typescript_bindings += "/* @internal */\nexport interface " + struct_name + " {\n"
961 for fn_line in field_function_lines:
962 if fn_line.fn_name != "free" and fn_line.fn_name != "cloned":
963 out_typescript_bindings += f"\t{fn_line.fn_name} ("
965 for idx, arg_conv_info in enumerate(fn_line.args_ty):
967 out_typescript_bindings = out_typescript_bindings + ", "
968 out_typescript_bindings += f"{arg_conv_info.arg_name}: {arg_conv_info.java_ty}"
970 out_typescript_bindings += f"): {fn_line.ret_ty_info.java_ty};\n"
972 out_typescript_bindings += "}\n\n"
974 out_typescript_bindings += f"/* @internal */\nexport function {struct_name}_new(impl: {struct_name}"
975 for var in flattened_field_var_conversions:
976 if isinstance(var, ConvInfo):
977 out_typescript_bindings += f", {var.arg_name}: {var.java_ty}"
979 out_typescript_bindings += f", {var[1]}: {var[0]}"
981 out_typescript_bindings += f"""): number {{
982 if(!isWasmInitialized) {{
983 throw new Error("initializeWasm() must be awaited first!");
985 var new_obj_idx = js_objs.length;
986 for (var i = 0; i < js_objs.length; i++) {{
987 if (js_objs[i] == null || js_objs[i] == undefined) {{ new_obj_idx = i; break; }}
989 js_objs[i] = new WeakRef(impl);
990 return wasm.TS_{struct_name}_new(i);
994 # Now that we've written out our java code (and created java_meths), generate C
995 out_c = "typedef struct " + struct_name + "_JCalls {\n"
996 out_c += "\tatomic_size_t refcnt;\n"
997 out_c += "\tuint32_t instance_ptr;\n"
998 for var in flattened_field_var_conversions:
999 if isinstance(var, ConvInfo):
1000 # We're a regular ol' field
1003 # We're a supertrait
1004 out_c = out_c + "\t" + var[0] + "_JCalls* " + var[1] + ";\n"
1005 out_c = out_c + "} " + struct_name + "_JCalls;\n"
1007 for fn_line in field_function_lines:
1008 if fn_line.fn_name == "free":
1009 out_c = out_c + "static void " + struct_name + "_JCalls_free(void* this_arg) {\n"
1010 out_c = out_c + "\t" + struct_name + "_JCalls *j_calls = (" + struct_name + "_JCalls*) this_arg;\n"
1011 out_c = out_c + "\tif (atomic_fetch_sub_explicit(&j_calls->refcnt, 1, memory_order_acquire) == 1) {\n"
1012 out_c = out_c + "\t\tFREE(j_calls);\n"
1013 out_c = out_c + "\t}\n}\n"
1015 for idx, fn_line in enumerate(field_function_lines):
1016 if fn_line.fn_name != "free" and fn_line.fn_name != "cloned":
1017 assert fn_line.ret_ty_info.ty_info.get_full_rust_ty()[1] == ""
1018 out_c = out_c + fn_line.ret_ty_info.ty_info.get_full_rust_ty()[0] + " " + fn_line.fn_name + "_" + struct_name + "_jcall("
1019 if fn_line.self_is_const:
1020 out_c = out_c + "const void* this_arg"
1022 out_c = out_c + "void* this_arg"
1024 for idx, arg in enumerate(fn_line.args_ty):
1025 out_c = out_c + ", " + arg.ty_info.get_full_rust_ty()[0] + " " + arg.arg_name + arg.ty_info.get_full_rust_ty()[1]
1027 out_c = out_c + ") {\n"
1028 out_c = out_c + "\t" + struct_name + "_JCalls *j_calls = (" + struct_name + "_JCalls*) this_arg;\n"
1030 for arg_info in fn_line.args_ty:
1031 if arg_info.ret_conv is not None:
1032 out_c = out_c + "\t" + arg_info.ret_conv[0].replace('\n', '\n\t')
1033 out_c = out_c + arg_info.arg_name
1034 out_c = out_c + arg_info.ret_conv[1].replace('\n', '\n\t') + "\n"
1037 assert len(fn_line.args_ty) < 6
1038 for arg_info in fn_line.args_ty:
1039 if arg_info.c_ty == "uint64_t" or arg_info.c_ty == "int64_t":
1043 for i in range(0, 6 - len(fn_line.args_ty)):
1045 if fn_line.ret_ty_info.c_ty.endswith("Array"):
1046 out_c += "\t" + fn_line.ret_ty_info.c_ty + " ret = (" + fn_line.ret_ty_info.c_ty + ")"
1047 out_c += "js_invoke_function_" + fn_suffix + "(j_calls->instance_ptr, " + str(self.function_ptr_counter)
1048 elif fn_line.ret_ty_info.java_ty == "void":
1049 out_c = out_c + "\tjs_invoke_function_" + fn_suffix + "(j_calls->instance_ptr, " + str(self.function_ptr_counter)
1050 elif fn_line.ret_ty_info.java_hu_ty == "string":
1051 out_c += "\tjstring ret = (jstring)js_invoke_function_" + fn_suffix + "(j_calls->instance_ptr, " + str(self.function_ptr_counter)
1052 elif not fn_line.ret_ty_info.passed_as_ptr:
1053 out_c += "\treturn js_invoke_function_" + fn_suffix + "(j_calls->instance_ptr, " + str(self.function_ptr_counter)
1055 out_c += "\tuint32_t ret = js_invoke_function_" + fn_suffix + "(j_calls->instance_ptr, " + str(self.function_ptr_counter)
1057 self.function_ptrs[self.function_ptr_counter] = (struct_name, fn_line.fn_name)
1058 self.function_ptr_counter += 1
1060 for idx, arg_info in enumerate(fn_line.args_ty):
1061 if arg_info.ret_conv is not None:
1062 out_c += ", (uint32_t)" + arg_info.ret_conv_name
1064 out_c += ", (uint32_t)" + arg_info.arg_name
1065 for i in range(0, 6 - len(fn_line.args_ty)):
1067 out_c = out_c + ");\n"
1068 if fn_line.ret_ty_info.arg_conv is not None:
1069 out_c = out_c + "\t" + fn_line.ret_ty_info.arg_conv.replace("\n", "\n\t") + "\n\treturn " + fn_line.ret_ty_info.arg_conv_name + ";\n"
1071 out_c = out_c + "}\n"
1073 # Write out a clone function whether we need one or not, as we use them in moving to rust
1074 out_c = out_c + "static void " + struct_name + "_JCalls_cloned(" + struct_name + "* new_obj) {\n"
1075 out_c = out_c + "\t" + struct_name + "_JCalls *j_calls = (" + struct_name + "_JCalls*) new_obj->this_arg;\n"
1076 out_c = out_c + "\tatomic_fetch_add_explicit(&j_calls->refcnt, 1, memory_order_release);\n"
1077 for var in field_var_conversions:
1078 if not isinstance(var, ConvInfo):
1079 out_c = out_c + "\tatomic_fetch_add_explicit(&j_calls->" + var[1] + "->refcnt, 1, memory_order_release);\n"
1080 out_c = out_c + "}\n"
1082 out_c = out_c + "static inline " + struct_name + " " + struct_name + "_init (JSValue o"
1083 for var in flattened_field_var_conversions:
1084 if isinstance(var, ConvInfo):
1085 out_c = out_c + ", " + var.c_ty + " " + var.arg_name
1087 out_c = out_c + ", JSValue " + var[1]
1088 out_c = out_c + ") {\n"
1090 out_c = out_c + "\t" + struct_name + "_JCalls *calls = MALLOC(sizeof(" + struct_name + "_JCalls), \"" + struct_name + "_JCalls\");\n"
1091 out_c = out_c + "\tatomic_init(&calls->refcnt, 1);\n"
1092 out_c = out_c + "\tcalls->instance_ptr = o;\n"
1094 for (fn_name, java_meth_descr) in java_meths:
1095 if fn_name != "free" and fn_name != "cloned":
1096 out_c = out_c + "\tcalls->" + fn_name + "_meth = (*env)->GetMethodID(env, c, \"" + fn_name + "\", \"" + java_meth_descr + "\");\n"
1097 out_c = out_c + "\tCHECK(calls->" + fn_name + "_meth != NULL);\n"
1099 for var in flattened_field_var_conversions:
1100 if isinstance(var, ConvInfo) and var.arg_conv is not None:
1101 out_c = out_c + "\n\t" + var.arg_conv.replace("\n", "\n\t") +"\n"
1102 out_c = out_c + "\n\t" + struct_name + " ret = {\n"
1103 out_c = out_c + "\t\t.this_arg = (void*) calls,\n"
1104 for fn_line in field_function_lines:
1105 if fn_line.fn_name != "free" and fn_line.fn_name != "cloned":
1106 out_c = out_c + "\t\t." + fn_line.fn_name + " = " + fn_line.fn_name + "_" + struct_name + "_jcall,\n"
1107 elif fn_line.fn_name == "free":
1108 out_c = out_c + "\t\t.free = " + struct_name + "_JCalls_free,\n"
1110 out_c = out_c + "\t\t.cloned = " + struct_name + "_JCalls_cloned,\n"
1111 for var in field_var_conversions:
1112 if isinstance(var, ConvInfo):
1113 if var.arg_conv_name is not None:
1114 out_c = out_c + "\t\t." + var.arg_name + " = " + var.arg_conv_name + ",\n"
1115 out_c = out_c + "\t\t.set_" + var.arg_name + " = NULL,\n"
1117 out_c = out_c + "\t\t." + var.var_name + " = " + var.var_name + ",\n"
1118 out_c = out_c + "\t\t.set_" + var.var_name + " = NULL,\n"
1120 out_c += "\t\t." + var[1] + " = " + var[0] + "_init(" + var[1]
1121 for suparg in var[2]:
1122 if isinstance(suparg, ConvInfo):
1123 out_c += ", " + suparg.arg_name
1125 out_c += ", " + suparg[1]
1127 out_c = out_c + "\t};\n"
1128 for var in flattened_field_var_conversions:
1129 if not isinstance(var, ConvInfo):
1130 out_c = out_c + "\tcalls->" + var[1] + " = ret." + var[1] + ".this_arg;\n"
1131 out_c = out_c + "\treturn ret;\n"
1132 out_c = out_c + "}\n"
1134 out_c = out_c + self.c_fn_ty_pfx + "long " + self.c_fn_name_define_pfx(struct_name + "_new", True) + "JSValue o"
1135 for var in flattened_field_var_conversions:
1136 if isinstance(var, ConvInfo):
1137 out_c = out_c + ", " + var.c_ty + " " + var.arg_name
1139 out_c = out_c + ", JSValue " + var[1]
1140 out_c = out_c + ") {\n"
1141 out_c = out_c + "\t" + struct_name + " *res_ptr = MALLOC(sizeof(" + struct_name + "), \"" + struct_name + "\");\n"
1142 out_c = out_c + "\t*res_ptr = " + struct_name + "_init(o"
1143 for var in flattened_field_var_conversions:
1144 if isinstance(var, ConvInfo):
1145 out_c = out_c + ", " + var.arg_name
1147 out_c = out_c + ", " + var[1]
1148 out_c = out_c + ");\n"
1149 out_c = out_c + "\treturn (long)res_ptr;\n"
1150 out_c = out_c + "}\n"
1152 return (out_typescript_bindings, out_typescript_human, out_c)
1154 def trait_struct_inc_refcnt(self, ty_info):
1155 base_conv = "\nif (" + ty_info.var_name + "_conv.free == " + ty_info.rust_obj + "_JCalls_free) {\n"
1156 base_conv = base_conv + "\t// If this_arg is a JCalls struct, then we need to increment the refcnt in it.\n"
1157 base_conv = base_conv + "\t" + ty_info.rust_obj + "_JCalls_cloned(&" + ty_info.var_name + "_conv);\n}"
1160 def map_complex_enum(self, struct_name, variant_list, camel_to_snake, enum_doc_comment):
1161 bindings_type = struct_name.replace("LDK", "")
1162 java_hu_type = struct_name.replace("LDK", "").replace("COption", "Option")
1168 out_java_enum += (self.hu_struct_file_prefix)
1170 java_hu_class = "/**\n * " + enum_doc_comment.replace("\n", "\n * ") + "\n */\n"
1171 java_hu_class += "export class " + java_hu_type + " extends CommonBase {\n"
1172 java_hu_class += "\tprotected constructor(_dummy: object, ptr: number) { super(ptr, bindings." + bindings_type + "_free); }\n"
1173 java_hu_class += "\t/* @internal */\n"
1174 java_hu_class += f"\tpublic static constr_from_ptr(ptr: number): {java_hu_type} {{\n"
1175 java_hu_class += f"\t\tconst raw_ty: number = bindings." + struct_name + "_ty_from_ptr(ptr);\n"
1176 out_c += self.c_fn_ty_pfx + "uint32_t" + self.c_fn_name_define_pfx(struct_name + "_ty_from_ptr", True) + self.ptr_c_ty + " ptr) {\n"
1177 out_c += "\t" + struct_name + " *obj = (" + struct_name + "*)(ptr & ~1);\n"
1178 out_c += "\tswitch(obj->tag) {\n"
1179 java_hu_class += "\t\tswitch (raw_ty) {\n"
1180 java_hu_subclasses = ""
1182 out_java += "/* @internal */\nexport class " + struct_name + " {\n"
1183 out_java += "\tprotected constructor() {}\n"
1185 for var in variant_list:
1186 java_hu_subclasses += "/** A " + java_hu_type + " of type " + var.var_name + " */\n"
1187 java_hu_subclasses += "export class " + java_hu_type + "_" + var.var_name + " extends " + java_hu_type + " {\n"
1188 java_hu_class += f"\t\t\tcase {var_idx}: "
1189 java_hu_class += "return new " + java_hu_type + "_" + var.var_name + "(ptr);\n"
1190 out_c += f"\t\tcase {struct_name}_{var.var_name}: return {var_idx};\n"
1192 for idx, (field_ty, field_docs) in enumerate(var.fields):
1193 if field_docs is not None:
1194 java_hu_subclasses += "\t/**\n\t * " + field_docs.replace("\n", "\n\t * ") + "\n\t */\n"
1195 java_hu_subclasses += "\tpublic " + field_ty.arg_name + f": {field_ty.java_hu_ty};\n"
1196 if field_ty.to_hu_conv is not None:
1197 hu_conv_body += f"\t\tconst {field_ty.arg_name}: {field_ty.java_ty} = bindings.{struct_name}_{var.var_name}_get_{field_ty.arg_name}(ptr);\n"
1198 hu_conv_body += f"\t\t" + field_ty.to_hu_conv.replace("\n", "\n\t\t\t") + "\n"
1199 hu_conv_body += f"\t\tthis." + field_ty.arg_name + " = " + field_ty.to_hu_conv_name + ";\n"
1201 hu_conv_body += f"\t\tthis.{field_ty.arg_name} = bindings.{struct_name}_{var.var_name}_get_{field_ty.arg_name}(ptr);\n"
1202 java_hu_subclasses += "\t/* @internal */\n"
1203 java_hu_subclasses += "\tpublic constructor(ptr: number) {\n\t\tsuper(null, ptr);\n"
1204 java_hu_subclasses = java_hu_subclasses + hu_conv_body
1205 java_hu_subclasses = java_hu_subclasses + "\t}\n}\n"
1208 java_hu_class += "\t\t\tdefault:\n\t\t\t\tthrow new Error('oops, this should be unreachable'); // Unreachable without extending the (internal) bindings interface\n\t\t}\n\t}\n\n"
1209 out_java += self.fn_call_body(struct_name + "_ty_from_ptr", "uint32_t", "number", "ptr: number", "ptr")
1210 out_c += ("\t\tdefault: abort();\n")
1211 out_c += ("\t}\n}\n")
1213 for var in variant_list:
1214 for idx, (field_map, _) in enumerate(var.fields):
1215 fn_name = f"{struct_name}_{var.var_name}_get_{field_map.arg_name}"
1216 out_c += self.c_fn_ty_pfx + field_map.c_ty + self.c_fn_name_define_pfx(fn_name, True) + self.ptr_c_ty + " ptr) {\n"
1217 out_c += "\t" + struct_name + " *obj = (" + struct_name + "*)(ptr & ~1);\n"
1218 out_c += f"\tassert(obj->tag == {struct_name}_{var.var_name});\n"
1219 if field_map.ret_conv is not None:
1220 out_c += ("\t\t\t" + field_map.ret_conv[0].replace("\n", "\n\t\t\t"))
1221 if var.tuple_variant:
1222 out_c += "obj->" + camel_to_snake(var.var_name)
1224 out_c += "obj->" + camel_to_snake(var.var_name) + "." + field_map.arg_name
1225 out_c += (field_map.ret_conv[1].replace("\n", "\n\t\t\t") + "\n")
1226 out_c += "\treturn " + field_map.ret_conv_name + ";\n"
1228 if var.tuple_variant:
1229 out_c += "\treturn " + "obj->" + camel_to_snake(var.var_name) + ";\n"
1231 out_c += "\treturn " + "obj->" + camel_to_snake(var.var_name) + "." + field_map.arg_name + ";\n"
1233 out_java += self.fn_call_body(fn_name, field_map.c_ty, field_map.java_ty, "ptr: number", "ptr")
1234 out_java_enum += java_hu_class
1235 self.struct_file_suffixes[java_hu_type] = java_hu_subclasses
1236 self.obj_defined([java_hu_type], "structs")
1237 return (out_java, out_java_enum, out_c)
1239 def map_opaque_struct(self, struct_name, struct_doc_comment):
1240 implementations = ""
1243 hu_name = struct_name.replace("LDKC2Tuple", "TwoTuple").replace("LDKC3Tuple", "ThreeTuple").replace("LDK", "")
1244 out_opaque_struct_human = f"{self.hu_struct_file_prefix}"
1245 constructor_body = "super(ptr, bindings." + struct_name.replace("LDK","") + "_free);"
1248 if struct_name.startswith("LDKLocked") or struct_name.startswith("LDKReadOnly"):
1249 extra_docs = "\n * This type represents a lock and MUST BE MANUALLY FREE'd!"
1250 constructor_body = 'super(ptr, () => { throw new Error("Locks must be manually freed with free()"); });'
1252 /** Releases this lock */
1254 bindings.{struct_name.replace("LDK","")}_free(this.ptr);
1255 CommonBase.set_null_skip_free(this);
1257 formatted_doc_comment = struct_doc_comment.replace("\n", "\n * ")
1258 out_opaque_struct_human += f"""
1260 * {formatted_doc_comment}
1262 export class {hu_name} extends CommonBase {implementations}{{
1264 public constructor(_dummy: object, ptr: number) {{
1269 self.obj_defined([hu_name], "structs")
1270 return out_opaque_struct_human
1272 def map_tuple(self, struct_name):
1273 return self.map_opaque_struct(struct_name, "A Tuple")
1275 def map_result(self, struct_name, res_map, err_map):
1276 human_ty = struct_name.replace("LDKCResult", "Result")
1278 suffixes = f"export class {human_ty}_OK extends {human_ty} {{\n"
1279 if res_map.java_hu_ty != "void":
1280 suffixes += "\tpublic res: " + res_map.java_hu_ty + ";\n"
1283 public constructor(_dummy: object, ptr: number) {{
1286 if res_map.java_hu_ty == "void":
1288 elif res_map.to_hu_conv is not None:
1289 suffixes += "\t\tconst res: " + res_map.java_ty + " = bindings." + struct_name.replace("LDK", "") + "_get_ok(ptr);\n"
1290 suffixes += "\t\t" + res_map.to_hu_conv.replace("\n", "\n\t\t")
1291 suffixes += "\n\t\tthis.res = " + res_map.to_hu_conv_name + ";\n"
1293 suffixes += "\t\tthis.res = bindings." + struct_name.replace("LDK", "") + "_get_ok(ptr);\n"
1294 suffixes += "\t}\n}\n"
1296 suffixes += f"export class {human_ty}_Err extends {human_ty} {{\n"
1297 if err_map.java_hu_ty != "void":
1298 suffixes += "\tpublic err: " + err_map.java_hu_ty + ";\n"
1301 public constructor(_dummy: object, ptr: number) {{
1304 if err_map.java_hu_ty == "void":
1306 elif err_map.to_hu_conv is not None:
1307 suffixes += "\t\tconst err: " + err_map.java_ty + " = bindings." + struct_name.replace("LDK", "") + "_get_err(ptr);\n"
1308 suffixes += "\t\t" + err_map.to_hu_conv.replace("\n", "\n\t\t")
1309 suffixes += "\n\t\tthis.err = " + err_map.to_hu_conv_name + ";\n"
1311 suffixes += "\t\tthis.err = bindings." + struct_name.replace("LDK", "") + "_get_err(ptr);\n"
1312 suffixes += "\t}\n}"
1314 self.struct_file_suffixes[human_ty] = suffixes
1315 self.obj_defined([human_ty], "structs")
1317 return f"""{self.hu_struct_file_prefix}
1319 export class {human_ty} extends CommonBase {{
1320 protected constructor(_dummy: object, ptr: number) {{
1321 super(ptr, bindings.{struct_name.replace("LDK","")}_free);
1324 public static constr_from_ptr(ptr: number): {human_ty} {{
1325 if (bindings.{struct_name.replace("LDK", "")}_is_ok(ptr)) {{
1326 return new {human_ty}_OK(null, ptr);
1328 return new {human_ty}_Err(null, ptr);
1333 def fn_call_body(self, method_name, return_c_ty, return_java_ty, method_argument_string, native_call_argument_string):
1334 has_return_value = return_c_ty != 'void'
1335 return_statement = 'return nativeResponseValue;'
1336 if not has_return_value:
1337 return_statement = '// debug statements here'
1339 return f"""/* @internal */
1340 export function {method_name}({method_argument_string}): {return_java_ty} {{
1341 if(!isWasmInitialized) {{
1342 throw new Error("initializeWasm() must be awaited first!");
1344 const nativeResponseValue = wasm.TS_{method_name}({native_call_argument_string});
1348 def map_function(self, argument_types, c_call_string, method_name, meth_n, return_type_info, struct_meth, default_constructor_args, takes_self, takes_self_as_ref, args_known, type_mapping_generator, doc_comment):
1351 out_java_struct = None
1354 out_c += (self.c_fn_ty_pfx)
1355 out_c += (return_type_info.c_ty)
1356 out_java += (return_type_info.java_ty)
1357 if return_type_info.ret_conv is not None:
1358 ret_conv_pfx, ret_conv_sfx = return_type_info.ret_conv
1359 out_java += (" " + method_name + "(")
1360 out_c += (" " + self.c_fn_name_define_pfx(method_name, True))
1362 method_argument_string = ""
1363 native_call_argument_string = ""
1364 for idx, arg_conv_info in enumerate(argument_types):
1366 method_argument_string += (", ")
1367 native_call_argument_string += ', '
1369 if arg_conv_info.c_ty != "void":
1370 out_c += (arg_conv_info.c_ty + " " + arg_conv_info.arg_name)
1371 method_argument_string += f"{arg_conv_info.arg_name}: {arg_conv_info.java_ty}"
1372 native_call_argument_string += arg_conv_info.arg_name
1373 out_java = self.fn_call_body(method_name, return_type_info.c_ty, return_type_info.java_ty, method_argument_string, native_call_argument_string)
1375 out_java_struct = ""
1376 if doc_comment is not None:
1377 out_java_struct = "\t/**\n\t * " + doc_comment.replace("\n", "\n\t * ") + "\n\t */\n"
1380 out_java_struct += ("\t// Skipped " + method_name + "\n")
1383 out_java_struct += (
1384 "\tpublic static constructor_" + meth_n + "(")
1386 out_java_struct += ("\tpublic " + meth_n + "(")
1387 for idx, arg in enumerate(argument_types):
1389 if not takes_self or idx > 1:
1390 out_java_struct += (", ")
1393 if arg.java_ty != "void":
1394 if arg.arg_name in default_constructor_args:
1395 for explode_idx, explode_arg in enumerate(default_constructor_args[arg.arg_name]):
1396 if explode_idx != 0:
1397 out_java_struct += (", ")
1398 out_java_struct += arg.arg_name + "_" + explode_arg.arg_name + ": " + explode_arg.java_hu_ty
1400 out_java_struct += arg.arg_name + ": " + arg.java_hu_ty
1403 if out_java_struct is not None:
1404 out_java_struct += "): " + return_type_info.java_hu_ty + " {\n"
1405 for info in argument_types:
1406 if info.arg_conv is not None:
1407 out_c += ("\t" + info.arg_conv.replace('\n', "\n\t") + "\n")
1408 if return_type_info.ret_conv is not None:
1409 out_c += ("\t" + ret_conv_pfx.replace('\n', '\n\t'))
1410 elif return_type_info.c_ty != "void":
1411 out_c += ("\t" + return_type_info.c_ty + " ret_val = ")
1414 if c_call_string is None:
1415 out_c += (method_name + "(")
1417 out_c += (c_call_string)
1418 for idx, info in enumerate(argument_types):
1419 if info.arg_conv_name is not None:
1422 elif c_call_string is not None:
1424 out_c += (info.arg_conv_name)
1426 if return_type_info.ret_conv is not None:
1427 out_c += (ret_conv_sfx.replace('\n', '\n\t'))
1430 for info in argument_types:
1431 if info.arg_conv_cleanup is not None:
1432 out_c += ("\n\t" + info.arg_conv_cleanup.replace("\n", "\n\t"))
1433 if return_type_info.ret_conv is not None:
1434 out_c += ("\n\treturn " + return_type_info.ret_conv_name + ";")
1435 elif return_type_info.c_ty != "void":
1436 out_c += ("\n\treturn ret_val;")
1437 out_c += ("\n}\n\n")
1440 out_java_struct += ("\t\t")
1441 if return_type_info.java_ty != "void":
1442 out_java_struct += "const ret: " + return_type_info.java_ty + " = "
1443 out_java_struct += ("bindings." + method_name + "(")
1444 for idx, info in enumerate(argument_types):
1446 out_java_struct += (", ")
1447 if idx == 0 and takes_self:
1448 out_java_struct += ("this.ptr")
1449 elif info.arg_name in default_constructor_args:
1450 out_java_struct += ("bindings." + info.java_hu_ty + "_new(")
1451 for explode_idx, explode_arg in enumerate(default_constructor_args[info.arg_name]):
1452 if explode_idx != 0:
1453 out_java_struct += (", ")
1454 expl_arg_name = info.arg_name + "_" + explode_arg.arg_name
1455 if explode_arg.from_hu_conv is not None:
1456 out_java_struct += (
1457 explode_arg.from_hu_conv[0].replace(explode_arg.arg_name, expl_arg_name))
1459 out_java_struct += (expl_arg_name)
1460 out_java_struct += (")")
1461 elif info.from_hu_conv is not None:
1462 out_java_struct += (info.from_hu_conv[0])
1464 out_java_struct += (info.arg_name)
1465 out_java_struct += (");\n")
1466 if return_type_info.to_hu_conv is not None:
1468 out_java_struct += ("\t\t" + return_type_info.to_hu_conv.replace("\n", "\n\t\t").replace("this",
1469 return_type_info.to_hu_conv_name) + "\n")
1471 out_java_struct += ("\t\t" + return_type_info.to_hu_conv.replace("\n", "\n\t\t") + "\n")
1473 for idx, info in enumerate(argument_types):
1474 if idx == 0 and takes_self:
1476 elif info.arg_name in default_constructor_args:
1477 for explode_arg in default_constructor_args[info.arg_name]:
1478 expl_arg_name = info.arg_name + "_" + explode_arg.arg_name
1479 if explode_arg.from_hu_conv is not None and return_type_info.to_hu_conv_name:
1480 out_java_struct += ("\t\t" + explode_arg.from_hu_conv[1].replace(explode_arg.arg_name,
1481 expl_arg_name).replace(
1482 "this", return_type_info.to_hu_conv_name) + ";\n")
1483 elif info.from_hu_conv is not None and info.from_hu_conv[1] != "":
1484 if not takes_self and return_type_info.to_hu_conv_name is not None:
1485 out_java_struct += (
1486 "\t\t" + info.from_hu_conv[1].replace("this", return_type_info.to_hu_conv_name).replace("\n", "\n\t\t") + ";\n")
1488 out_java_struct += ("\t\t" + info.from_hu_conv[1].replace("\n", "\n\t\t") + ";\n")
1490 if return_type_info.to_hu_conv_name is not None:
1491 out_java_struct += ("\t\treturn " + return_type_info.to_hu_conv_name + ";\n")
1492 elif return_type_info.java_ty != "void" and return_type_info.rust_obj != "LDK" + struct_meth:
1493 out_java_struct += ("\t\treturn ret;\n")
1494 out_java_struct += ("\t}\n\n")
1496 return (out_java, out_c, out_java_struct)
1499 for struct in self.struct_file_suffixes:
1500 with open(self.outdir + "/structs/" + struct + self.file_ext, "a") as src:
1501 src.write(self.struct_file_suffixes[struct])
1503 with open(self.outdir + "/bindings.mts", "a") as bindings:
1506 js_invoke = function(obj_ptr: number, fn_id: number, arg1: bigint|number, arg2: bigint|number, arg3: bigint|number, arg4: bigint|number, arg5: bigint|number, arg6: bigint|number, arg7: bigint|number, arg8: bigint|number, arg9: bigint|number, arg10: bigint|number) {
1507 const weak: WeakRef<object> = js_objs[obj_ptr];
1508 if (weak == null || weak == undefined) {
1509 console.error("Got function call on unknown/free'd JS object!");
1510 throw new Error("Got function call on unknown/free'd JS object!");
1512 const obj: object = weak.deref();
1513 if (obj == null || obj == undefined) {
1514 console.error("Got function call on GC'd JS object!");
1515 throw new Error("Got function call on GC'd JS object!");
1519 bindings.write("\tswitch (fn_id) {\n")
1520 for f in self.function_ptrs:
1521 bindings.write(f"\t\tcase {str(f)}: fn = Object.getOwnPropertyDescriptor(obj, \"{self.function_ptrs[f][1]}\"); break;\n")
1523 bindings.write("""\t\tdefault:
1524 console.error("Got unknown function call from C!");
1525 throw new Error("Got unknown function call from C!");
1527 if (fn == null || fn == undefined) {
1528 console.error("Got function call on incorrect JS object!");
1529 throw new Error("Got function call on incorrect JS object!");
1531 const ret = fn.value.bind(obj)(arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8, arg9, arg10);
1532 if (ret === undefined || ret === null) return BigInt(0);