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.
43 lines (42 loc) • 1.83 kB
TypeScript
import { ManagedObj } from './managedObj';
import { PublicKey } from './keys/publicKey';
import { Scalar } from './scalar';
/** Represents a hash ID consisting of a blinding public key, a spending public key, and a view key. Also known as `CKeyId` which is an alias for `uint160` on the C++ side.
*
* Examples:
* ```ts
* const { HashId, PublicKey, ChildKey, Scalar } = require('navio-blsct')
* const blindingPubKey = PublicKey.random()
* const spendingPubKey = PublicKey.random()
* const seed = Scalar.random()
* const viewKey = Scalar.random()
* const hashId = HashId.generate(blindingPubKey, spendingPubKey, viewKey)
* const ser = hashId.serialize()
* const deser = HashId.deserialize(ser)
* ser === deser.serialize() // true
* ```
*/
export declare class HashId extends ManagedObj {
/** Constructs a new `HashId` instance.
* - If no parameter is provided, a random `HashId` is generated.
*/
constructor(obj?: any);
/** Generates a `HashId` from the provided blinding public key, spending public key, and view key.
* @param blindingPubKey - The public key used for blinding.
* @param spendingPubKey - The spending public key.
* @param viewKey - The view key.
* @returns A new `HashId` instance.
*/
static generate(blindingPubKey: PublicKey, spendingPubKey: PublicKey, viewKey: Scalar): HashId;
/** Generates a random `HashId`.
* @returns A new `HashId` instance with two random `PublicKey`s and a random `ViewKey`.
*/
static random(): HashId;
value(): any;
serialize(): string;
/** Deserializes a hexadecimal string into a `HashId` instance.
* @param hex - The hexadecimal string to deserialize.
* @returns A new `HashId` instance.
*/
static deserialize(this: new (obj: any) => HashId, hex: string): HashId;
}