navio-blsct
Version:
TypeScript bindings for the `libblsct` library used by the [Navio](https://nav.io/) blockchain to construct confidential transactions based on the BLS12-381 curve.
51 lines (50 loc) • 1.83 kB
TypeScript
import { ManagedObj } from './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
* ```
*/
export declare class Scalar extends 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?: any);
value(): any;
/**
* Generates a random scalar.
* @returns A random scalar in the finite field $\mathbb{F}_r$.
*/
static random(): Scalar;
/** Converts the scalar to an integer.
* * @returns The scalar as a number.
*/
toNumber(): number;
/** 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: Scalar): boolean;
/** Serialize the scalar to a hexadecimal string.
*/
serialize(): string;
/**
* 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(this: new (obj: any) => Scalar, hex: string): Scalar;
}