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", "bbuuuu", "bbbuuu", "bbbbuu",
129 "bbbbbb", "ubuubu", "ubuuuu", "ubbuuu", "uubuuu", "uububu", "ububuu"];
132 export async function initializeWasmFromUint8Array(wasmBinary: Uint8Array) {
133 for (const fn of fn_list) { imports.env["js_invoke_function_" + fn] = js_invoke; }
134 const { instance: wasmInstance } = await WebAssembly.instantiate(wasmBinary, imports);
135 await finishInitializeWasm(wasmInstance);
139 export async function initializeWasmFetch(uri: string) {
140 for (const fn of fn_list) { imports.env["js_invoke_function_" + fn] = js_invoke; }
141 const stream = fetch(uri);
142 const { instance: wasmInstance } = await WebAssembly.instantiateStreaming(stream, imports);
143 await finishInitializeWasm(wasmInstance);
146 self.bindings_header += """
150 export function uint5ArrToBytes(inputArray: Array<UInt5>): Uint8Array {
151 const arr = new Uint8Array(inputArray.length);
152 for (var i = 0; i < inputArray.length; i++) {
153 arr[i] = inputArray[i]!.getVal();
159 export function WitnessVersionArrToBytes(inputArray: Array<WitnessVersion>): Uint8Array {
160 const arr = new Uint8Array(inputArray.length);
161 for (var i = 0; i < inputArray.length; i++) {
162 arr[i] = inputArray[i]!.getVal();
170 export function encodeUint128 (inputVal: bigint): number {
171 if (inputVal >= 0x10000000000000000000000000000000n) throw "U128s cannot exceed 128 bits";
172 const cArrayPointer = wasm.TS_malloc(16 + 8);
173 const arrayLengthView = new BigUint64Array(wasm.memory.buffer, cArrayPointer, 1);
174 arrayLengthView[0] = BigInt(16);
175 const arrayMemoryView = new Uint8Array(wasm.memory.buffer, cArrayPointer + 8, 16);
176 for (var i = 0; i < 16; i++) arrayMemoryView[i] = Number((inputVal >> BigInt(i)*8n) & 0xffn);
177 return cArrayPointer;
180 export function encodeUint8Array (inputArray: Uint8Array|null): number {
181 if (inputArray == null) return 0;
182 const cArrayPointer = wasm.TS_malloc(inputArray.length + 8);
183 const arrayLengthView = new BigUint64Array(wasm.memory.buffer, cArrayPointer, 1);
184 arrayLengthView[0] = BigInt(inputArray.length);
185 const arrayMemoryView = new Uint8Array(wasm.memory.buffer, cArrayPointer + 8, inputArray.length);
186 arrayMemoryView.set(inputArray);
187 return cArrayPointer;
190 export function encodeUint32Array (inputArray: Uint32Array|Array<number>|null): number {
191 if (inputArray == null) return 0;
192 const cArrayPointer = wasm.TS_malloc((inputArray.length + 2) * 4);
193 const arrayLengthView = new BigUint64Array(wasm.memory.buffer, cArrayPointer, 1);
194 arrayLengthView[0] = BigInt(inputArray.length);
195 const arrayMemoryView = new Uint32Array(wasm.memory.buffer, cArrayPointer + 8, inputArray.length);
196 arrayMemoryView.set(inputArray);
197 return cArrayPointer;
200 export function encodeUint64Array (inputArray: BigUint64Array|Array<bigint>|null): number {
201 if (inputArray == null) return 0;
202 const cArrayPointer = wasm.TS_malloc((inputArray.length + 1) * 8);
203 const arrayMemoryView = new BigUint64Array(wasm.memory.buffer, cArrayPointer, inputArray.length + 1);
204 arrayMemoryView[0] = BigInt(inputArray.length);
205 arrayMemoryView.set(inputArray, 1);
206 return cArrayPointer;
210 export function check_arr_len(arr: Uint8Array|null, len: number): Uint8Array|null {
211 if (arr !== null && arr.length != len) { throw new Error("Expected array of length " + len + " got " + arr.length); }
216 export function getArrayLength(arrayPointer: number): number {
217 const arraySizeViewer = new BigUint64Array(wasm.memory.buffer, arrayPointer, 1);
218 const len = arraySizeViewer[0]!;
219 if (len >= (2n ** 32n)) throw new Error("Bogus Array Size");
220 return Number(len % (2n ** 32n));
223 export function decodeUint128 (arrayPointer: number, free = true): bigint {
224 const arraySize = getArrayLength(arrayPointer);
225 if (arraySize != 16) throw "Need 16 bytes for a uint128";
226 const actualArrayViewer = new Uint8Array(wasm.memory.buffer, arrayPointer + 8, arraySize);
228 for (var i = 0; i < 16; i++) {
230 val |= BigInt(actualArrayViewer[i]!);
233 wasm.TS_free(arrayPointer);
238 export function decodeUint8Array (arrayPointer: number, free = true): Uint8Array {
239 const arraySize = getArrayLength(arrayPointer);
240 const actualArrayViewer = new Uint8Array(wasm.memory.buffer, arrayPointer + 8, arraySize);
241 // Clone the contents, TODO: In the future we should wrap the Viewer in a class that
242 // will free the underlying memory when it becomes unreachable instead of copying here.
243 // Note that doing so may have edge-case interactions with memory resizing (invalidating the buffer).
244 const actualArray = actualArrayViewer.slice(0, arraySize);
246 wasm.TS_free(arrayPointer);
250 const decodeUint32Array = (arrayPointer: number, free = true) => {
251 const arraySize = getArrayLength(arrayPointer);
252 const actualArrayViewer = new Uint32Array(
253 wasm.memory.buffer, // value
254 arrayPointer + 8, // offset (ignoring length bytes)
255 arraySize // uint32 count
257 // Clone the contents, TODO: In the future we should wrap the Viewer in a class that
258 // will free the underlying memory when it becomes unreachable instead of copying here.
259 const actualArray = actualArrayViewer.slice(0, arraySize);
261 wasm.TS_free(arrayPointer);
266 export function decodeUint64Array (arrayPointer: number, free = true): bigint[] {
267 const arraySize = getArrayLength(arrayPointer);
268 const actualArrayViewer = new BigUint64Array(
269 wasm.memory.buffer, // value
270 arrayPointer + 8, // offset (ignoring length bytes)
271 arraySize // uint32 count
273 // Clone the contents, TODO: In the future we should wrap the Viewer in a class that
274 // will free the underlying memory when it becomes unreachable instead of copying here.
275 const actualArray = new Array(arraySize);
276 for (var i = 0; i < arraySize; i++) actualArray[i] = actualArrayViewer[i];
278 wasm.TS_free(arrayPointer);
283 export function freeWasmMemory(pointer: number) { wasm.TS_free(pointer); }
286 export function getU64ArrayElem(arrayPointer: number, idx: number): bigint {
287 const actualArrayViewer = new BigUint64Array(wasm.memory.buffer, arrayPointer + 8, idx + 1);
288 return actualArrayViewer[idx]!;
292 export function getU32ArrayElem(arrayPointer: number, idx: number): number {
293 const actualArrayViewer = new Uint32Array(wasm.memory.buffer, arrayPointer + 8, idx + 1);
294 return actualArrayViewer[idx]!;
298 export function getU8ArrayElem(arrayPointer: number, idx: number): number {
299 const actualArrayViewer = new Uint8Array(wasm.memory.buffer, arrayPointer + 8, idx + 1);
300 return actualArrayViewer[idx]!;
305 export function encodeString(str: string): number {
306 const charArray = new TextEncoder().encode(str);
307 return encodeUint8Array(charArray);
311 export function decodeString(stringPointer: number, free = true): string {
312 const arraySize = getArrayLength(stringPointer);
313 const memoryView = new Uint8Array(wasm.memory.buffer, stringPointer + 8, arraySize);
314 const result = new TextDecoder("utf-8").decode(memoryView);
317 wasm.TS_free(stringPointer);
324 self.bindings_header += """
326 export function getRemainingAllocationCount(): number {
327 return wasm.TS_allocs_remaining();
330 export function debugPrintRemainingAllocs() {
331 wasm.TS_print_leaks();
335 self.bindings_header += "\n/* @internal */ export function getRemainingAllocationCount(): number { return 0; }\n"
336 self.bindings_header += "/* @internal */ export function debugPrintRemainingAllocs() { }\n"
338 with open(outdir + "/index.mts", 'a') as index:
339 index.write("""import { initializeWasmFetch, initializeWasmFromUint8Array } from './bindings.mjs';
340 /** Initializes the WASM backend by calling `fetch()` on the given URI - Browser only */
341 export async function initializeWasmWebFetch(uri: string) {
342 await initializeWasmFetch(uri);
344 /** Initializes the WASM backend given a Uint8Array of the .wasm binary file - Browser or Node.JS */
345 export async function initializeWasmFromBinary(bin: Uint8Array) {
346 await initializeWasmFromUint8Array(bin);
351 self.bindings_version_file = """export function get_ldk_java_bindings_version(): String {
352 return "<git_version_ldk_garbagecollected>";
355 self.bindings_footer = ""
357 self.common_base = """
358 function freer(f: () => void) { f() }
359 const finalizer = new FinalizationRegistry(freer);
360 function get_freeer(ptr: bigint, free_fn: (ptr: bigint) => void) {
366 export class CommonBase {
367 protected ptr: bigint;
368 protected ptrs_to: object[] = [];
369 protected constructor(ptr: bigint, free_fn: (ptr: bigint) => void) {
372 finalizer.register(this, get_freeer(ptr, free_fn), this);
375 // In Java, protected means "any subclass can access fields on any other subclass'"
376 // In TypeScript, protected means "any subclass can access parent fields on instances of itself"
377 // To work around this, we add accessors for other instances' protected fields here.
378 protected static add_ref_from(holder: CommonBase|null, referent: object|null) {
379 if (holder !== null && referent !== null) { holder.ptrs_to.push(referent); }
381 protected static get_ptr_of(o: CommonBase) {
384 protected static set_null_skip_free(o: CommonBase) {
386 // @ts-ignore TypeScript is wrong about the returnvalue of unregister here!
387 const did_unregister: boolean = finalizer.unregister(o);
389 throw new Error("FinalizationRegistry unregister should always unregister unless you double-free'd");
394 public constructor(private val: number) {
395 if (val > 32 || val < 0) throw new Error("UInt5 value is out of range");
397 public getVal(): number {
402 export class WitnessVersion {
403 public constructor(private val: number) {
404 if (val > 16 || val < 0) throw new Error("WitnessVersion value is out of range");
406 public getVal(): number {
411 export class UnqualifiedError {
412 public constructor(_val: number) {}
416 self.txout_defn = """export class TxOut extends CommonBase {
417 /** The script_pubkey in this output */
418 public script_pubkey: Uint8Array;
419 /** The value, in satoshis, of this output */
420 public value: bigint;
423 public constructor(_dummy: null, ptr: bigint) {
424 super(ptr, bindings.TxOut_free);
425 this.script_pubkey = bindings.decodeUint8Array(bindings.TxOut_get_script_pubkey(ptr));
426 this.value = bindings.TxOut_get_value(ptr);
428 public static constructor_new(value: bigint, script_pubkey: Uint8Array): TxOut {
429 return new TxOut(null, bindings.TxOut_new(bindings.encodeUint8Array(script_pubkey), value));
432 self.obj_defined(["TxOut"], "structs")
434 self.scalar_defn = """export class BigEndianScalar extends CommonBase {
435 /** The bytes of the scalar value, in big endian */
436 public scalar_bytes: Uint8Array;
439 public constructor(_dummy: null, ptr: bigint) {
440 super(ptr, bindings.BigEndianScalar_free);
441 this.scalar_bytes = bindings.decodeUint8Array(bindings.BigEndianScalar_get_bytes(ptr));
443 public static constructor_new(scalar_bytes: Uint8Array): BigEndianScalar {
444 return new BigEndianScalar(null, bindings.BigEndianScalar_new(bindings.encodeUint8Array(scalar_bytes)));
447 self.obj_defined(["BigEndianScalar"], "structs")
449 self.c_file_pfx = """#include "js-wasm.h"
450 #include <stdatomic.h>
451 #include <lightning.h>
453 // These should be provided...somehow...
454 void *memset(void *s, int c, size_t n);
455 void *memcpy(void *dest, const void *src, size_t n);
456 int memcmp(const void *s1, const void *s2, size_t n);
458 extern void __attribute__((noreturn)) abort(void);
459 static inline void assert(bool expression) {
460 if (!expression) { abort(); }
463 uint32_t __attribute__((export_name("test_bigint_pass_deadbeef0badf00d"))) test_bigint_pass_deadbeef0badf00d(uint64_t val) {
464 return val == 0xdeadbeef0badf00dULL;
470 self.c_file_pfx += """
471 void *malloc(size_t size);
472 void free(void *ptr);
474 #define MALLOC(a, _) malloc(a)
475 #define do_MALLOC(a, _b, _c) malloc(a)
476 #define FREE(p) if ((unsigned long)(p) > 4096) { free(p); }
477 #define DO_ASSERT(a) (void)(a)
479 #define CHECK_ACCESS(p)
480 #define CHECK_INNER_FIELD_ACCESS_OR_NULL(v)
483 self.c_file_pfx += """
484 extern int snprintf(char *str, size_t size, const char *format, ...);
485 typedef int32_t ssize_t;
486 ssize_t write(int fd, const void *buf, size_t count);
487 #define DEBUG_PRINT(...) do { \\
488 char debug_str[1024]; \\
489 int s_len = snprintf(debug_str, 1023, __VA_ARGS__); \\
490 write(2, debug_str, s_len); \\
493 // Always run a, then assert it is true:
494 #define DO_ASSERT(a) do { bool _assert_val = (a); assert(_assert_val); } while(0)
495 // Assert a is true or do nothing
496 #define CHECK(a) DO_ASSERT(a)
498 // Running a leak check across all the allocations and frees of the JDK is a mess,
499 // so instead we implement our own naive leak checker here, relying on the -wrap
500 // linker option to wrap malloc/calloc/realloc/free, tracking everyhing allocated
501 // and free'd in Rust or C across the generated bindings shared library.
504 typedef struct allocation {
505 struct allocation* next;
507 const char* struct_name;
510 static allocation* allocation_ll = NULL;
511 static allocation* freed_ll = NULL;
513 extern void* __real_malloc(size_t len);
514 extern void* __real_calloc(size_t nmemb, size_t len);
515 extern void* __real_aligned_alloc(size_t alignment, size_t size);
516 static void new_allocation(void* res, const char* struct_name, int lineno) {
517 allocation* new_alloc = __real_malloc(sizeof(allocation));
518 new_alloc->ptr = res;
519 new_alloc->struct_name = struct_name;
520 new_alloc->next = allocation_ll;
521 new_alloc->lineno = lineno;
522 allocation_ll = new_alloc;
524 static void* do_MALLOC(size_t len, const char* struct_name, int lineno) {
525 void* res = __real_malloc(len);
526 new_allocation(res, struct_name, lineno);
529 #define MALLOC(len, struct_name) do_MALLOC(len, struct_name, __LINE__)
531 void __real_free(void* ptr);
532 static void alloc_freed(void* ptr, int lineno) {
533 allocation* p = NULL;
534 allocation* it = allocation_ll;
535 while (it->ptr != ptr) {
536 p = it; it = it->next;
540 while (it && it->ptr != ptr) { p = it; it = it->next; }
542 DEBUG_PRINT("Tried to free unknown pointer %p at line %d.\\n", ptr, lineno);
544 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);
549 if (p) { p->next = it->next; } else { allocation_ll = it->next; }
550 DO_ASSERT(it->ptr == ptr);
554 static void do_FREE(void* ptr, int lineno) {
555 if ((unsigned long)ptr <= 4096) return; // Rust loves to create pointers to the NULL page for dummys
556 alloc_freed(ptr, lineno);
559 #define FREE(ptr) do_FREE(ptr, __LINE__)
561 static void CHECK_ACCESS(const void* ptr) {
562 allocation* it = allocation_ll;
563 while (it->ptr != ptr) {
566 return; // addrsan should catch malloc-unknown and print more info than we have
570 #define CHECK_INNER_FIELD_ACCESS_OR_NULL(v) \\
571 if (v.is_owned && v.inner != NULL) { \\
572 const void *p = __unmangle_inner_ptr(v.inner); \\
578 void* __wrap_malloc(size_t len) {
579 void* res = __real_malloc(len);
580 new_allocation(res, "malloc call", 0);
583 void* __wrap_calloc(size_t nmemb, size_t len) {
584 void* res = __real_calloc(nmemb, len);
585 new_allocation(res, "calloc call", 0);
588 void* __wrap_aligned_alloc(size_t alignment, size_t size) {
589 void* res = __real_aligned_alloc(alignment, size);
590 new_allocation(res, "aligned_alloc call", 0);
593 void __wrap_free(void* ptr) {
594 if (ptr == NULL) return;
599 void* __real_realloc(void* ptr, size_t newlen);
600 void* __wrap_realloc(void* ptr, size_t len) {
601 if (ptr != NULL) alloc_freed(ptr, 0);
602 void* res = __real_realloc(ptr, len);
603 new_allocation(res, "realloc call", 0);
606 void __wrap_reallocarray(void* ptr, size_t new_sz) {
607 // Rust doesn't seem to use reallocarray currently
611 uint32_t __attribute__((export_name("TS_allocs_remaining"))) allocs_remaining() {
613 for (allocation* a = allocation_ll; a != NULL; a = a->next) {
618 void __attribute__((export_name("TS_print_leaks"))) print_leaks() {
619 for (allocation* a = allocation_ll; a != NULL; a = a->next) {
620 DEBUG_PRINT("%s %p remains. Allocated on line %d\\n", a->struct_name, a->ptr, a->lineno);
624 self.c_file_pfx = self.c_file_pfx + """
625 // We assume that CVec_u8Z and u8slice are the same size and layout (and thus pointers to the two can be mixed)
626 _Static_assert(sizeof(LDKCVec_u8Z) == sizeof(LDKu8slice), "Vec<u8> and [u8] need to have been mapped identically");
627 _Static_assert(offsetof(LDKCVec_u8Z, data) == offsetof(LDKu8slice, data), "Vec<u8> and [u8] need to have been mapped identically");
628 _Static_assert(offsetof(LDKCVec_u8Z, datalen) == offsetof(LDKu8slice, datalen), "Vec<u8> and [u8] need to have been mapped identically");
630 _Static_assert(sizeof(void*) == 4, "Pointers mut be 32 bits");
632 #define DECL_ARR_TYPE(ty, name) \\
633 struct name##array { \\
634 uint64_t arr_len; /* uint32_t would suffice but we want to align uint64_ts as well */ \\
637 typedef struct name##array * name##Array; \\
638 static inline name##Array init_##name##Array(size_t arr_len, int lineno) { \\
639 name##Array arr = (name##Array)do_MALLOC(arr_len * sizeof(ty) + sizeof(uint64_t), #name" array init", lineno); \\
640 arr->arr_len = arr_len; \\
644 DECL_ARR_TYPE(int64_t, int64_t);
645 DECL_ARR_TYPE(uint64_t, uint64_t);
646 DECL_ARR_TYPE(int8_t, int8_t);
647 DECL_ARR_TYPE(uint32_t, uint32_t);
648 DECL_ARR_TYPE(void*, ptr);
649 DECL_ARR_TYPE(char, char);
650 typedef charArray jstring;
652 static inline jstring str_ref_to_ts(const char* chars, size_t len) {
653 charArray arr = init_charArray(len, __LINE__);
654 memcpy(arr->elems, chars, len);
657 static inline LDKStr str_ref_to_owned_c(const jstring str) {
658 char* newchars = MALLOC(str->arr_len + 1, "String chars");
659 memcpy(newchars, str->elems, str->arr_len);
660 newchars[str->arr_len] = 0;
664 .chars_is_owned = true
669 typedef bool jboolean;
671 uint32_t __attribute__((export_name("TS_malloc"))) TS_malloc(uint32_t size) {
672 return (uint32_t)MALLOC(size, "JS-Called malloc");
674 void __attribute__((export_name("TS_free"))) TS_free(uint32_t ptr) {
678 jstring __attribute__((export_name("TS_get_ldk_c_bindings_version"))) TS_get_ldk_c_bindings_version() {
679 const char *res = check_get_ldk_bindings_version();
680 if (res == NULL) return NULL;
681 return str_ref_to_ts(res, strlen(res));
683 jstring __attribute__((export_name("TS_get_ldk_version"))) get_ldk_version() {
684 const char *res = check_get_ldk_version();
685 if (res == NULL) return NULL;
686 return str_ref_to_ts(res, strlen(res));
691 self.c_version_file = """jstring __attribute__((export_name("TS_get_lib_version_string"))) TS_get_lib_version_string() {
692 return str_ref_to_ts("<git_version_ldk_garbagecollected>", strlen("<git_version_ldk_garbagecollected>"));
695 self.hu_struct_file_prefix = """
696 import { CommonBase, UInt5, WitnessVersion, UnqualifiedError } from './CommonBase.mjs';
697 import * as bindings from '../bindings.mjs'
700 self.util_fn_pfx = self.hu_struct_file_prefix + "\nexport class UtilMethods extends CommonBase {\n"
701 self.util_fn_sfx = "}"
702 self.c_fn_ty_pfx = ""
703 self.file_ext = ".mts"
704 self.ptr_c_ty = "uint64_t"
705 self.ptr_native_ty = "bigint"
706 self.u128_native_ty = "bigint"
707 self.usize_c_ty = "uint32_t"
708 self.usize_native_ty = "number"
709 self.native_zero_ptr = "0n"
710 self.result_c_ty = "uint32_t"
711 self.ptr_arr = "ptrArray"
712 self.is_arr_some_check = ("", " != 0")
713 self.get_native_arr_len_call = ("", "->arr_len")
715 def release_native_arr_ptr_call(self, ty_info, arr_var, arr_ptr_var):
717 def create_native_arr_call(self, arr_len, ty_info):
718 if ty_info.c_ty == "ptrArray":
719 assert ty_info.rust_obj == "LDKCVec_U5Z" or (ty_info.subty is not None and ty_info.subty.c_ty.endswith("Array"))
720 return "init_" + ty_info.c_ty + "(" + arr_len + ", __LINE__)"
721 def set_native_arr_contents(self, arr_name, arr_len, ty_info):
722 if ty_info.c_ty == "int8_tArray":
723 return ("memcpy(" + arr_name + "->elems, ", ", " + arr_len + ")")
726 def get_native_arr_contents(self, arr_name, dest_name, arr_len, ty_info, copy):
727 if ty_info.c_ty == "int8_tArray":
729 return "memcpy(" + dest_name + ", " + arr_name + "->elems, " + arr_len + "); FREE(" + arr_name + ")"
731 if ty_info.c_ty == "ptrArray":
732 return "(void*) " + arr_name + "->elems"
734 return arr_name + "->elems"
735 def get_native_arr_elem(self, arr_name, idxc, ty_info):
736 assert False # Only called if above is None
737 def get_native_arr_ptr_call(self, ty_info):
738 if ty_info.subty is not None:
739 return "(" + ty_info.subty.c_ty + "*)(((uint8_t*)", ") + 8)"
740 return "(" + ty_info.c_ty + "*)(((uint8_t*)", ") + 8)"
741 def get_native_arr_entry_call(self, ty_info, arr_name, idxc, entry_access):
743 def cleanup_native_arr_ref_contents(self, arr_name, dest_name, arr_len, ty_info):
744 if ty_info.c_ty == "int8_tArray":
745 return "FREE(" + arr_name + ");"
747 return "FREE(" + arr_name + ")"
749 def map_hu_array_elems(self, arr_name, conv_name, arr_ty, elem_ty):
750 if elem_ty.rust_obj == "LDKU5":
751 return arr_name + " != null ? bindings.uint5ArrToBytes(" + arr_name + ") : null"
752 assert elem_ty.c_ty == "uint64_t" or elem_ty.c_ty.endswith("Array")
753 return arr_name + " != null ? " + arr_name + ".map(" + conv_name + " => " + elem_ty.from_hu_conv[0] + ") : null"
755 def str_ref_to_native_call(self, var_name, str_len):
756 return "str_ref_to_ts(" + var_name + ", " + str_len + ")"
757 def str_ref_to_c_call(self, var_name):
758 return "str_ref_to_owned_c(" + var_name + ")"
759 def str_to_hu_conv(self, var_name):
760 return "const " + var_name + "_conv: string = bindings.decodeString(" + var_name + ");"
761 def str_from_hu_conv(self, var_name):
762 return ("bindings.encodeString(" + var_name + ")", "")
764 def c_fn_name_define_pfx(self, fn_name, have_args):
765 return " __attribute__((export_name(\"TS_" + fn_name + "\"))) TS_" + fn_name + "("
770 def get_java_arr_len(self, arr_name):
771 return "bindings.getArrayLength(" + arr_name + ")"
772 def get_java_arr_elem(self, elem_ty, arr_name, idx):
773 if elem_ty.c_ty.endswith("Array") or elem_ty.c_ty == "uintptr_t":
774 return "bindings.getU32ArrayElem(" + arr_name + ", " + idx + ")"
775 elif elem_ty.c_ty == "uint64_t":
776 return "bindings.getU64ArrayElem(" + arr_name + ", " + idx + ")"
777 elif elem_ty.rust_obj == "LDKU5":
778 return "bindings.getU8ArrayElem(" + arr_name + ", " + idx + ")"
781 def constr_hu_array(self, ty_info, arr_len):
782 return "new Array(" + arr_len + ").fill(null)"
783 def cleanup_converted_native_array(self, ty_info, arr_name):
784 return "bindings.freeWasmMemory(" + arr_name + ")"
786 def primitive_arr_from_hu(self, arr_ty, fixed_len, arr_name):
787 mapped_ty = arr_ty.subty
789 if arr_ty.rust_obj == "LDKU128":
790 return ("bindings.encodeUint128(" + inner + ")", "")
791 if fixed_len is not None:
792 assert mapped_ty.c_ty == "int8_t"
793 inner = "bindings.check_arr_len(" + arr_name + ", " + fixed_len + ")"
794 if mapped_ty.c_ty.endswith("Array"):
795 return ("bindings.encodeUint32Array(" + inner + ")", "")
796 elif mapped_ty.c_ty == "uint8_t" or mapped_ty.c_ty == "int8_t":
797 return ("bindings.encodeUint8Array(" + inner + ")", "")
798 elif mapped_ty.c_ty == "uint32_t":
799 return ("bindings.encodeUint32Array(" + inner + ")", "")
800 elif mapped_ty.c_ty == "int64_t" or mapped_ty.c_ty == "uint64_t":
801 return ("bindings.encodeUint64Array(" + inner + ")", "")
803 print(mapped_ty.c_ty)
806 def primitive_arr_to_hu(self, arr_ty, fixed_len, arr_name, conv_name):
807 mapped_ty = arr_ty.subty
808 if arr_ty.rust_obj == "LDKU128":
809 return "const " + conv_name + ": bigint = bindings.decodeUint128(" + arr_name + ");"
810 elif mapped_ty.c_ty == "uint8_t" or mapped_ty.c_ty == "int8_t":
811 return "const " + conv_name + ": Uint8Array = bindings.decodeUint8Array(" + arr_name + ");"
812 elif mapped_ty.c_ty == "uint64_t" or mapped_ty.c_ty == "int64_t":
813 return "const " + conv_name + ": bigint[] = bindings.decodeUint64Array(" + arr_name + ");"
817 def var_decl_statement(self, ty_string, var_name, statement):
818 return "const " + var_name + ": " + ty_string + " = " + statement
820 def java_arr_ty_str(self, elem_ty_str):
823 def for_n_in_range(self, n, minimum, maximum):
824 return "for (var " + n + " = " + minimum + "; " + n + " < " + maximum + "; " + n + "++) {"
825 def for_n_in_arr(self, n, arr_name, arr_elem_ty):
826 return (arr_name + ".forEach((" + n + ": " + arr_elem_ty.java_hu_ty + ") => { ", " })")
828 def get_ptr(self, var):
829 return "CommonBase.get_ptr_of(" + var + ")"
830 def set_null_skip_free(self, var):
831 return "CommonBase.set_null_skip_free(" + var + ");"
833 def add_ref(self, holder, referent):
834 return "CommonBase.add_ref_from(" + holder + ", " + referent + ")"
836 def obj_defined(self, struct_names, folder):
837 with open(self.outdir + "/index.mts", 'a') as index:
838 index.write(f"export * from './{folder}/{struct_names[0]}.mjs';\n")
839 with open(self.outdir + "/imports.mts.part", 'a') as imports:
840 imports.write(f"import {{ {', '.join(struct_names)} }} from '../{folder}/{struct_names[0]}.mjs';\n")
842 def fully_qualified_hu_ty_path(self, ty):
845 def native_c_unitary_enum_map(self, struct_name, variants, enum_doc_comment):
846 out_c = "static inline LDK" + struct_name + " LDK" + struct_name + "_from_js(int32_t ord) {\n"
847 out_c = out_c + "\tswitch (ord) {\n"
850 out_typescript_enum_fields = ""
852 for var, var_docs in variants:
853 out_c = out_c + "\t\tcase %d: return %s;\n" % (ord_v, var)
855 if var_docs is not None:
856 var_docs_repld = var_docs.replace("\n", "\n\t")
857 out_typescript_enum_fields += f"/**\n\t * {var_docs_repld}\n\t */\n"
858 out_typescript_enum_fields += f"\t{var},\n\t"
859 out_c = out_c + "\t}\n"
860 out_c = out_c + "\tabort();\n"
861 out_c = out_c + "}\n"
863 out_c = out_c + "static inline int32_t LDK" + struct_name + "_to_js(LDK" + struct_name + " val) {\n"
864 out_c = out_c + "\tswitch (val) {\n"
866 for var, _ in variants:
867 out_c = out_c + "\t\tcase " + var + ": return %d;\n" % ord_v
869 out_c = out_c + "\t\tdefault: abort();\n"
870 out_c = out_c + "\t}\n"
871 out_c = out_c + "}\n"
873 # Note that this is *not* marked /* @internal */ as we re-expose it directly in enums/
874 enum_comment_formatted = enum_doc_comment.replace("\n", "\n * ")
875 out_typescript = f"""
877 * {enum_comment_formatted}
879 export enum {struct_name} {{
880 {out_typescript_enum_fields}
883 out_typescript_enum = f"export {{ {struct_name} }} from \"../bindings.mjs\";"
884 self.obj_defined([struct_name], "enums")
885 return (out_c, out_typescript_enum, out_typescript)
887 def c_unitary_enum_to_native_call(self, ty_info):
888 return (ty_info.rust_obj + "_to_js(", ")")
889 def native_unitary_enum_to_c_call(self, ty_info):
890 return (ty_info.rust_obj + "_from_js(", ")")
892 def native_c_map_trait(self, struct_name, field_var_conversions, flattened_field_var_conversions, field_function_lines, trait_doc_comment):
893 out_typescript_bindings = ""
894 super_instantiator = ""
895 bindings_instantiator = ""
896 pointer_to_adder = ""
897 impl_constructor_arguments = ""
898 for var in flattened_field_var_conversions:
899 if isinstance(var, ConvInfo):
900 impl_constructor_arguments += f", {var.arg_name}: {var.java_hu_ty}"
901 super_instantiator += first_to_lower(var.arg_name) + ", "
902 if var.from_hu_conv is not None:
903 bindings_instantiator += ", " + var.from_hu_conv[0]
904 if var.from_hu_conv[1] != "":
905 pointer_to_adder += "\t\t\t" + var.from_hu_conv[1] + ";\n"
907 bindings_instantiator += ", " + first_to_lower(var.arg_name)
909 bindings_instantiator += ", " + first_to_lower(var[1]) + ".instance_idx!"
910 super_instantiator += first_to_lower(var[1]) + "_impl, "
911 pointer_to_adder += "\t\timpl_holder.held.ptrs_to.push(" + first_to_lower(var[1]) + ");\n"
912 impl_constructor_arguments += f", {first_to_lower(var[1])}_impl: {var[0].replace('LDK', '')}Interface"
914 super_constructor_statements = ""
915 trait_constructor_arguments = ""
916 for var in field_var_conversions:
917 if isinstance(var, ConvInfo):
918 trait_constructor_arguments += ", " + var.arg_name
920 super_constructor_statements += "\t\tconst " + first_to_lower(var[1]) + " = " + var[1] + ".new_impl(" + super_instantiator + ");\n"
921 trait_constructor_arguments += ", " + first_to_lower(var[1]) + ".instance_idx!"
922 for suparg in var[2]:
923 if isinstance(suparg, ConvInfo):
924 trait_constructor_arguments += ", " + suparg.arg_name
926 trait_constructor_arguments += ", " + suparg[1]
928 # BUILD INTERFACE METHODS
929 out_java_interface = ""
930 out_interface_implementation_overrides = ""
932 for fn_line in field_function_lines:
933 java_method_descriptor = ""
934 if fn_line.fn_name != "free" and fn_line.fn_name != "cloned":
935 out_java_interface += "\t/**" + fn_line.docs.replace("\n", "\n\t * ") + "\n\t */\n"
936 out_java_interface += "\t" + fn_line.fn_name + "("
937 out_interface_implementation_overrides += f"\t\t\t{fn_line.fn_name} ("
939 for idx, arg_conv_info in enumerate(fn_line.args_ty):
941 out_java_interface += ", "
942 out_interface_implementation_overrides += ", "
943 out_java_interface += f"{arg_conv_info.arg_name}: {arg_conv_info.java_hu_ty}"
944 out_interface_implementation_overrides += f"{arg_conv_info.arg_name}: {arg_conv_info.java_ty}"
945 java_method_descriptor += arg_conv_info.java_fn_ty_arg
946 out_java_interface += f"): {fn_line.ret_ty_info.java_hu_ty};\n"
947 java_method_descriptor += ")" + fn_line.ret_ty_info.java_fn_ty_arg
948 java_methods.append((fn_line.fn_name, java_method_descriptor))
950 out_interface_implementation_overrides += f"): {fn_line.ret_ty_info.java_ty} {{\n"
952 for arg_info in fn_line.args_ty:
953 if arg_info.to_hu_conv is not None:
954 out_interface_implementation_overrides += "\t\t\t\t" + arg_info.to_hu_conv.replace("\n", "\n\t\t\t\t") + "\n"
956 if fn_line.ret_ty_info.java_ty != "void":
957 out_interface_implementation_overrides += "\t\t\t\tconst ret: " + fn_line.ret_ty_info.java_hu_ty + " = arg." + fn_line.fn_name + "("
959 out_interface_implementation_overrides += f"\t\t\t\targ." + fn_line.fn_name + "("
961 for idx, arg_info in enumerate(fn_line.args_ty):
963 out_interface_implementation_overrides += ", "
964 if arg_info.to_hu_conv_name is not None:
965 out_interface_implementation_overrides += arg_info.to_hu_conv_name
967 out_interface_implementation_overrides += arg_info.arg_name
969 out_interface_implementation_overrides += ");\n"
970 if fn_line.ret_ty_info.java_ty != "void":
971 if fn_line.ret_ty_info.from_hu_conv is not None:
972 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"
973 if fn_line.ret_ty_info.from_hu_conv[1] != "":
974 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"
975 #if fn_line.ret_ty_info.rust_obj in result_types:
976 # XXX: We need to handle this in conversion logic so that its cross-language!
977 # Avoid double-free by breaking the result - we should learn to clone these and then we can be safe instead
978 # out_interface_implementation_overrides = out_interface_implementation_overrides + "\t\t\t\tret.ptr = 0;\n"
979 out_interface_implementation_overrides += "\t\t\t\treturn result;\n"
981 out_interface_implementation_overrides += "\t\t\t\treturn ret;\n"
982 out_interface_implementation_overrides += f"\t\t\t}},\n"
984 formatted_trait_docs = trait_doc_comment.replace("\n", "\n * ")
985 out_typescript_human = f"""
986 {self.hu_struct_file_prefix}
988 /** An implementation of {struct_name.replace("LDK","")} */
989 export interface {struct_name.replace("LDK", "")}Interface {{
990 {out_java_interface}}}
992 class {struct_name}Holder {{
993 held: {struct_name.replace("LDK", "")}|null = null;
997 * {formatted_trait_docs}
999 export class {struct_name.replace("LDK","")} extends CommonBase {{
1001 public bindings_instance: bindings.{struct_name}|null;
1004 public instance_idx?: number;
1007 constructor(_dummy: null, ptr: bigint) {{
1008 super(ptr, bindings.{struct_name.replace("LDK","")}_free);
1009 this.bindings_instance = null;
1012 /** Creates a new instance of {struct_name.replace("LDK","")} from a given implementation */
1013 public static new_impl(arg: {struct_name.replace("LDK", "")}Interface{impl_constructor_arguments}): {struct_name.replace("LDK", "")} {{
1014 const impl_holder: {struct_name}Holder = new {struct_name}Holder();
1015 let structImplementation = {{
1016 {out_interface_implementation_overrides} }} as bindings.{struct_name};
1017 {super_constructor_statements} const ptr_idx: [bigint, number] = bindings.{struct_name}_new(structImplementation{bindings_instantiator});
1019 impl_holder.held = new {struct_name.replace("LDK", "")}(null, ptr_idx[0]);
1020 impl_holder.held.instance_idx = ptr_idx[1];
1021 impl_holder.held.bindings_instance = structImplementation;
1022 {pointer_to_adder} return impl_holder.held!;
1026 self.obj_defined([struct_name.replace("LDK", ""), struct_name.replace("LDK", "") + "Interface"], "structs")
1028 out_typescript_bindings += "/* @internal */\nexport interface " + struct_name + " {\n"
1030 for fn_line in field_function_lines:
1031 if fn_line.fn_name != "free" and fn_line.fn_name != "cloned":
1032 out_typescript_bindings += f"\t{fn_line.fn_name} ("
1034 for idx, arg_conv_info in enumerate(fn_line.args_ty):
1036 out_typescript_bindings = out_typescript_bindings + ", "
1037 out_typescript_bindings += f"{arg_conv_info.arg_name}: {arg_conv_info.java_ty}"
1039 out_typescript_bindings += f"): {fn_line.ret_ty_info.java_ty};\n"
1041 out_typescript_bindings += "}\n\n"
1043 c_call_extra_args = ""
1044 out_typescript_bindings += f"/* @internal */\nexport function {struct_name}_new(impl: {struct_name}"
1045 for var in flattened_field_var_conversions:
1046 if isinstance(var, ConvInfo):
1047 out_typescript_bindings += f", {var.arg_name}: {var.java_ty}"
1048 c_call_extra_args += f", {var.arg_name}"
1050 out_typescript_bindings += f", {var[1]}: number"
1051 c_call_extra_args += f", {var[1]}"
1054 out_typescript_bindings += f"""): [bigint, number] {{
1055 if(!isWasmInitialized) {{
1056 throw new Error("initializeWasm() must be awaited first!");
1058 var new_obj_idx = js_objs.length;
1059 for (var i = 0; i < js_objs.length; i++) {{
1060 if (js_objs[i] == null || js_objs[i] == undefined) {{ new_obj_idx = i; break; }}
1062 js_objs[i] = new WeakRef(impl);
1063 return [wasm.TS_{struct_name}_new(i{c_call_extra_args}), i];
1067 # Now that we've written out our java code (and created java_meths), generate C
1068 out_c = "typedef struct " + struct_name + "_JCalls {\n"
1069 out_c += "\tatomic_size_t refcnt;\n"
1070 out_c += "\tuint32_t instance_ptr;\n"
1071 for var in flattened_field_var_conversions:
1072 if isinstance(var, ConvInfo):
1073 # We're a regular ol' field
1076 # We're a supertrait
1077 out_c = out_c + "\t" + var[0] + "_JCalls* " + var[1] + ";\n"
1078 out_c = out_c + "} " + struct_name + "_JCalls;\n"
1080 for fn_line in field_function_lines:
1081 if fn_line.fn_name == "free":
1082 out_c = out_c + "static void " + struct_name + "_JCalls_free(void* this_arg) {\n"
1083 out_c = out_c + "\t" + struct_name + "_JCalls *j_calls = (" + struct_name + "_JCalls*) this_arg;\n"
1084 out_c = out_c + "\tif (atomic_fetch_sub_explicit(&j_calls->refcnt, 1, memory_order_acquire) == 1) {\n"
1085 out_c = out_c + "\t\tFREE(j_calls);\n"
1086 out_c = out_c + "\t}\n}\n"
1088 for idx, fn_line in enumerate(field_function_lines):
1089 if fn_line.fn_name != "free" and fn_line.fn_name != "cloned":
1090 assert fn_line.ret_ty_info.ty_info.get_full_rust_ty()[1] == ""
1091 out_c = out_c + fn_line.ret_ty_info.ty_info.get_full_rust_ty()[0] + " " + fn_line.fn_name + "_" + struct_name + "_jcall("
1092 if fn_line.self_is_const:
1093 out_c = out_c + "const void* this_arg"
1095 out_c = out_c + "void* this_arg"
1097 for idx, arg in enumerate(fn_line.args_ty):
1098 out_c = out_c + ", " + arg.ty_info.get_full_rust_ty()[0] + " " + arg.arg_name + arg.ty_info.get_full_rust_ty()[1]
1100 out_c = out_c + ") {\n"
1101 out_c = out_c + "\t" + struct_name + "_JCalls *j_calls = (" + struct_name + "_JCalls*) this_arg;\n"
1103 for arg_info in fn_line.args_ty:
1104 if arg_info.ret_conv is not None:
1105 out_c = out_c + "\t" + arg_info.ret_conv[0].replace('\n', '\n\t')
1106 out_c = out_c + arg_info.arg_name
1107 out_c = out_c + arg_info.ret_conv[1].replace('\n', '\n\t') + "\n"
1110 assert len(fn_line.args_ty) < 7
1111 for arg_info in fn_line.args_ty:
1112 if arg_info.c_ty == "uint64_t" or arg_info.c_ty == "int64_t":
1116 for i in range(0, 6 - len(fn_line.args_ty)):
1118 if fn_line.ret_ty_info.c_ty.endswith("Array"):
1119 out_c += "\t" + fn_line.ret_ty_info.c_ty + " ret = (" + fn_line.ret_ty_info.c_ty + ")"
1120 out_c += "js_invoke_function_" + fn_suffix + "(j_calls->instance_ptr, " + str(self.function_ptr_counter)
1121 elif fn_line.ret_ty_info.java_ty == "void":
1122 out_c = out_c + "\tjs_invoke_function_" + fn_suffix + "(j_calls->instance_ptr, " + str(self.function_ptr_counter)
1123 elif fn_line.ret_ty_info.java_hu_ty == "string":
1124 out_c += "\tjstring ret = (jstring)js_invoke_function_" + fn_suffix + "(j_calls->instance_ptr, " + str(self.function_ptr_counter)
1125 elif fn_line.ret_ty_info.arg_conv is None:
1126 out_c += "\treturn js_invoke_function_" + fn_suffix + "(j_calls->instance_ptr, " + str(self.function_ptr_counter)
1128 out_c += "\tuint64_t ret = js_invoke_function_" + fn_suffix + "(j_calls->instance_ptr, " + str(self.function_ptr_counter)
1130 self.function_ptrs[self.function_ptr_counter] = (struct_name, fn_line.fn_name)
1131 self.function_ptr_counter += 1
1133 for idx, arg_info in enumerate(fn_line.args_ty):
1134 if arg_info.ret_conv is not None:
1135 if arg_info.c_ty.endswith("Array"):
1136 out_c += ", (uint32_t)" + arg_info.ret_conv_name
1138 out_c += ", " + arg_info.ret_conv_name
1140 assert False # TODO: Would we need some conversion here?
1141 out_c += ", (uint32_t)" + arg_info.arg_name
1142 for i in range(0, 6 - len(fn_line.args_ty)):
1144 out_c = out_c + ");\n"
1145 if fn_line.ret_ty_info.arg_conv is not None:
1146 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"
1148 out_c = out_c + "}\n"
1150 # Write out a clone function whether we need one or not, as we use them in moving to rust
1151 out_c = out_c + "static void " + struct_name + "_JCalls_cloned(" + struct_name + "* new_obj) {\n"
1152 out_c = out_c + "\t" + struct_name + "_JCalls *j_calls = (" + struct_name + "_JCalls*) new_obj->this_arg;\n"
1153 out_c = out_c + "\tatomic_fetch_add_explicit(&j_calls->refcnt, 1, memory_order_release);\n"
1154 for var in field_var_conversions:
1155 if not isinstance(var, ConvInfo):
1156 out_c = out_c + "\tatomic_fetch_add_explicit(&j_calls->" + var[1] + "->refcnt, 1, memory_order_release);\n"
1157 out_c = out_c + "}\n"
1159 out_c = out_c + "static inline " + struct_name + " " + struct_name + "_init (JSValue o"
1160 for var in flattened_field_var_conversions:
1161 if isinstance(var, ConvInfo):
1162 out_c = out_c + ", " + var.c_ty + " " + var.arg_name
1164 out_c = out_c + ", JSValue " + var[1]
1165 out_c = out_c + ") {\n"
1167 out_c = out_c + "\t" + struct_name + "_JCalls *calls = MALLOC(sizeof(" + struct_name + "_JCalls), \"" + struct_name + "_JCalls\");\n"
1168 out_c = out_c + "\tatomic_init(&calls->refcnt, 1);\n"
1169 out_c = out_c + "\tcalls->instance_ptr = o;\n"
1171 for (fn_name, java_meth_descr) in java_meths:
1172 if fn_name != "free" and fn_name != "cloned":
1173 out_c = out_c + "\tcalls->" + fn_name + "_meth = (*env)->GetMethodID(env, c, \"" + fn_name + "\", \"" + java_meth_descr + "\");\n"
1174 out_c = out_c + "\tCHECK(calls->" + fn_name + "_meth != NULL);\n"
1176 for var in flattened_field_var_conversions:
1177 if isinstance(var, ConvInfo) and var.arg_conv is not None:
1178 out_c = out_c + "\n\t" + var.arg_conv.replace("\n", "\n\t") +"\n"
1179 out_c = out_c + "\n\t" + struct_name + " ret = {\n"
1180 out_c = out_c + "\t\t.this_arg = (void*) calls,\n"
1181 for fn_line in field_function_lines:
1182 if fn_line.fn_name != "free" and fn_line.fn_name != "cloned":
1183 out_c = out_c + "\t\t." + fn_line.fn_name + " = " + fn_line.fn_name + "_" + struct_name + "_jcall,\n"
1184 elif fn_line.fn_name == "free":
1185 out_c = out_c + "\t\t.free = " + struct_name + "_JCalls_free,\n"
1187 out_c = out_c + "\t\t.cloned = " + struct_name + "_JCalls_cloned,\n"
1188 for var in field_var_conversions:
1189 if isinstance(var, ConvInfo):
1190 if var.arg_conv_name is not None:
1191 out_c = out_c + "\t\t." + var.arg_name + " = " + var.arg_conv_name + ",\n"
1192 out_c = out_c + "\t\t.set_" + var.arg_name + " = NULL,\n"
1194 out_c = out_c + "\t\t." + var.var_name + " = " + var.var_name + ",\n"
1195 out_c = out_c + "\t\t.set_" + var.var_name + " = NULL,\n"
1197 out_c += "\t\t." + var[1] + " = " + var[0] + "_init(" + var[1]
1198 for suparg in var[2]:
1199 if isinstance(suparg, ConvInfo):
1200 out_c += ", " + suparg.arg_name
1202 out_c += ", " + suparg[1]
1204 out_c = out_c + "\t};\n"
1205 for var in flattened_field_var_conversions:
1206 if not isinstance(var, ConvInfo):
1207 out_c = out_c + "\tcalls->" + var[1] + " = ret." + var[1] + ".this_arg;\n"
1208 out_c = out_c + "\treturn ret;\n"
1209 out_c = out_c + "}\n"
1211 out_c = out_c + self.c_fn_ty_pfx + "uint64_t " + self.c_fn_name_define_pfx(struct_name + "_new", True) + "JSValue o"
1212 for var in flattened_field_var_conversions:
1213 if isinstance(var, ConvInfo):
1214 out_c = out_c + ", " + var.c_ty + " " + var.arg_name
1216 out_c = out_c + ", JSValue " + var[1]
1217 out_c = out_c + ") {\n"
1218 out_c = out_c + "\t" + struct_name + " *res_ptr = MALLOC(sizeof(" + struct_name + "), \"" + struct_name + "\");\n"
1219 out_c = out_c + "\t*res_ptr = " + struct_name + "_init(o"
1220 for var in flattened_field_var_conversions:
1221 if isinstance(var, ConvInfo):
1222 out_c = out_c + ", " + var.arg_name
1224 out_c = out_c + ", " + var[1]
1225 out_c = out_c + ");\n"
1226 out_c = out_c + "\treturn tag_ptr(res_ptr, true);\n"
1227 out_c = out_c + "}\n"
1229 return (out_typescript_bindings, out_typescript_human, out_c)
1231 def trait_struct_inc_refcnt(self, ty_info):
1232 base_conv = "\nif (" + ty_info.var_name + "_conv.free == " + ty_info.rust_obj + "_JCalls_free) {\n"
1233 base_conv = base_conv + "\t// If this_arg is a JCalls struct, then we need to increment the refcnt in it.\n"
1234 base_conv = base_conv + "\t" + ty_info.rust_obj + "_JCalls_cloned(&" + ty_info.var_name + "_conv);\n}"
1237 def map_complex_enum(self, struct_name, variant_list, camel_to_snake, enum_doc_comment):
1238 bindings_type = struct_name.replace("LDK", "")
1239 java_hu_type = struct_name.replace("LDK", "").replace("COption", "Option")
1245 out_java_enum += (self.hu_struct_file_prefix)
1247 java_hu_class = "/**\n * " + enum_doc_comment.replace("\n", "\n * ") + "\n */\n"
1248 java_hu_class += "export class " + java_hu_type + " extends CommonBase {\n"
1249 java_hu_class += "\tprotected constructor(_dummy: null, ptr: bigint) { super(ptr, bindings." + bindings_type + "_free); }\n"
1250 java_hu_class += "\t/* @internal */\n"
1251 java_hu_class += f"\tpublic static constr_from_ptr(ptr: bigint): {java_hu_type} {{\n"
1252 java_hu_class += f"\t\tconst raw_ty: number = bindings." + struct_name + "_ty_from_ptr(ptr);\n"
1253 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"
1254 out_c += "\t" + struct_name + " *obj = (" + struct_name + "*)untag_ptr(ptr);\n"
1255 out_c += "\tswitch(obj->tag) {\n"
1256 java_hu_class += "\t\tswitch (raw_ty) {\n"
1257 java_hu_subclasses = ""
1259 out_java += "/* @internal */\nexport class " + struct_name + " {\n"
1260 out_java += "\tprotected constructor() {}\n"
1262 for var in variant_list:
1263 java_hu_subclasses += "/** A " + java_hu_type + " of type " + var.var_name + " */\n"
1264 java_hu_subclasses += "export class " + java_hu_type + "_" + var.var_name + " extends " + java_hu_type + " {\n"
1265 java_hu_class += f"\t\t\tcase {var_idx}: "
1266 java_hu_class += "return new " + java_hu_type + "_" + var.var_name + "(ptr);\n"
1267 out_c += f"\t\tcase {struct_name}_{var.var_name}: return {var_idx};\n"
1269 for idx, (field_ty, field_docs) in enumerate(var.fields):
1270 if field_docs is not None:
1271 java_hu_subclasses += "\t/**\n\t * " + field_docs.replace("\n", "\n\t * ") + "\n\t */\n"
1272 java_hu_subclasses += "\tpublic " + field_ty.arg_name + f": {field_ty.java_hu_ty};\n"
1273 if field_ty.to_hu_conv is not None:
1274 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"
1275 hu_conv_body += f"\t\t" + field_ty.to_hu_conv.replace("\n", "\n\t\t\t") + "\n"
1276 hu_conv_body += f"\t\tthis." + field_ty.arg_name + " = " + field_ty.to_hu_conv_name + ";\n"
1278 hu_conv_body += f"\t\tthis.{field_ty.arg_name} = bindings.{struct_name}_{var.var_name}_get_{field_ty.arg_name}(ptr);\n"
1279 java_hu_subclasses += "\t/* @internal */\n"
1280 java_hu_subclasses += "\tpublic constructor(ptr: bigint) {\n\t\tsuper(null, ptr);\n"
1281 java_hu_subclasses = java_hu_subclasses + hu_conv_body
1282 java_hu_subclasses = java_hu_subclasses + "\t}\n}\n"
1285 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"
1286 out_java += self.fn_call_body(struct_name + "_ty_from_ptr", "uint32_t", "number", "ptr: bigint", "ptr")
1287 out_c += ("\t\tdefault: abort();\n")
1288 out_c += ("\t}\n}\n")
1290 for var in variant_list:
1291 for idx, (field_map, _) in enumerate(var.fields):
1292 fn_name = f"{struct_name}_{var.var_name}_get_{field_map.arg_name}"
1293 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"
1294 out_c += "\t" + struct_name + " *obj = (" + struct_name + "*)untag_ptr(ptr);\n"
1295 out_c += f"\tassert(obj->tag == {struct_name}_{var.var_name});\n"
1296 if field_map.ret_conv is not None:
1297 out_c += ("\t\t\t" + field_map.ret_conv[0].replace("\n", "\n\t\t\t"))
1298 if var.tuple_variant:
1299 out_c += "obj->" + camel_to_snake(var.var_name)
1301 out_c += "obj->" + camel_to_snake(var.var_name) + "." + field_map.arg_name
1302 out_c += (field_map.ret_conv[1].replace("\n", "\n\t\t\t") + "\n")
1303 out_c += "\treturn " + field_map.ret_conv_name + ";\n"
1305 if var.tuple_variant:
1306 out_c += "\treturn " + "obj->" + camel_to_snake(var.var_name) + ";\n"
1308 out_c += "\treturn " + "obj->" + camel_to_snake(var.var_name) + "." + field_map.arg_name + ";\n"
1310 out_java += self.fn_call_body(fn_name, field_map.c_ty, field_map.java_ty, "ptr: bigint", "ptr")
1311 out_java_enum += java_hu_class
1312 self.struct_file_suffixes[java_hu_type] = java_hu_subclasses
1313 self.obj_defined([java_hu_type], "structs")
1314 return (out_java, out_java_enum, out_c)
1316 def map_opaque_struct(self, struct_name, struct_doc_comment):
1317 implementations = ""
1320 hu_name = struct_name.replace("LDKC2Tuple", "TwoTuple").replace("LDKC3Tuple", "ThreeTuple").replace("LDK", "")
1321 out_opaque_struct_human = f"{self.hu_struct_file_prefix}"
1322 constructor_body = "super(ptr, bindings." + struct_name.replace("LDK","") + "_free);"
1325 if struct_name.startswith("LDKLocked") or struct_name.startswith("LDKReadOnly"):
1326 extra_docs = "\n * This type represents a lock and MUST BE MANUALLY FREE'd!"
1327 constructor_body = 'super(ptr, () => { throw new Error("Locks must be manually freed with free()"); });'
1329 /** Releases this lock */
1331 bindings.{struct_name.replace("LDK","")}_free(this.ptr);
1332 CommonBase.set_null_skip_free(this);
1334 formatted_doc_comment = struct_doc_comment.replace("\n", "\n * ")
1335 out_opaque_struct_human += f"""
1337 * {formatted_doc_comment}
1339 export class {hu_name} extends CommonBase {implementations}{{
1341 public constructor(_dummy: null, ptr: bigint) {{
1346 self.obj_defined([hu_name], "structs")
1347 return out_opaque_struct_human
1349 def map_tuple(self, struct_name):
1350 return self.map_opaque_struct(struct_name, "A Tuple")
1352 def map_result(self, struct_name, res_map, err_map):
1353 human_ty = struct_name.replace("LDKCResult", "Result")
1355 suffixes = f"export class {human_ty}_OK extends {human_ty} {{\n"
1356 if res_map.java_hu_ty != "void":
1357 suffixes += "\tpublic res: " + res_map.java_hu_ty + ";\n"
1360 public constructor(_dummy: null, ptr: bigint) {{
1363 if res_map.java_hu_ty == "void":
1365 elif res_map.to_hu_conv is not None:
1366 suffixes += "\t\tconst res: " + res_map.java_ty + " = bindings." + struct_name.replace("LDK", "") + "_get_ok(ptr);\n"
1367 suffixes += "\t\t" + res_map.to_hu_conv.replace("\n", "\n\t\t")
1368 suffixes += "\n\t\tthis.res = " + res_map.to_hu_conv_name + ";\n"
1370 suffixes += "\t\tthis.res = bindings." + struct_name.replace("LDK", "") + "_get_ok(ptr);\n"
1371 suffixes += "\t}\n}\n"
1373 suffixes += f"export class {human_ty}_Err extends {human_ty} {{\n"
1374 if err_map.java_hu_ty != "void":
1375 suffixes += "\tpublic err: " + err_map.java_hu_ty + ";\n"
1378 public constructor(_dummy: null, ptr: bigint) {{
1381 if err_map.java_hu_ty == "void":
1383 elif err_map.to_hu_conv is not None:
1384 suffixes += "\t\tconst err: " + err_map.java_ty + " = bindings." + struct_name.replace("LDK", "") + "_get_err(ptr);\n"
1385 suffixes += "\t\t" + err_map.to_hu_conv.replace("\n", "\n\t\t")
1386 suffixes += "\n\t\tthis.err = " + err_map.to_hu_conv_name + ";\n"
1388 suffixes += "\t\tthis.err = bindings." + struct_name.replace("LDK", "") + "_get_err(ptr);\n"
1389 suffixes += "\t}\n}"
1391 self.struct_file_suffixes[human_ty] = suffixes
1392 self.obj_defined([human_ty], "structs")
1394 return f"""{self.hu_struct_file_prefix}
1396 export class {human_ty} extends CommonBase {{
1397 protected constructor(_dummy: null, ptr: bigint) {{
1398 super(ptr, bindings.{struct_name.replace("LDK","")}_free);
1401 public static constr_from_ptr(ptr: bigint): {human_ty} {{
1402 if (bindings.{struct_name.replace("LDK", "")}_is_ok(ptr)) {{
1403 return new {human_ty}_OK(null, ptr);
1405 return new {human_ty}_Err(null, ptr);
1410 def fn_call_body(self, method_name, return_c_ty, return_java_ty, method_argument_string, native_call_argument_string):
1411 has_return_value = return_c_ty != 'void'
1412 return_statement = 'return nativeResponseValue;'
1413 if not has_return_value:
1414 return_statement = '// debug statements here'
1416 return f"""/* @internal */
1417 export function {method_name}({method_argument_string}): {return_java_ty} {{
1418 if(!isWasmInitialized) {{
1419 throw new Error("initializeWasm() must be awaited first!");
1421 const nativeResponseValue = wasm.TS_{method_name}({native_call_argument_string});
1425 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):
1428 out_java_struct = None
1431 out_c += (self.c_fn_ty_pfx)
1432 out_c += (return_type_info.c_ty)
1433 out_java += (return_type_info.java_ty)
1434 if return_type_info.ret_conv is not None:
1435 ret_conv_pfx, ret_conv_sfx = return_type_info.ret_conv
1436 out_java += (" " + method_name + "(")
1437 out_c += (" " + self.c_fn_name_define_pfx(method_name, True))
1439 method_argument_string = ""
1440 native_call_argument_string = ""
1441 for idx, arg_conv_info in enumerate(argument_types):
1443 method_argument_string += (", ")
1444 native_call_argument_string += ', '
1446 if arg_conv_info.c_ty != "void":
1447 out_c += (arg_conv_info.c_ty + " " + arg_conv_info.arg_name)
1448 method_argument_string += f"{arg_conv_info.arg_name}: {arg_conv_info.java_ty}"
1449 native_call_argument_string += arg_conv_info.arg_name
1450 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)
1452 out_java_struct = ""
1453 if doc_comment is not None:
1454 out_java_struct = "\t/**\n\t * " + doc_comment.replace("\n", "\n\t * ") + "\n\t */\n"
1457 out_java_struct += ("\t// Skipped " + method_name + "\n")
1460 out_java_struct += (
1461 "\tpublic static constructor_" + meth_n + "(")
1463 out_java_struct += ("\tpublic " + meth_n + "(")
1464 for idx, arg in enumerate(argument_types):
1466 if not takes_self or idx > 1:
1467 out_java_struct += (", ")
1470 if arg.java_ty != "void":
1471 if arg.arg_name in default_constructor_args:
1472 for explode_idx, explode_arg in enumerate(default_constructor_args[arg.arg_name]):
1473 if explode_idx != 0:
1474 out_java_struct += (", ")
1475 out_java_struct += arg.arg_name + "_" + explode_arg.arg_name + ": " + explode_arg.java_hu_ty
1477 out_java_struct += arg.arg_name + ": " + arg.java_hu_ty
1479 out_java_struct += "|null"
1482 if out_java_struct is not None:
1483 out_java_struct += "): " + return_type_info.java_hu_ty + " {\n"
1484 for info in argument_types:
1485 if info.arg_conv is not None:
1486 out_c += ("\t" + info.arg_conv.replace('\n', "\n\t") + "\n")
1487 if return_type_info.ret_conv is not None:
1488 out_c += ("\t" + ret_conv_pfx.replace('\n', '\n\t'))
1489 elif return_type_info.c_ty != "void":
1490 out_c += ("\t" + return_type_info.c_ty + " ret_val = ")
1493 if c_call_string is None:
1494 out_c += (method_name + "(")
1496 out_c += (c_call_string)
1497 for idx, info in enumerate(argument_types):
1498 if info.arg_conv_name is not None:
1501 elif c_call_string is not None:
1503 out_c += (info.arg_conv_name)
1505 if return_type_info.ret_conv is not None:
1506 out_c += (ret_conv_sfx.replace('\n', '\n\t'))
1509 for info in argument_types:
1510 if info.arg_conv_cleanup is not None:
1511 out_c += ("\n\t" + info.arg_conv_cleanup.replace("\n", "\n\t"))
1512 if return_type_info.ret_conv is not None:
1513 out_c += ("\n\treturn " + return_type_info.ret_conv_name + ";")
1514 elif return_type_info.c_ty != "void":
1515 out_c += ("\n\treturn ret_val;")
1516 out_c += ("\n}\n\n")
1519 out_java_struct += ("\t\t")
1520 if return_type_info.java_ty != "void":
1521 out_java_struct += "const ret: " + return_type_info.java_ty + " = "
1522 out_java_struct += ("bindings." + method_name + "(")
1523 for idx, info in enumerate(argument_types):
1525 out_java_struct += (", ")
1526 if idx == 0 and takes_self:
1527 out_java_struct += ("this.ptr")
1528 elif info.arg_name in default_constructor_args:
1529 out_java_struct += ("bindings." + info.java_hu_ty + "_new(")
1530 for explode_idx, explode_arg in enumerate(default_constructor_args[info.arg_name]):
1531 if explode_idx != 0:
1532 out_java_struct += (", ")
1533 expl_arg_name = info.arg_name + "_" + explode_arg.arg_name
1534 if explode_arg.from_hu_conv is not None:
1535 out_java_struct += (
1536 explode_arg.from_hu_conv[0].replace(explode_arg.arg_name, expl_arg_name))
1538 out_java_struct += (expl_arg_name)
1539 out_java_struct += (")")
1540 elif info.from_hu_conv is not None:
1541 out_java_struct += (info.from_hu_conv[0])
1543 out_java_struct += (info.arg_name)
1544 out_java_struct += (");\n")
1545 if return_type_info.to_hu_conv is not None:
1547 out_java_struct += ("\t\t" + return_type_info.to_hu_conv.replace("\n", "\n\t\t").replace("this",
1548 return_type_info.to_hu_conv_name) + "\n")
1550 out_java_struct += ("\t\t" + return_type_info.to_hu_conv.replace("\n", "\n\t\t") + "\n")
1552 for idx, info in enumerate(argument_types):
1553 if idx == 0 and takes_self:
1555 elif info.arg_name in default_constructor_args:
1556 for explode_arg in default_constructor_args[info.arg_name]:
1557 expl_arg_name = info.arg_name + "_" + explode_arg.arg_name
1558 if explode_arg.from_hu_conv is not None and return_type_info.to_hu_conv_name:
1559 out_java_struct += ("\t\t" + explode_arg.from_hu_conv[1].replace(explode_arg.arg_name,
1560 expl_arg_name).replace(
1561 "this", return_type_info.to_hu_conv_name) + ";\n")
1562 elif info.from_hu_conv is not None and info.from_hu_conv[1] != "":
1563 if not takes_self and return_type_info.to_hu_conv_name is not None:
1564 out_java_struct += (
1565 "\t\t" + info.from_hu_conv[1].replace("this", return_type_info.to_hu_conv_name).replace("\n", "\n\t\t") + ";\n")
1567 out_java_struct += ("\t\t" + info.from_hu_conv[1].replace("\n", "\n\t\t") + ";\n")
1569 if return_type_info.to_hu_conv_name is not None:
1570 out_java_struct += ("\t\treturn " + return_type_info.to_hu_conv_name + ";\n")
1571 elif return_type_info.java_ty != "void" and return_type_info.rust_obj != "LDK" + struct_meth:
1572 out_java_struct += ("\t\treturn ret;\n")
1573 out_java_struct += ("\t}\n\n")
1575 return (out_java, out_c, out_java_struct)
1578 for struct in self.struct_file_suffixes:
1579 with open(self.outdir + "/structs/" + struct + self.file_ext, "a") as src:
1580 src.write(self.struct_file_suffixes[struct])
1582 with open(self.outdir + "/bindings.mts", "a") as bindings:
1585 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) {
1586 const weak: WeakRef<object>|undefined = js_objs[obj_ptr];
1587 if (weak == null || weak == undefined) {
1588 console.error("Got function call on unknown/free'd JS object!");
1589 throw new Error("Got function call on unknown/free'd JS object!");
1591 const obj = weak.deref();
1592 if (obj == null || obj == undefined) {
1593 console.error("Got function call on GC'd JS object!");
1594 throw new Error("Got function call on GC'd JS object!");
1598 bindings.write("\tswitch (fn_id) {\n")
1599 for f in self.function_ptrs:
1600 bindings.write(f"\t\tcase {str(f)}: fn = Object.getOwnPropertyDescriptor(obj, \"{self.function_ptrs[f][1]}\"); break;\n")
1602 bindings.write("""\t\tdefault:
1603 console.error("Got unknown function call from C!");
1604 throw new Error("Got unknown function call from C!");
1606 if (fn == null || fn == undefined) {
1607 console.error("Got function call on incorrect JS object!");
1608 throw new Error("Got function call on incorrect JS object!");
1610 const ret = fn.value.bind(obj)(arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8, arg9, arg10);
1611 if (ret === undefined || ret === null) return BigInt(0);