[TS] Update auto-generated TypeScript Bindings
[ldk-java] / ts / structs / NodeId.mts
index 9b65a95efb0b866e03013cf8f6661bd3cedfed31..0148cab31e6d95dcf89bd75df36e55f22cef83b2 100644 (file)
@@ -281,6 +281,9 @@ import CommonBase from './CommonBase.mjs';
 import * as bindings from '../bindings.mjs'
 
 
+/**
+ * Represents the compressed public key of a node
+ */
 export class NodeId extends CommonBase {
        /* @internal */
        public constructor(_dummy: object, ptr: number) {
@@ -292,6 +295,9 @@ export class NodeId extends CommonBase {
                return ret;
        }
 
+       /**
+        * Creates a copy of the NodeId
+        */
        public clone(): NodeId {
                const ret: number = bindings.NodeId_clone(this.ptr);
                const ret_hu_conv: NodeId = new NodeId(null, ret);
@@ -299,6 +305,9 @@ export class NodeId extends CommonBase {
                return ret_hu_conv;
        }
 
+       /**
+        * Create a new NodeId from a public key
+        */
        public static constructor_from_pubkey(pubkey: Uint8Array): NodeId {
                const ret: number = bindings.NodeId_from_pubkey(bindings.encodeUint8Array(bindings.check_arr_len(pubkey, 33)));
                const ret_hu_conv: NodeId = new NodeId(null, ret);
@@ -306,23 +315,35 @@ export class NodeId extends CommonBase {
                return ret_hu_conv;
        }
 
+       /**
+        * Get the public key slice from this NodeId
+        */
        public as_slice(): Uint8Array {
                const ret: number = bindings.NodeId_as_slice(this.ptr);
                const ret_conv: Uint8Array = bindings.decodeUint8Array(ret);
                return ret_conv;
        }
 
+       /**
+        * Checks if two NodeIds contain equal inner contents.
+        */
        public hash(): bigint {
                const ret: bigint = bindings.NodeId_hash(this.ptr);
                return ret;
        }
 
+       /**
+        * Serialize the NodeId object into a byte array which can be read by NodeId_read
+        */
        public write(): Uint8Array {
                const ret: number = bindings.NodeId_write(this.ptr);
                const ret_conv: Uint8Array = bindings.decodeUint8Array(ret);
                return ret_conv;
        }
 
+       /**
+        * Read a NodeId from a byte array, created by NodeId_write
+        */
        public static constructor_read(ser: Uint8Array): Result_NodeIdDecodeErrorZ {
                const ret: number = bindings.NodeId_read(bindings.encodeUint8Array(ser));
                const ret_hu_conv: Result_NodeIdDecodeErrorZ = Result_NodeIdDecodeErrorZ.constr_from_ptr(ret);