PublicKey
Defined in: lib/provable/crypto/signature.ts:132
A public key, which is also an address on the Mina network. You can derive a PublicKey directly from a PrivateKey.
Extends
CircuitValue
Constructors
new PublicKey()
new PublicKey(...props: any[]): PublicKey
Defined in: lib/provable/types/circuit-value.ts:13
Parameters
props
...any[]
Returns
Inherited from
CircuitValue.constructor
Properties
isOdd
isOdd: Bool;
Defined in: lib/provable/crypto/signature.ts:135
x
x: Field;
Defined in: lib/provable/crypto/signature.ts:134
Methods
assertEquals()
assertEquals(x: this): void
Defined in: lib/provable/types/circuit-value.ts:121
Parameters
x
this
Returns
void
Inherited from
CircuitValue.assertEquals
equals()
equals(x: this): Bool
Defined in: lib/provable/types/circuit-value.ts:117
Parameters
x
this
Returns
Inherited from
CircuitValue.equals
isConstant()
isConstant(): boolean
Defined in: lib/provable/types/circuit-value.ts:125
Returns
boolean
Inherited from
CircuitValue.isConstant
isEmpty()
isEmpty(): Bool
Defined in: lib/provable/crypto/signature.ts:190
Checks if a PublicKey is empty.
Returns
a Bool
toBase58()
toBase58(): string
Defined in: lib/provable/crypto/signature.ts:208
Encodes a PublicKey in base58 format.
Returns
string
a base58 encoded PublicKey
toConstant()
toConstant(): this
Defined in: lib/provable/types/circuit-value.ts:113
Returns
this
Inherited from
CircuitValue.toConstant
toFields()
toFields(): Field[]
Defined in: lib/provable/types/circuit-value.ts:79
Returns
Field[]
Inherited from
CircuitValue.toFields
toGroup()
toGroup(): Group
Defined in: lib/provable/crypto/signature.ts:141
Returns the Group representation of this PublicKey.
Returns
A Group
toJSON()
toJSON(): any
Defined in: lib/provable/types/circuit-value.ts:109
Returns
any
Inherited from
CircuitValue.toJSON
check()
static check<T>(this: T, v: InstanceType<T>): void
Defined in: lib/provable/types/circuit-value.ts:148
Type Parameters
• T extends AnyConstructor
Parameters
this
T
v
InstanceType<T>
Returns
void
Inherited from
CircuitValue.check
empty()
static empty<T>(): InstanceType<T>
Defined in: lib/provable/crypto/signature.ts:182
Creates an empty PublicKey.
Type Parameters
• T extends AnyConstructor
Returns
InstanceType<T>
an empty PublicKey
Overrides
CircuitValue.empty
from()
static from(g: {
isOdd: boolean | Bool;
x: bigint | Field;
}): PublicKey
Defined in: lib/provable/crypto/signature.ts:174
Creates a PublicKey from a JSON structure element.
Parameters
g
isOdd
boolean | Bool
x
bigint | Field
Returns
a PublicKey.
fromBase58()
static fromBase58(publicKeyBase58: string): PublicKey
Defined in: lib/provable/crypto/signature.ts:199
Decodes a base58 encoded PublicKey into a PublicKey.
Parameters
publicKeyBase58
string
Returns
fromFields()
static fromFields<T>(this: T, xs: Field[]): InstanceType<T>
Defined in: lib/provable/types/circuit-value.ts:129
Type Parameters
• T extends AnyConstructor
Parameters
this
T
xs
Field[]
Returns
InstanceType<T>
Inherited from
CircuitValue.fromFields
fromGroup()
static fromGroup(__namedParameters: Group): PublicKey
Defined in: lib/provable/crypto/signature.ts:158
Creates a PublicKey from a Group element.
Parameters
__namedParameters
Returns
a PublicKey.
fromJSON()
static fromJSON<T>(this: T, publicKey: string): InstanceType<T>
Defined in: lib/provable/crypto/signature.ts:236
Deserializes a JSON string into a PublicKey.
Type Parameters
• T extends AnyConstructor
Parameters
this
T
publicKey
string
Returns
InstanceType<T>
a JSON string
Overrides
CircuitValue.fromJSON
fromObject()
static fromObject<T>(this: T, value: NonMethods<InstanceType<T>>): InstanceType<T>
Defined in: lib/provable/types/circuit-value.ts:30
Type Parameters
• T extends AnyConstructor
Parameters
this
T
value
NonMethods<InstanceType<T>>
Returns
InstanceType<T>
Inherited from
CircuitValue.fromObject
fromPrivateKey()
static fromPrivateKey(__namedParameters: PrivateKey): PublicKey
Defined in: lib/provable/crypto/signature.ts:166
Derives a PublicKey from a PrivateKey.
Parameters
__namedParameters
Returns
a PublicKey.
fromValue()
static fromValue<T>(this: T, __namedParameters: {
isOdd: boolean | Bool;
x: bigint | Field;
}): InstanceType<T>
Defined in: lib/provable/crypto/signature.ts:243
Type Parameters
• T extends AnyConstructor
Parameters
this
T
__namedParameters
isOdd
boolean | Bool
x
bigint | Field
Returns
InstanceType<T>
Overrides
CircuitValue.fromValue
sizeInFields()
static sizeInFields(): number
Defined in: lib/provable/types/circuit-value.ts:37
Returns
number
Inherited from
CircuitValue.sizeInFields
toAuxiliary()
static toAuxiliary(): []
Defined in: lib/provable/types/circuit-value.ts:56
Returns
[]
Inherited from
CircuitValue.toAuxiliary
toBase58()
static toBase58(__namedParameters: PublicKey): string
Defined in: lib/provable/crypto/signature.ts:216
Static method to encode a PublicKey into base58 format.
Parameters
__namedParameters
Returns
string
a base58 encoded PublicKey
toCanonical()
static toCanonical<T>(this: T, value: InstanceType<T>): InstanceType<T>
Defined in: lib/provable/types/circuit-value.ts:161
Type Parameters
• T extends AnyConstructor
Parameters
this
T
value
InstanceType<T>
Returns
InstanceType<T>
Inherited from
CircuitValue.toCanonical
toConstant()
static toConstant<T>(this: T, t: InstanceType<T>): InstanceType<T>
Defined in: lib/provable/types/circuit-value.ts:170
Type Parameters
• T extends AnyConstructor
Parameters
this
T
t
InstanceType<T>
Returns
InstanceType<T>
Inherited from
CircuitValue.toConstant
toFields()
static toFields<T>(this: T, v: InstanceType<T>): Field[]
Defined in: lib/provable/types/circuit-value.ts:42
Type Parameters
• T extends AnyConstructor
Parameters
this
T
v
InstanceType<T>
Returns
Field[]
Inherited from
CircuitValue.toFields
toInput()
static toInput<T>(this: T, v: InstanceType<T>): HashInput
Defined in: lib/provable/types/circuit-value.ts:60
Type Parameters
• T extends AnyConstructor
Parameters
this
T
v
InstanceType<T>
Returns
HashInput
Inherited from
CircuitValue.toInput
toJSON()
static toJSON(publicKey: PublicKey): string
Defined in: lib/provable/crypto/signature.ts:228
Serializes a PublicKey into its JSON representation.
Parameters
publicKey
Returns
string
a JSON string
Overrides
CircuitValue.toJSON
toValue()
static toValue(__namedParameters: PublicKey): {
isOdd: boolean;
x: bigint;
}
Defined in: lib/provable/crypto/signature.ts:240
Parameters
__namedParameters
Returns
{
isOdd: boolean;
x: bigint;
}
isOdd
isOdd: boolean;
x
x: bigint;
Overrides
CircuitValue.toValue