lightningdevkit/structs/Nonce.mjs

Lightning Development Kit

import { Result_NonceDecodeErrorZ } from '../structs/Result_NonceDecodeErrorZ.mjs';
import { CommonBase } from './CommonBase.mjs';
import * as bindings from '../bindings.mjs';
/**
 * A 128-bit number used only once.
 *
 * Needed when constructing [`Offer::metadata`] and deriving [`Offer::issuer_signing_pubkey`] from
 * [`ExpandedKey`]. Must not be reused for any other derivation without first hashing.
 *
 * [`Offer::metadata`]: crate::offers::offer::Offer::metadata
 * [`Offer::issuer_signing_pubkey`]: crate::offers::offer::Offer::issuer_signing_pubkey
 * [`ExpandedKey`]: crate::ln::inbound_payment::ExpandedKey
 */
export class Nonce extends CommonBase {
    /* @internal */
    constructor(_dummy, ptr) {
        super(ptr, bindings.Nonce_free);
    }
    clone_ptr() {
        const ret = bindings.Nonce_clone_ptr(this.ptr);
        return ret;
    }
    /**
     * Creates a copy of the Nonce
     */
    clone() {
        const ret = bindings.Nonce_clone(this.ptr);
        const ret_hu_conv = new Nonce(null, ret);
        CommonBase.add_ref_from(ret_hu_conv, this);
        return ret_hu_conv;
    }
    /**
     * Checks if two Nonces contain equal inner contents.
     * This ignores pointers and is_owned flags and looks at the values in fields.
     * Two objects with NULL inner values will be considered "equal" here.
     */
    eq(b) {
        const ret = bindings.Nonce_eq(this.ptr, CommonBase.get_ptr_of(b));
        CommonBase.add_ref_from(this, b);
        return ret;
    }
    /**
     * Creates a `Nonce` from the given [`EntropySource`].
     */
    static constructor_from_entropy_source(entropy_source) {
        const ret = bindings.Nonce_from_entropy_source(CommonBase.get_ptr_of(entropy_source));
        const ret_hu_conv = new Nonce(null, ret);
        CommonBase.add_ref_from(ret_hu_conv, ret_hu_conv);
        CommonBase.add_ref_from(ret_hu_conv, entropy_source);
        return ret_hu_conv;
    }
    /**
     * Returns a slice of the underlying bytes of size [`Nonce::LENGTH`].
     */
    as_slice() {
        const ret = bindings.Nonce_as_slice(this.ptr);
        const ret_conv = bindings.decodeUint8Array(ret);
        return ret_conv;
    }
    /**
     * Serialize the Nonce object into a byte array which can be read by Nonce_read
     */
    write() {
        const ret = bindings.Nonce_write(this.ptr);
        const ret_conv = bindings.decodeUint8Array(ret);
        return ret_conv;
    }
    /**
     * Read a Nonce from a byte array, created by Nonce_write
     */
    static constructor_read(ser) {
        const ret = bindings.Nonce_read(bindings.encodeUint8Array(ser));
        const ret_hu_conv = Result_NonceDecodeErrorZ.constr_from_ptr(ret);
        return ret_hu_conv;
    }
}
//# sourceMappingURL=Nonce.mjs.map