navio-blsct/dist/scalar.js

TypeScript bindings for the `libblsct` library used by the [Navio](https://nav.io/) blockchain to construct confidential transactions based on the BLS12-381 curve.

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.Scalar = void 0;
const blsct_1 = require("./blsct");
const managedObj_1 = require("./managedObj");
/**
 * Represents an element of the finite field $\mathbb{F}_r$, where $r$ is the order of the generator point of the BLS12-381 G1 group.
 * A wrapper of [MclScalar](https://github.com/nav-io/navio-core/blob/master/src/blsct/arith/mcl/mcl_scalar.h) in navio-core.
 *
 * Examples:
 * ```ts
 * const { Scalar } = require('navio-blsct')
 * const s1 = new Scalar() // random scalar
 * const s2 = new Scalar(12345)
 * s2.toNumber() // returns 12345
 * const s3 = Scalar.deserialize(s2.serialize())
 * s3.equals(s2) // true
 * const ser = s1.serialize()
 * const deser = Scalar.deserialize(ser)
 * ser === deser.serialize() // true
 * ```
 */
class Scalar extends managedObj_1.ManagedObj {
    /** Constructs a new `Scalar` instance.
     * - If no parameter is provided, a random scalar is generated.
     * - If a number is provided, it is converted to a scalar.
     */
    constructor(obj) {
        if (typeof obj === 'object') {
            super(obj);
        }
        else if (typeof obj === 'number') {
            const rv = (0, blsct_1.genScalar)(obj);
            super(rv.value);
            (0, blsct_1.freeObj)(rv);
        }
        else if (obj === undefined || obj === null) {
            const rv = (0, blsct_1.genRandomScalar)();
            super(rv.value);
            (0, blsct_1.freeObj)(rv);
        }
        else {
            throw new TypeError(`Scalar constructor received value of unexpected type ${typeof obj}`);
        }
    }
    value() {
        return (0, blsct_1.castToScalar)(this.obj);
    }
    /**
     * Generates a random scalar.
     * @returns A random scalar in the finite field $\mathbb{F}_r$.
     */
    static random() {
        const rv = (0, blsct_1.genRandomScalar)();
        const x = Scalar.fromObj(rv.value);
        (0, blsct_1.freeObj)(rv);
        return x;
    }
    /** Converts the scalar to an integer.
     * * @returns The scalar as a number.
     */
    toNumber() {
        return (0, blsct_1.scalarToUint64)(this.value());
    }
    /** Returns if the scalar is equal to the provided scalar.
     * @param other - The scalar to compare with.
     * @returns `true` if the scalars are equal, `false` otherwise.
     */
    equals(other) {
        return (0, blsct_1.areScalarEqual)(this.value(), other.value());
    }
    /** Serialize the scalar to a hexadecimal string.
     */
    serialize() {
        return (0, blsct_1.serializeScalar)(this.value());
    }
    /**
     * Deserializes a hexadecimal string into a Scalar instance.
     *
     * @param hex - The hexadecimal string to convert.
     * @returns The `Scalar` instance represented by the input string.
     */
    static deserialize(hex) {
        return Scalar._deserialize(hex, blsct_1.deserializeScalar);
    }
}
exports.Scalar = Scalar;