Class: PrivateKey

A signing key. You can generate one via random.

Hierarchy

• CircuitValue

  ↳ PrivateKey

Table of contents

Constructors

• constructor

Properties

• s

Methods

• assertEquals
• equals
• isConstant
• toBase58
• toConstant
• toFields
• toJSON
• toPublicKey
• check
• fromBase58
• fromBits
• fromFields
• fromJSON
• fromObject
• random
• sizeInFields
• toAuxiliary
• toBase58
• toConstant
• toFields
• toInput
• toJSON

Constructors

constructor

• new PrivateKey(...props)

Parameters

Name	Type
...props	any[]

Inherited from

CircuitValue.constructor

Defined in

lib/circuit_value.ts:64

Properties

s

• s: Scalar

Defined in

lib/signature.ts:12

Methods

assertEquals

▸ assertEquals(x): void

Parameters

Name	Type
x	PrivateKey

Returns

void

Inherited from

CircuitValue.assertEquals

Defined in

lib/circuit_value.ts:152

---

equals

▸ equals(x): Bool

Parameters

Name	Type
x	PrivateKey

Returns

Bool

Inherited from

CircuitValue.equals

Defined in

lib/circuit_value.ts:148

---

isConstant

▸ isConstant(): boolean

Returns

boolean

Inherited from

CircuitValue.isConstant

Defined in

lib/circuit_value.ts:156

---

toBase58

▸ toBase58(): string

Encodes a PrivateKey into a base58 string.

Returns

string

a base58 encoded string

Defined in

lib/signature.ts:58

---

toConstant

▸ toConstant(): PrivateKey

Returns

PrivateKey

Inherited from

CircuitValue.toConstant

Defined in

lib/circuit_value.ts:144

---

toFields

▸ toFields(): Field[]

Returns

Field[]

Inherited from

CircuitValue.toFields

Defined in

lib/circuit_value.ts:136

---

toJSON

▸ toJSON(): any

Returns

any

Inherited from

CircuitValue.toJSON

Defined in

lib/circuit_value.ts:140

---

toPublicKey

▸ toPublicKey(): PublicKey

Derives the associated public key.

Returns

PublicKey

a PublicKey.

Defined in

lib/signature.ts:40

---

check

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

Type parameters

Name	Type
T	extends AnyConstructor

Parameters

Name	Type
this	T
v	InstanceType<T>

Returns

void

Inherited from

CircuitValue.check

Defined in

lib/circuit_value.ts:185

---

fromBase58

▸ Static fromBase58(privateKeyBase58): PrivateKey

Decodes a base58 string into a PrivateKey.

Parameters

Name	Type
privateKeyBase58	string

Returns

PrivateKey

a PrivateKey.

Defined in

lib/signature.ts:49

---

fromBits

▸ Static fromBits(bs): PrivateKey

Deserializes a list of bits into a PrivateKey.

Parameters

Name	Type	Description
bs	Bool[]	a list of Bool.

Returns

PrivateKey

a PrivateKey.

Defined in

lib/signature.ts:31

---

fromFields

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

Type parameters

Name	Type
T	extends AnyConstructor

Parameters

Name	Type
this	T
xs	Field[]

Returns

InstanceType<T>

Inherited from

CircuitValue.fromFields

Defined in

lib/circuit_value.ts:160

---

fromJSON

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

Type parameters

Name	Type
T	extends AnyConstructor

Parameters

Name	Type
this	T
value	any

Returns

InstanceType<T>

Inherited from

CircuitValue.fromJSON

Defined in

lib/circuit_value.ts:218

---

fromObject

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

Type parameters

Name	Type
T	extends AnyConstructor

Parameters

Name	Type
this	T
value	NonMethods<InstanceType<T>>

Returns

InstanceType<T>

Inherited from

CircuitValue.fromObject

Defined in

lib/circuit_value.ts:81

---

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:21

---

sizeInFields

▸ Static sizeInFields(): number

Returns

number

Inherited from

CircuitValue.sizeInFields

Defined in

lib/circuit_value.ts:88

---

toAuxiliary

▸ Static toAuxiliary(): []

Returns

[]

Inherited from

CircuitValue.toAuxiliary

Defined in

lib/circuit_value.ts:110

---

toBase58

▸ Static toBase58(privateKey): string

Static method to encode a PrivateKey into a base58 string.

Parameters

Name	Type
privateKey	Object
privateKey.s	Scalar

Returns

string

a base58 encoded string

Defined in

lib/signature.ts:67

---

toConstant

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

Type parameters

Name	Type
T	extends AnyConstructor

Parameters

Name	Type
this	T
t	InstanceType<T>

Returns

InstanceType<T>

Inherited from

CircuitValue.toConstant

Defined in

lib/circuit_value.ts:199

---

toFields

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

Type parameters

Name	Type
T	extends AnyConstructor

Parameters

Name	Type
this	T
v	InstanceType<T>

Returns

Field[]

Inherited from

CircuitValue.toFields

Defined in

lib/circuit_value.ts:93

---

toInput

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

Type parameters

Name	Type
T	extends AnyConstructor

Parameters

Name	Type
this	T
v	InstanceType<T>

Returns

HashInput

Inherited from

CircuitValue.toInput

Defined in

lib/circuit_value.ts:114

---

toJSON

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

Type parameters

Name	Type
T	extends AnyConstructor

Parameters

Name	Type
this	T
v	InstanceType<T>

Returns

any

Inherited from

CircuitValue.toJSON

Defined in

lib/circuit_value.ts:207