X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;ds=sidebyside;f=typescript_strings.py;h=6eb5a10a186f9fb7cde4d2d3933363d97ccc69ed;hb=217905ac31a6b4113778afc4231ae591f7a626f2;hp=c0a0cccbf0ed816764fb3a285cf6dae2620400ba;hpb=0153d62d70625da99f4539fd869fabc59c58c575;p=ldk-java diff --git a/typescript_strings.py b/typescript_strings.py index c0a0cccb..6eb5a10a 100644 --- a/typescript_strings.py +++ b/typescript_strings.py @@ -36,22 +36,27 @@ class Consts: self.bindings_header = """ import * as version from './version.mjs'; +import { UInt5, WitnessVersion } from './structs/CommonBase.mjs'; const imports: any = {}; imports.env = {}; var js_objs: Array> = []; var js_invoke: Function; +var getRandomValues: Function; imports.wasi_snapshot_preview1 = { - "fd_write": (fd: number, iovec_array_ptr: number, iovec_array_len: number) => { + "fd_write": (fd: number, iovec_array_ptr: number, iovec_array_len: number, bytes_written_ptr: number) => { // This should generally only be used to print panic messages - console.log("FD_WRITE to " + fd + " in " + iovec_array_len + " chunks."); const ptr_len_view = new Uint32Array(wasm.memory.buffer, iovec_array_ptr, iovec_array_len * 2); + var bytes_written = 0; for (var i = 0; i < iovec_array_len; i++) { const bytes_view = new Uint8Array(wasm.memory.buffer, ptr_len_view[i*2], ptr_len_view[i*2+1]); - console.log(String.fromCharCode(...bytes_view)); + console.log("[fd " + fd + "]: " + String.fromCharCode(...bytes_view)); + bytes_written += ptr_len_view[i*2+1]; } + const written_view = new Uint32Array(wasm.memory.buffer, bytes_written_ptr, 1); + written_view[0] = bytes_written; return 0; }, "fd_close": (_fd: number) => { @@ -66,12 +71,11 @@ imports.wasi_snapshot_preview1 = { }, "random_get": (buf_ptr: number, buf_len: number) => { const buf = new Uint8Array(wasm.memory.buffer, buf_ptr, buf_len); - crypto.getRandomValues(buf); + getRandomValues(buf); return 0; }, "environ_sizes_get": (environ_var_count_ptr: number, environ_len_ptr: number) => { // This is called before fd_write to format + print panic messages - console.log("wasi_snapshot_preview1:environ_sizes_get"); const out_count_view = new Uint32Array(wasm.memory.buffer, environ_var_count_ptr, 1); out_count_view[0] = 0; const out_len_view = new Uint32Array(wasm.memory.buffer, environ_len_ptr, 1); @@ -79,7 +83,8 @@ imports.wasi_snapshot_preview1 = { return 0; }, "environ_get": (environ_ptr: number, environ_buf_ptr: number) => { - // This is called before fd_write to format + print panic messages + // This is called before fd_write to format + print panic messages, + // but only if we have variables in environ_sizes_get, so shouldn't ever actually happen! console.log("wasi_snapshot_preview1:environ_get"); return 58; // Note supported - we said there were 0 environment entries! }, @@ -90,32 +95,22 @@ imports.wasi_snapshot_preview1 = { var wasm: any = null; let isWasmInitialized: boolean = false; -""" - if target == Target.NODEJS: - self.bindings_header += """import * as fs from 'fs'; -import { webcrypto as crypto } from 'crypto'; -/* @internal */ -export async function initializeWasm(path: string) { - const source = fs.readFileSync(path); - imports.env["js_invoke_function"] = js_invoke; - const { instance: wasmInstance } = await WebAssembly.instantiate(source, imports);""" - else: - self.bindings_header += """ -/* @internal */ -export async function initializeWasm(uri: string) { - const stream = fetch(uri); - imports.env["js_invoke_function"] = js_invoke; - const { instance: wasmInstance } = await WebAssembly.instantiateStreaming(stream, imports);""" +async function finishInitializeWasm(wasmInstance: WebAssembly.Instance) { + if (typeof crypto === "undefined") { + var crypto_import = (await import('crypto')).webcrypto; + getRandomValues = crypto_import.getRandomValues.bind(crypto_import); + } else { + getRandomValues = crypto.getRandomValues.bind(crypto); + } - self.bindings_header += """ wasm = wasmInstance.exports; if (!wasm.test_bigint_pass_deadbeef0badf00d(BigInt("0xdeadbeef0badf00d"))) { throw new Error(\"Currently need BigInt-as-u64 support, try ----experimental-wasm-bigint"); } if (decodeString(wasm.TS_get_lib_version_string()) !== version.get_ldk_java_bindings_version()) - throw new Error(\"Compiled LDK library and LDK class failes do not match\"); + throw new Error(\"Compiled LDK library and LDK class files do not match\"); // Fetching the LDK versions from C also checks that the header and binaries match const c_bindings_ver: number = wasm.TS_get_ldk_c_bindings_version(); const ldk_ver: number = wasm.TS_get_ldk_version(); @@ -128,14 +123,48 @@ export async function initializeWasm(uri: string) { console.log(\"Loaded LDK-Java Bindings with LDK \" + ldk_version + \" and LDK-C-Bindings \" + c_bindings_version); isWasmInitialized = true; -}; +} + +/* @internal */ +export async function initializeWasmFromUint8Array(wasmBinary: Uint8Array) { + imports.env["js_invoke_function_u"] = js_invoke; + imports.env["js_invoke_function_b"] = js_invoke; + const { instance: wasmInstance } = await WebAssembly.instantiate(wasmBinary, imports); + await finishInitializeWasm(wasmInstance); +} + +/* @internal */ +export async function initializeWasmFetch(uri: string) { + const stream = fetch(uri); + imports.env["js_invoke_function_u"] = js_invoke; + imports.env["js_invoke_function_b"] = js_invoke; + const { instance: wasmInstance } = await WebAssembly.instantiateStreaming(stream, imports); + await finishInitializeWasm(wasmInstance); +}""" + self.bindings_header += """ // WASM CODEC -const nextMultipleOfFour = (value: number) => { - return Math.ceil(value / 4) * 4; +/* @internal */ +export function uint5ArrToBytes(inputArray: Array): Uint8Array { + const arr = new Uint8Array(inputArray.length); + for (var i = 0; i < inputArray.length; i++) { + arr[i] = inputArray[i].getVal(); + } + return arr; +} + +/* @internal */ +export function WitnessVersionArrToBytes(inputArray: Array): Uint8Array { + const arr = new Uint8Array(inputArray.length); + for (var i = 0; i < inputArray.length; i++) { + arr[i] = inputArray[i].getVal(); + } + return arr; } + + /* @internal */ export function encodeUint8Array (inputArray: Uint8Array): number { const cArrayPointer = wasm.TS_malloc(inputArray.length + 4); @@ -165,7 +194,7 @@ export function encodeUint64Array (inputArray: BigUint64Array|Array): nu /* @internal */ export function check_arr_len(arr: Uint8Array, len: number): Uint8Array { - if (arr.length != len) { throw new Error("Expected array of length " + len + "got " + arr.length); } + if (arr.length != len) { throw new Error("Expected array of length " + len + " got " + arr.length); } return arr; } @@ -202,7 +231,23 @@ const decodeUint32Array = (arrayPointer: number, free = true) => { } return actualArray; } - +/* @internal */ +export function decodeUint64Array (arrayPointer: number, free = true): bigint[] { + const arraySize = getArrayLength(arrayPointer); + const actualArrayViewer = new BigUint64Array( + wasm.memory.buffer, // value + arrayPointer + 4, // offset (ignoring length bytes) + arraySize // uint32 count + ); + // Clone the contents, TODO: In the future we should wrap the Viewer in a class that + // will free the underlying memory when it becomes unreachable instead of copying here. + const actualArray = new Array(arraySize); + for (var i = 0; i < arraySize; i++) actualArray[i] = actualArrayViewer[i]; + if (free) { + wasm.TS_free(arrayPointer); + } + return actualArray; +} export function freeWasmMemory(pointer: number) { wasm.TS_free(pointer); } @@ -212,6 +257,13 @@ export function getU32ArrayElem(arrayPointer: number, idx: number): number { return actualArrayViewer[idx]; } +/* @internal */ +export function getU8ArrayElem(arrayPointer: number, idx: number): number { + const actualArrayViewer = new Uint8Array(wasm.memory.buffer, arrayPointer + 4, idx + 1); + return actualArrayViewer[idx]; +} + + /* @internal */ export function encodeString(str: string): number { const charArray = new TextEncoder().encode(str); @@ -247,10 +299,16 @@ export function debugPrintRemainingAllocs() { self.bindings_header += "/* @internal */ export function debugPrintRemainingAllocs() { }\n" with open(outdir + "/index.mts", 'a') as index: - index.write("""import { initializeWasm as bindingsInit } from './bindings.mjs'; -export function initializeWasm(path: string) { - bindingsInit(path); + index.write("""import { initializeWasmFetch, initializeWasmFromUint8Array } from './bindings.mjs'; +/** Initializes the WASM backend by calling `fetch()` on the given URI - Browser only */ +export async function initializeWasmWebFetch(uri: string) { + await initializeWasmFetch(uri); } +/** Initializes the WASM backend given a Uint8Array of the .wasm binary file - Browser or Node.JS */ +export async function initializeWasmFromBinary(bin: Uint8Array) { + await initializeWasmFromUint8Array(bin); +} + """) self.bindings_version_file = """export function get_ldk_java_bindings_version(): String { @@ -268,7 +326,7 @@ function get_freeer(ptr: number, free_fn: (ptr: number) => void) { } } -export default class CommonBase { +export class CommonBase { protected ptr: number; protected ptrs_to: object[] = []; protected constructor(ptr: number, free_fn: (ptr: number) => void) { @@ -291,6 +349,28 @@ export default class CommonBase { finalizer.unregister(o); } } + +export class UInt5 { + public constructor(private val: number) { + if (val > 32 || val < 0) throw new Error("UInt5 value is out of range"); + } + public getVal(): number { + return this.val; + } +} + +export class WitnessVersion { + public constructor(private val: number) { + if (val > 16 || val < 0) throw new Error("WitnessVersion value is out of range"); + } + public getVal(): number { + return this.val; + } +} + +export class UnqualifiedError { + public constructor(val: number) {} +} """ self.txout_defn = """export class TxOut extends CommonBase { @@ -557,7 +637,7 @@ jstring __attribute__((export_name("TS_get_ldk_version"))) get_ldk_version() { }""" self.hu_struct_file_prefix = """ -import CommonBase from './CommonBase.mjs'; +import { CommonBase, UInt5, WitnessVersion, UnqualifiedError } from './CommonBase.mjs'; import * as bindings from '../bindings.mjs' """ @@ -576,7 +656,7 @@ import * as bindings from '../bindings.mjs' return None def create_native_arr_call(self, arr_len, ty_info): if ty_info.c_ty == "ptrArray": - assert ty_info.subty is not None and ty_info.subty.c_ty.endswith("Array") + assert ty_info.rust_obj == "LDKCVec_u5Z" or (ty_info.subty is not None and ty_info.subty.c_ty.endswith("Array")) return "init_" + ty_info.c_ty + "(" + arr_len + ", __LINE__)" def set_native_arr_contents(self, arr_name, arr_len, ty_info): if ty_info.c_ty == "int8_tArray": @@ -587,11 +667,11 @@ import * as bindings from '../bindings.mjs' if ty_info.c_ty == "int8_tArray": if copy: return "memcpy(" + dest_name + ", " + arr_name + "->elems, " + arr_len + "); FREE(" + arr_name + ")" + assert not copy if ty_info.c_ty == "ptrArray": - return "(void*) " + arr_name + "->elems /* XXX " + arr_name + " leaks */" + return "(void*) " + arr_name + "->elems" else: - assert not copy - return arr_name + "->elems /* XXX " + arr_name + " leaks */" + return arr_name + "->elems" def get_native_arr_elem(self, arr_name, idxc, ty_info): assert False # Only called if above is None def get_native_arr_ptr_call(self, ty_info): @@ -602,11 +682,13 @@ import * as bindings from '../bindings.mjs' return None def cleanup_native_arr_ref_contents(self, arr_name, dest_name, arr_len, ty_info): if ty_info.c_ty == "int8_tArray": - return None + return "FREE(" + arr_name + ");" else: - return None + return "FREE(" + arr_name + ")" def map_hu_array_elems(self, arr_name, conv_name, arr_ty, elem_ty): + if elem_ty.rust_obj == "LDKu5": + return arr_name + " != null ? bindings.uint5ArrToBytes(" + arr_name + ") : null" assert elem_ty.c_ty == "uint32_t" or elem_ty.c_ty.endswith("Array") return arr_name + " != null ? " + arr_name + ".map(" + conv_name + " => " + elem_ty.from_hu_conv[0] + ") : null" @@ -630,6 +712,8 @@ import * as bindings from '../bindings.mjs' def get_java_arr_elem(self, elem_ty, arr_name, idx): if elem_ty.c_ty == "uint32_t" or elem_ty.c_ty == "uintptr_t" or elem_ty.c_ty.endswith("Array"): return "bindings.getU32ArrayElem(" + arr_name + ", " + idx + ")" + elif elem_ty.rust_obj == "LDKu5": + return "bindings.getU8ArrayElem(" + arr_name + ", " + idx + ")" else: assert False def constr_hu_array(self, ty_info, arr_len): @@ -655,8 +739,12 @@ import * as bindings from '../bindings.mjs' assert False def primitive_arr_to_hu(self, mapped_ty, fixed_len, arr_name, conv_name): - assert mapped_ty.c_ty == "uint8_t" or mapped_ty.c_ty == "int8_t" - return "const " + conv_name + ": Uint8Array = bindings.decodeUint8Array(" + arr_name + ");" + if mapped_ty.c_ty == "uint8_t" or mapped_ty.c_ty == "int8_t": + return "const " + conv_name + ": Uint8Array = bindings.decodeUint8Array(" + arr_name + ");" + elif mapped_ty.c_ty == "uint64_t" or mapped_ty.c_ty == "int64_t": + return "const " + conv_name + ": bigint[] = bindings.decodeUint64Array(" + arr_name + ");" + else: + assert False def var_decl_statement(self, ty_string, var_name, statement): return "const " + var_name + ": " + ty_string + " = " + statement @@ -683,6 +771,9 @@ import * as bindings from '../bindings.mjs' with open(self.outdir + "/imports.mts.part", 'a') as imports: imports.write(f"import {{ {', '.join(struct_names)} }} from '../{folder}/{struct_names[0]}.mjs';\n") + def fully_qualified_hu_ty_path(self, ty): + return ty.java_hu_ty + def native_c_unitary_enum_map(self, struct_name, variants, enum_doc_comment): out_c = "static inline LDK" + struct_name + " LDK" + struct_name + "_from_js(int32_t ord) {\n" out_c = out_c + "\tswitch (ord) {\n" @@ -711,8 +802,12 @@ import * as bindings from '../bindings.mjs' out_c = out_c + "\t}\n" out_c = out_c + "}\n" + # Note that this is *not* marked /* @internal */ as we re-expose it directly in enums/ + enum_comment_formatted = enum_doc_comment.replace("\n", "\n * ") out_typescript = f""" -/* @internal */ +/** + * {enum_comment_formatted} + */ export enum {struct_name} {{ {out_typescript_enum_fields} }} @@ -935,17 +1030,27 @@ export class {struct_name.replace("LDK","")} extends CommonBase {{ out_c = out_c + arg_info.arg_name out_c = out_c + arg_info.ret_conv[1].replace('\n', '\n\t') + "\n" + fn_suffix = "" + if fn_line.ret_ty_info.c_ty == "uint64_t" or fn_line.ret_ty_info.c_ty == "int64_t": + fn_suffix += "b_" + else: + fn_suffix += "u_" + for arg in fn_line.args_ty: + if arg_info.c_ty == "uint64_t" or arg_info.c_ty == "int64_t": + fn_suffix += "b" + else: + fn_suffix += "u" if fn_line.ret_ty_info.c_ty.endswith("Array"): out_c += "\t" + fn_line.ret_ty_info.c_ty + " ret = (" + fn_line.ret_ty_info.c_ty + ")" - out_c += "js_invoke_function_" + str(len(fn_line.args_ty)) + "(j_calls->instance_ptr, " + str(self.function_ptr_counter) + out_c += "js_invoke_function_" + fn_suffix + "(j_calls->instance_ptr, " + str(self.function_ptr_counter) elif fn_line.ret_ty_info.java_ty == "void": - out_c = out_c + "\tjs_invoke_function_" + str(len(fn_line.args_ty)) + "(j_calls->instance_ptr, " + str(self.function_ptr_counter) + out_c = out_c + "\tjs_invoke_function_" + fn_suffix + "(j_calls->instance_ptr, " + str(self.function_ptr_counter) elif fn_line.ret_ty_info.java_hu_ty == "string": - out_c = out_c + "\tjstring ret = (jstring)js_invoke_function_" + str(len(fn_line.args_ty)) + "(j_calls->instance_ptr, " + str(self.function_ptr_counter) + out_c += "\tjstring ret = (jstring)js_invoke_function_" + fn_suffix + "(j_calls->instance_ptr, " + str(self.function_ptr_counter) elif not fn_line.ret_ty_info.passed_as_ptr: - out_c = out_c + "\treturn js_invoke_function_" + str(len(fn_line.args_ty)) + "(j_calls->instance_ptr, " + str(self.function_ptr_counter) + out_c += "\treturn js_invoke_function_" + fn_suffix + "(j_calls->instance_ptr, " + str(self.function_ptr_counter) else: - out_c = out_c + "\tuint32_t ret = js_invoke_function_" + str(len(fn_line.args_ty)) + "(j_calls->instance_ptr, " + str(self.function_ptr_counter) + out_c += "\tuint32_t ret = js_invoke_function_" + fn_suffix + "(j_calls->instance_ptr, " + str(self.function_ptr_counter) self.function_ptrs[self.function_ptr_counter] = (struct_name, fn_line.fn_name) self.function_ptr_counter += 1 @@ -1043,7 +1148,10 @@ export class {struct_name.replace("LDK","")} extends CommonBase {{ return (out_typescript_bindings, out_typescript_human, out_c) def trait_struct_inc_refcnt(self, ty_info): - return "" + base_conv = "\nif (" + ty_info.var_name + "_conv.free == " + ty_info.rust_obj + "_JCalls_free) {\n" + base_conv = base_conv + "\t// If this_arg is a JCalls struct, then we need to increment the refcnt in it.\n" + base_conv = base_conv + "\t" + ty_info.rust_obj + "_JCalls_cloned(&" + ty_info.var_name + "_conv);\n}" + return base_conv def map_complex_enum(self, struct_name, variant_list, camel_to_snake, enum_doc_comment): bindings_type = struct_name.replace("LDK", "") @@ -1130,18 +1238,28 @@ export class {struct_name.replace("LDK","")} extends CommonBase {{ hu_name = struct_name.replace("LDKC2Tuple", "TwoTuple").replace("LDKC3Tuple", "ThreeTuple").replace("LDK", "") out_opaque_struct_human = f"{self.hu_struct_file_prefix}" - if struct_name.startswith("LDKLocked"): - out_opaque_struct_human += "/** XXX: DO NOT USE THIS - it remains locked until the GC runs (if that ever happens */" + constructor_body = "super(ptr, bindings." + struct_name.replace("LDK","") + "_free);" + extra_docs = "" + extra_body = "" + if struct_name.startswith("LDKLocked") or struct_name.startswith("LDKReadOnly"): + extra_docs = "\n * This type represents a lock and MUST BE MANUALLY FREE'd!" + constructor_body = 'super(ptr, () => { throw new Error("Locks must be manually freed with free()"); });' + extra_body = f""" + /** Releases this lock */ + public free() {{ + bindings.{struct_name.replace("LDK","")}_free(this.ptr); + CommonBase.set_null_skip_free(this); + }}""" formatted_doc_comment = struct_doc_comment.replace("\n", "\n * ") out_opaque_struct_human += f""" -/** +/**{extra_docs} * {formatted_doc_comment} */ export class {hu_name} extends CommonBase {implementations}{{ /* @internal */ public constructor(_dummy: object, ptr: number) {{ - super(ptr, bindings.{struct_name.replace("LDK","")}_free); - }} + {constructor_body} + }}{extra_body} """ self.obj_defined([hu_name], "structs") @@ -1381,7 +1499,7 @@ export function {method_name}({method_argument_string}): {return_java_ty} {{ with open(self.outdir + "/bindings.mts", "a") as bindings: bindings.write(""" -js_invoke = function(obj_ptr: number, fn_id: number, arg1: number, arg2: number, arg3: number, arg4: number, arg5: number, arg6: number, arg7: number, arg8: number, arg9: number, arg10: number) { +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) { const weak: WeakRef = js_objs[obj_ptr]; if (weak == null || weak == undefined) { console.error("Got function call on unknown/free'd JS object!"); @@ -1406,5 +1524,7 @@ js_invoke = function(obj_ptr: number, fn_id: number, arg1: number, arg2: number, console.error("Got function call on incorrect JS object!"); throw new Error("Got function call on incorrect JS object!"); } - return fn.value.bind(obj)(arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8, arg9, arg10); + const ret = fn.value.bind(obj)(arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8, arg9, arg10); + if (ret === undefined || ret === null) return BigInt(0); + return BigInt(ret); }""")