PrivateKey

SnarkyJS / Modules / PrivateKey

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
• toBigInt
• toConstant
• toFields
• toJSON
• toPublicKey
• check
• fromBase58
• fromBigInt
• fromBits
• fromFields
• fromJSON
• fromObject
• random
• sizeInFields
• toAuxiliary
• toBase58
• toConstant
• toFields
• toInput
• toJSON

Constructors

constructor

• new PrivateKey(s)

Parameters

Name	Type
s	Scalar

Overrides

CircuitValue.constructor

Defined in

lib/signature.ts:28

Properties

s

• s: Scalar

Defined in

lib/signature.ts:26

Methods

assertEquals

▸ assertEquals(x): void

Parameters

Name	Type
x	PrivateKey

Returns

void

Inherited from

CircuitValue.assertEquals

Defined in

lib/circuit_value.ts:158

---

equals

▸ equals(x): Bool

Parameters

Name	Type
x	PrivateKey

Returns

Bool

Inherited from

CircuitValue.equals

Defined in

lib/circuit_value.ts:154

---

isConstant

▸ isConstant(): boolean

Returns

boolean

Inherited from

CircuitValue.isConstant

Defined in

lib/circuit_value.ts:162

---

toBase58

▸ toBase58(): string

Encodes a PrivateKey into a base58 string.

Returns

string

a base58 encoded string

Defined in

lib/signature.ts:93

---

toBigInt

▸ toBigInt(): bigint

Convert this PrivateKey to a bigint

Returns

bigint

Defined in

lib/signature.ts:56

---

toConstant

▸ toConstant(): PrivateKey

Returns

PrivateKey

Inherited from

CircuitValue.toConstant

Defined in

lib/circuit_value.ts:150

---

toFields

▸ toFields(): Field[]

Returns

Field[]

Inherited from

CircuitValue.toFields

Defined in

lib/circuit_value.ts:142

---

toJSON

▸ toJSON(): any

Returns

any

Inherited from

CircuitValue.toJSON

Defined in

lib/circuit_value.ts:146

---

toPublicKey

▸ toPublicKey(): PublicKey

Derives the associated public key.

Returns

PublicKey

a PublicKey.

Defined in

lib/signature.ts:75

---

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

---

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

---

fromBigInt

▸ Static fromBigInt(sk): PrivateKey

Create a PrivateKey from a bigint

Warning: Private keys should be sampled from secure randomness with sufficient entropy. Be careful that you don't use this method to create private keys that were sampled insecurely.

Parameters

Name	Type
sk	bigint

Returns

PrivateKey

Defined in

lib/signature.ts:66

---

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

---

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

---

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

---

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

---

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

---

sizeInFields

▸ Static sizeInFields(): number

Returns

number

Inherited from

CircuitValue.sizeInFields

Defined in

lib/circuit_value.ts:94

---

toAuxiliary

▸ Static toAuxiliary(): []

Returns

[]

Inherited from

CircuitValue.toAuxiliary

Defined in

lib/circuit_value.ts:116

---

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

---

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

---

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

---

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

---

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