Skip to main content

Class: PrivateKey

A signing key. You can generate one via random.

Hierarchy

Table of contents

Constructors

Properties

Methods

Constructors

constructor

new PrivateKey(...props)

Parameters

NameType
...propsany[]

Inherited from

CircuitValue.constructor

Defined in

lib/circuit_value.ts:87

Properties

s

s: Scalar

Defined in

lib/signature.ts:18

Methods

assertEquals

assertEquals(x): void

Parameters

NameType
xPrivateKey

Returns

void

Inherited from

CircuitValue.assertEquals

Defined in

lib/circuit_value.ts:175


equals

equals(x): Bool

Parameters

NameType
xPrivateKey

Returns

Bool

Inherited from

CircuitValue.equals

Defined in

lib/circuit_value.ts:171


isConstant

isConstant(): boolean

Returns

boolean

Inherited from

CircuitValue.isConstant

Defined in

lib/circuit_value.ts:179


toBase58

toBase58(): string

Encodes a PrivateKey into a base58 string.

Returns

string

a base58 encoded string

Defined in

lib/signature.ts:64


toConstant

toConstant(): PrivateKey

Returns

PrivateKey

Inherited from

CircuitValue.toConstant

Defined in

lib/circuit_value.ts:167


toFields

toFields(): Field[]

Returns

Field[]

Inherited from

CircuitValue.toFields

Defined in

lib/circuit_value.ts:159


toJSON

toJSON(): any

Returns

any

Inherited from

CircuitValue.toJSON

Defined in

lib/circuit_value.ts:163


toPublicKey

toPublicKey(): PublicKey

Derives the associated public key.

Returns

PublicKey

a PublicKey.

Defined in

lib/signature.ts:46


check

Static check<T>(this, v): void

Type parameters

NameType
Textends AnyConstructor

Parameters

NameType
thisT
vInstanceType<T>

Returns

void

Inherited from

CircuitValue.check

Defined in

lib/circuit_value.ts:208


fromBase58

Static fromBase58(privateKeyBase58): PrivateKey

Decodes a base58 string into a PrivateKey.

Parameters

NameType
privateKeyBase58string

Returns

PrivateKey

a PrivateKey.

Defined in

lib/signature.ts:55


fromBits

Static fromBits(bs): PrivateKey

Deserializes a list of bits into a PrivateKey.

Parameters

NameTypeDescription
bsBool[]a list of Bool.

Returns

PrivateKey

a PrivateKey.

Defined in

lib/signature.ts:37


fromFields

Static fromFields<T>(this, xs): InstanceType<T>

Type parameters

NameType
Textends AnyConstructor

Parameters

NameType
thisT
xsField[]

Returns

InstanceType<T>

Inherited from

CircuitValue.fromFields

Defined in

lib/circuit_value.ts:183


fromJSON

Static fromJSON<T>(this, value): InstanceType<T>

Type parameters

NameType
Textends AnyConstructor

Parameters

NameType
thisT
valueany

Returns

InstanceType<T>

Inherited from

CircuitValue.fromJSON

Defined in

lib/circuit_value.ts:241


fromObject

Static fromObject<T>(this, value): InstanceType<T>

Type parameters

NameType
Textends AnyConstructor

Parameters

NameType
thisT
valueNonMethods<InstanceType<T>>

Returns

InstanceType<T>

Inherited from

CircuitValue.fromObject

Defined in

lib/circuit_value.ts:104


random

Static random(): PrivateKey

You can use this method to generate a private key. You can then obtain the associated public key via toPublicKey. And generate signatures via create.

Returns

PrivateKey

a new PrivateKey.

Defined in

lib/signature.ts:27


sizeInFields

Static sizeInFields(): number

Returns

number

Inherited from

CircuitValue.sizeInFields

Defined in

lib/circuit_value.ts:111


toAuxiliary

Static toAuxiliary(): []

Returns

[]

Inherited from

CircuitValue.toAuxiliary

Defined in

lib/circuit_value.ts:133


toBase58

Static toBase58(privateKey): string

Static method to encode a PrivateKey into a base58 string.

Parameters

NameType
privateKeyObject
privateKey.sScalar

Returns

string

a base58 encoded string

Defined in

lib/signature.ts:73


toConstant

Static toConstant<T>(this, t): InstanceType<T>

Type parameters

NameType
Textends AnyConstructor

Parameters

NameType
thisT
tInstanceType<T>

Returns

InstanceType<T>

Inherited from

CircuitValue.toConstant

Defined in

lib/circuit_value.ts:222


toFields

Static toFields<T>(this, v): Field[]

Type parameters

NameType
Textends AnyConstructor

Parameters

NameType
thisT
vInstanceType<T>

Returns

Field[]

Inherited from

CircuitValue.toFields

Defined in

lib/circuit_value.ts:116


toInput

Static toInput<T>(this, v): HashInput

Type parameters

NameType
Textends AnyConstructor

Parameters

NameType
thisT
vInstanceType<T>

Returns

HashInput

Inherited from

CircuitValue.toInput

Defined in

lib/circuit_value.ts:137


toJSON

Static toJSON<T>(this, v): any

Type parameters

NameType
Textends AnyConstructor

Parameters

NameType
thisT
vInstanceType<T>

Returns

any

Inherited from

CircuitValue.toJSON

Defined in

lib/circuit_value.ts:230