[TS] Update auto-generated TypeScript Bindings
[ldk-java] / ts / structs / NodeAnnouncement.mts
index 5a5a2a993e129bea7bfbf16977d06ea58a484771..f4371dfeb77a9f7f593c3aa7792f36bce6c7837b 100644 (file)
@@ -281,22 +281,34 @@ import CommonBase from './CommonBase.mjs';
 import * as bindings from '../bindings.mjs'
 
 
+/**
+ * A node_announcement message to be sent or received from a peer
+ */
 export class NodeAnnouncement extends CommonBase {
        /* @internal */
        public constructor(_dummy: object, ptr: number) {
                super(ptr, bindings.NodeAnnouncement_free);
        }
 
+       /**
+        * The signature by the node key
+        */
        public get_signature(): Uint8Array {
                const ret: number = bindings.NodeAnnouncement_get_signature(this.ptr);
                const ret_conv: Uint8Array = bindings.decodeUint8Array(ret);
                return ret_conv;
        }
 
+       /**
+        * The signature by the node key
+        */
        public set_signature(val: Uint8Array): void {
                bindings.NodeAnnouncement_set_signature(this.ptr, bindings.encodeUint8Array(bindings.check_arr_len(val, 64)));
        }
 
+       /**
+        * The actual content of the announcement
+        */
        public get_contents(): UnsignedNodeAnnouncement {
                const ret: number = bindings.NodeAnnouncement_get_contents(this.ptr);
                const ret_hu_conv: UnsignedNodeAnnouncement = new UnsignedNodeAnnouncement(null, ret);
@@ -304,10 +316,16 @@ export class NodeAnnouncement extends CommonBase {
                return ret_hu_conv;
        }
 
+       /**
+        * The actual content of the announcement
+        */
        public set_contents(val: UnsignedNodeAnnouncement): void {
                bindings.NodeAnnouncement_set_contents(this.ptr, val == null ? 0 : CommonBase.get_ptr_of(val) & ~1);
        }
 
+       /**
+        * Constructs a new NodeAnnouncement given each field
+        */
        public static constructor_new(signature_arg: Uint8Array, contents_arg: UnsignedNodeAnnouncement): NodeAnnouncement {
                const ret: number = bindings.NodeAnnouncement_new(bindings.encodeUint8Array(bindings.check_arr_len(signature_arg, 64)), contents_arg == null ? 0 : CommonBase.get_ptr_of(contents_arg) & ~1);
                const ret_hu_conv: NodeAnnouncement = new NodeAnnouncement(null, ret);
@@ -320,6 +338,9 @@ export class NodeAnnouncement extends CommonBase {
                return ret;
        }
 
+       /**
+        * Creates a copy of the NodeAnnouncement
+        */
        public clone(): NodeAnnouncement {
                const ret: number = bindings.NodeAnnouncement_clone(this.ptr);
                const ret_hu_conv: NodeAnnouncement = new NodeAnnouncement(null, ret);
@@ -327,12 +348,18 @@ export class NodeAnnouncement extends CommonBase {
                return ret_hu_conv;
        }
 
+       /**
+        * Serialize the NodeAnnouncement object into a byte array which can be read by NodeAnnouncement_read
+        */
        public write(): Uint8Array {
                const ret: number = bindings.NodeAnnouncement_write(this.ptr);
                const ret_conv: Uint8Array = bindings.decodeUint8Array(ret);
                return ret_conv;
        }
 
+       /**
+        * Read a NodeAnnouncement from a byte array, created by NodeAnnouncement_write
+        */
        public static constructor_read(ser: Uint8Array): Result_NodeAnnouncementDecodeErrorZ {
                const ret: number = bindings.NodeAnnouncement_read(bindings.encodeUint8Array(ser));
                const ret_hu_conv: Result_NodeAnnouncementDecodeErrorZ = Result_NodeAnnouncementDecodeErrorZ.constr_from_ptr(ret);