Skip to main content

PrivateKey

o1js / Modules / PrivateKey

Class: PrivateKey

A signing key. You can generate one via random.

Hierarchy

Table of contents

Constructors

Properties

Methods

Constructors

constructor

new PrivateKey(s)

Parameters

NameType
sScalar

Overrides

CircuitValue.constructor

Defined in

lib/signature.ts:30

Properties

s

s: Scalar

Defined in

lib/signature.ts:28

Methods

assertEquals

assertEquals(x): void

Parameters

NameType
xPrivateKey

Returns

void

Inherited from

CircuitValue.assertEquals

Defined in

lib/circuit_value.ts:166


equals

equals(x): Bool

Parameters

NameType
xPrivateKey

Returns

Bool

Inherited from

CircuitValue.equals

Defined in

lib/circuit_value.ts:162


isConstant

isConstant(): boolean

Returns

boolean

Inherited from

CircuitValue.isConstant

Defined in

lib/circuit_value.ts:170


toBase58

toBase58(): string

Encodes a PrivateKey into a base58 string.

Returns

string

a base58 encoded string

Defined in

lib/signature.ts:95


toBigInt

toBigInt(): bigint

Convert this PrivateKey to a bigint

Returns

bigint

Defined in

lib/signature.ts:58


toConstant

toConstant(): PrivateKey

Returns

PrivateKey

Inherited from

CircuitValue.toConstant

Defined in

lib/circuit_value.ts:158


toFields

toFields(): Field[]

Returns

Field[]

Inherited from

CircuitValue.toFields

Defined in

lib/circuit_value.ts:150


toJSON

toJSON(): any

Returns

any

Inherited from

CircuitValue.toJSON

Defined in

lib/circuit_value.ts:154


toPublicKey

toPublicKey(): PublicKey

Derives the associated public key.

Returns

PublicKey

a PublicKey.

Defined in

lib/signature.ts:77


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


empty

Static empty\<T>(): InstanceType\<T>

Type parameters

NameType
Textends AnyConstructor

Returns

InstanceType\<T>

Inherited from

CircuitValue.empty

Defined in

lib/circuit_value.ts:254


fromBase58

Static fromBase58(privateKeyBase58): PrivateKey

Decodes a base58 string into a PrivateKey.

Parameters

NameType
privateKeyBase58string

Returns

PrivateKey

a PrivateKey.

Defined in

lib/signature.ts:86


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

NameType
skbigint

Returns

PrivateKey

Defined in

lib/signature.ts:68


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


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


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


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


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


sizeInFields

Static sizeInFields(): number

Returns

number

Inherited from

CircuitValue.sizeInFields

Defined in

lib/circuit_value.ts:102


toAuxiliary

Static toAuxiliary(): []

Returns

[]

Inherited from

CircuitValue.toAuxiliary

Defined in

lib/circuit_value.ts:124


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


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


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


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


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