@knuth/js-wasm 2.11.0 → 4.0.0

package/types/wasm/glue_manual.d.ts

@@ -1,3 +1,7 @@
+// Copyright (c) 2016-present Knuth Project developers.
+// Distributed under the MIT software license, see the accompanying
+// file COPYING or http://www.opensource.org/licenses/mit-license.php.
+
 declare const _RuleForkEnumNativeKeyToInt: {
     readonly no_rules: 0;
     readonly easy_blocks: number;

package/types/wasm/loadLib.d.ts

@@ -1,3 +1,7 @@
+// Copyright (c) 2016-present Knuth Project developers.
+// Distributed under the MIT software license, see the accompanying
+// file COPYING or http://www.opensource.org/licenses/mit-license.php.
+
 export interface LoadWasmModuleExt {
     __resolveFilePaths: () => void;
 }

package/types/wasm/manualGeneratedTypes.d.ts

@@ -1,3 +1,7 @@
+// Copyright (c) 2016-present Knuth Project developers.
+// Distributed under the MIT software license, see the accompanying
+// file COPYING or http://www.opensource.org/licenses/mit-license.php.
+
 import Klass from '../../tools/wasm-generator/src/klass';
 import Enum from '../../tools/wasm-generator/src/enum';
 import Typedef from '../../tools/wasm-generator/src/typedef';

package/types/wasm/mem.d.ts

@@ -1,3 +1,7 @@
+// Copyright (c) 2016-present Knuth Project developers.
+// Distributed under the MIT software license, see the accompanying
+// file COPYING or http://www.opensource.org/licenses/mit-license.php.
+
 declare const custom_malloc_sym: unique symbol;
 type AnyTypedArrayConstructor = Int8ArrayConstructor | Uint8ArrayConstructor | Uint8ClampedArrayConstructor | Int16ArrayConstructor | Uint16ArrayConstructor | Int32ArrayConstructor | Uint32ArrayConstructor | Float32ArrayConstructor | Float64ArrayConstructor;
 interface CustomAllocatedArray {
@@ -10,4 +14,32 @@ declare function free(objOrPtr: any): void;
 declare function readUint32(ptr: number): number;
 declare function setUint8Array(encoded: Uint8Array, encodedPtr: number): void;
 declare function subarray(ptr: number, size: number): Uint8Array<ArrayBufferLike>;
-export { malloc, free, buffer, readUint32, setUint8Array, subarray };
+/** Copy a malloc-owned native byte buffer and release it. */
+declare function copyAndFreeByteArray(ptr: number, size: number): Uint8Array<ArrayBuffer>;
+/** Allocate a zero-filled 4-byte slot for a native out parameter (size_t / pointer / status on wasm32). */
+declare function allocZeroedSlot(): number;
+/**
+ * Copy an owned native byte buffer into a fresh Uint8Array and release it with
+ * the C function the API documents for it (or only copy it when `release` is omitted). The size slot is read and freed and
+ * the native buffer released on every path, including errors.
+ */
+declare function takeByteArray(ptr: number, sizePtr: number, release?: (ptr: number) => void): Uint8Array<ArrayBuffer>;
+/** An input byte array must be a non-null Uint8Array (checked before any buffer is allocated). */
+declare function checkBytes(value: unknown, name: string): asserts value is Uint8Array;
+/** A fixed-size value struct passed as bytes: exactly `size` bytes, because the C function takes no length. */
+declare function checkFixedBytes(value: unknown, name: string, size: number): asserts value is Uint8Array;
+/** Copy `size` bytes out of native memory. */
+declare function readBytes(ptr: number, size: number): Uint8Array;
+/**
+ * Allocate a native buffer for an input byte array. An empty array still gets a valid 1-byte buffer
+ * (the C API receives a real pointer with length 0), and allocation failure throws here, before anything
+ * is copied to address 0 or the FFI is entered.
+ */
+declare function allocBytesBuffer(length: number): number;
+/** An 8/16/32-bit integer parameter wraps (or truncates a fraction) silently in the ABI: refuse values outside its range. */
+declare function checkInt(value: number, name: string, min: number, max: number): void;
+/** A wasm i64 parameter wraps modulo 2^64: reject anything outside the unsigned 64-bit range instead. */
+declare function checkU64(value: bigint, name: string): void;
+/** Signed counterpart of checkU64. */
+declare function checkI64(value: bigint, name: string): void;
+export { checkInt, checkBytes, checkFixedBytes, readBytes, allocBytesBuffer, checkU64, checkI64, malloc, free, buffer, copyAndFreeByteArray, readUint32, setUint8Array, subarray, allocZeroedSlot, takeByteArray };

package/types/wasm/promises.d.ts

@@ -1,3 +1,7 @@
+// Copyright (c) 2016-present Knuth Project developers.
+// Distributed under the MIT software license, see the accompanying
+// file COPYING or http://www.opensource.org/licenses/mit-license.php.
+
 type GenericPromise<T> = {
     getId: () => number;
     extractPtr?: () => T;

package/types/wasm/stack.d.ts

@@ -1,2 +1,8 @@
+// Copyright (c) 2016-present Knuth Project developers.
+// Distributed under the MIT software license, see the accompanying
+// file COPYING or http://www.opensource.org/licenses/mit-license.php.
+
 export declare function clearStack(): void;
+/** Reject anything that cannot be passed as a C string: non-strings and text with an embedded NUL (it would be truncated silently). */
+export declare function checkCString(value: string, name?: string): void;
 export declare function allocateUTF8String(value: string): number;

package/types/wasm/string.d.ts

@@ -1,2 +1,15 @@
+// Copyright (c) 2016-present Knuth Project developers.
+// Distributed under the MIT software license, see the accompanying
+// file COPYING or http://www.opensource.org/licenses/mit-license.php.
+
 export declare function UTF8ToString(ptr: number, size?: number): string;
+/** Copy a malloc-owned C string into JavaScript and release the native buffer. */
+export declare function consumeUTF8String(ptr: number, size?: number): string;
+/**
+ * Copy a native C string into JavaScript, then release it with the C function
+ * the API documents for it (e.g. `kth_core_destruct_string`). A null pointer
+ * yields an empty string and nothing is released. The release runs even when
+ * decoding throws.
+ */
+export declare function takeUTF8String(ptr: number, release: (ptr: number) => void): string;
 export declare function StringToUTF8(str: string, ptr: number, maxSize: number): number;

package/types/wasm/glue copy.d.ts

@@ -1,230 +0,0 @@
-declare const ptrSym: unique symbol;
-declare const _CurrencyIntToKey: readonly ["bitcoin", "bitcoin_cash", "litecoin"];
-export declare type Currency = (typeof _CurrencyIntToKey)[number];
-declare const _LogLibraryIntToKey: readonly ["boost", "spdlog", "binlog"];
-export declare type LogLibrary = (typeof _LogLibraryIntToKey)[number];
-export declare class LibConfigTypeSizes {
-    private readonly [ptrSym];
-    static _create(ptr: number): LibConfigTypeSizes;
-    get size_int(): number;
-    get size_long(): number;
-    get size_pointer(): number;
-    protected _destructor(): void;
-}
-export declare class LibConfig {
-    private readonly [ptrSym];
-    static _create(ptr: number): LibConfig;
-    get log_library(): LogLibrary;
-    get use_libmdbx(): boolean;
-    get version(): string;
-    get microarchitecture_id(): string;
-    get currency(): Currency;
-    get mempool(): boolean;
-    get db_readonly(): boolean;
-    get debug_mode(): boolean;
-    get architecture(): string;
-    get os_name(): string;
-    get compiler_name(): string;
-    get compiler_version(): string;
-    get optimization_level(): string;
-    get build_timestamp(): number;
-    get endianness(): string;
-    get type_sizes(): LibConfigTypeSizes;
-    protected _destructor(): void;
-    static getLibconfig(): LibConfig;
-    static getEmscriptenVersionMajor(): number;
-    static getEmscriptenVersionMinor(): number;
-    static getEmscriptenVersionTiny(): number;
-    static getBuildTimestamp(): number;
-}
-export declare class StringListNative {
-    private readonly [ptrSym];
-    static _create(ptr: number): StringListNative;
-    protected _destructor(): void;
-    constructor();
-    pushBack(string: string): void;
-}
-export declare class ShortHashNative {
-    private readonly [ptrSym];
-    static _create(ptr: number): ShortHashNative;
-    get hash(): number;
-    protected _destructor(): void;
-}
-export declare class HashNative {
-    private readonly [ptrSym];
-    static _create(ptr: number): HashNative;
-    get hash(): number;
-    protected _destructor(): void;
-}
-export declare class LongHashNative {
-    private readonly [ptrSym];
-    static _create(ptr: number): LongHashNative;
-    get hash(): number;
-    protected _destructor(): void;
-}
-export declare class HdChainCodeNative {
-    private readonly [ptrSym];
-    static _create(ptr: number): HdChainCodeNative;
-    get data(): number;
-    protected _destructor(): void;
-}
-export declare class HdKeyNative {
-    private readonly [ptrSym];
-    static _create(ptr: number): HdKeyNative;
-    get data(): number;
-    protected _destructor(): void;
-}
-export declare class EcCompressedNative {
-    private readonly [ptrSym];
-    static _create(ptr: number): EcCompressedNative;
-    get data(): number;
-    protected _destructor(): void;
-}
-export declare class EcUncompressedNative {
-    private readonly [ptrSym];
-    static _create(ptr: number): EcUncompressedNative;
-    get data(): number;
-    protected _destructor(): void;
-}
-export declare class EcSecretNative {
-    private readonly [ptrSym];
-    static _create(ptr: number): EcSecretNative;
-    get hash(): number;
-    protected _destructor(): void;
-}
-export declare class WifUncompressedNative {
-    private readonly [ptrSym];
-    static _create(ptr: number): WifUncompressedNative;
-    get data(): number;
-    protected _destructor(): void;
-}
-export declare class WifCompressedNative {
-    private readonly [ptrSym];
-    static _create(ptr: number): WifCompressedNative;
-    get data(): number;
-    protected _destructor(): void;
-}
-export declare class HdLineageNative {
-    private readonly [ptrSym];
-    static _create(ptr: number): HdLineageNative;
-    get prefixes(): bigint;
-    get depth(): number;
-    get parent_fingerprint(): number;
-    get child_number(): number;
-    protected _destructor(): void;
-}
-export declare class EllipticCurveNative {
-    static secretToPublic(out: EcCompressedNative, secret: EcSecretNative): boolean;
-}
-export declare class HdPublicNative {
-    private readonly [ptrSym];
-    static _create(ptr: number): HdPublicNative;
-    protected _destructor(): void;
-    constructor();
-    isValid(): boolean;
-    encoded(): string;
-    chainCode(): HdChainCodeNative;
-    lineage(): HdLineageNative;
-    point(): EcCompressedNative;
-    toHdKey(): HdKeyNative;
-    derivePublic(index: number): HdPublicNative;
-}
-export declare class HdPrivateNative {
-    private readonly [ptrSym];
-    static _create(ptr: number): HdPrivateNative;
-    protected _destructor(): void;
-    constructor();
-    constructor(encoded: string);
-    constructor(seed: number, size: number, prefixes: bigint);
-    isValid(): boolean;
-    encoded(): string;
-    secret(): EcSecretNative;
-    chainCode(): HdChainCodeNative;
-    lineage(): HdLineageNative;
-    point(): EcCompressedNative;
-    toHdKeyNative(): HdKeyNative;
-    toPublic(): HdPublicNative;
-    derivePrivate(index: number): HdPrivateNative;
-    derivePublic(index: number): HdPublicNative;
-}
-export declare class PaymentAddressNative {
-    private readonly [ptrSym];
-    static _create(ptr: number): PaymentAddressNative;
-    protected _destructor(): void;
-    constructor(address: string);
-    constructor(hash: ShortHashNative, version: number);
-    encodedLegacy(): string;
-    encodedCashaddr(tokenAware: boolean): string;
-    hash20(): ShortHashNative;
-    hash32(): HashNative;
-    version(): number;
-    isValid(): boolean;
-}
-export declare class EcPrivateNative {
-    private readonly [ptrSym];
-    static _create(ptr: number): EcPrivateNative;
-    protected _destructor(): void;
-    constructor();
-    constructor(wif: string, version: number);
-    constructor(wif: WifCompressedNative, version: number);
-    constructor(wif: WifUncompressedNative, version: number);
-    constructor(secret: EcSecretNative, version: number, compress: boolean);
-    isValid(): boolean;
-    encoded(): string;
-    secret(): EcSecretNative;
-    version(): number;
-    paymentVersion(): number;
-    wifVersion(): number;
-    compressed(): boolean;
-    toPublic(): EcPublicNative;
-    toPaymentAddress(): PaymentAddressNative;
-}
-export declare class EcPublicNative {
-    private readonly [ptrSym];
-    static _create(ptr: number): EcPublicNative;
-    protected _destructor(): void;
-    constructor();
-    constructor(base16: string);
-    constructor(secret: EcPrivateNative);
-    constructor(point: EcCompressedNative, compress: boolean);
-    isValid(): boolean;
-    encoded(): string;
-    point(): EcCompressedNative;
-    compressed(): boolean;
-    toUncompressed(outData: EcUncompressedNative): boolean;
-    toPaymentAddress(version: number): PaymentAddressNative;
-}
-export declare class WalletNative {
-    static mnemonicsToSeed(mnemonics: StringListNative): LongHashNative;
-    static hdNew(seed: LongHashNative, version: number): HdPrivateNative;
-    static hdPrivateToEc(key: HdPrivateNative): EcSecretNative;
-    static ecToPublic(secret: EcSecretNative, uncompressed: boolean): EcPublicNative;
-    static ecToAddress(point: EcPublicNative, version: number): PaymentAddressNative;
-}
-export declare class NodeInfoNative {
-    static printThreadId(): void;
-    static getThreadId(): bigint;
-    static capiVersion(): string;
-    static cppapiVersion(): string;
-    static microarchitecture(): string;
-    static marchNames(): string;
-    static currencySymbol(): string;
-    static currency(): string;
-    static cppapiBuildTimestamp(): number;
-}
-export declare class ScriptNative {
-    private readonly [ptrSym];
-    static _create(ptr: number): ScriptNative;
-    protected _destructor(): void;
-    constructor();
-    constructor(encoded: Uint8Array, prefix: boolean);
-    isValid(): boolean;
-    isValidOperations(): boolean;
-    satoshiContentSize(): number;
-    serializedSize(prefix: boolean): number;
-    toStr(activeForks: number): string;
-    type(): string;
-    toData(prefix: boolean): Uint8Array;
-    sigops(embedded: boolean): number;
-}
-export {};