Skip to main content

Signature

Defined in: lib/provable/crypto/signature.ts:254

A Schnorr Signature over the Pasta Curves.

Extends

  • CircuitValue

Constructors

new Signature()

new Signature(...props: any[]): Signature

Defined in: lib/provable/types/circuit-value.ts:13

Parameters

props

...any[]

Returns

Signature

Inherited from

CircuitValue.constructor

Properties

r

r: Field;

Defined in: lib/provable/crypto/signature.ts:255


s

s: Scalar;

Defined in: lib/provable/crypto/signature.ts:256

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

Bool

Inherited from

CircuitValue.equals

isConstant()

isConstant(): boolean

Defined in: lib/provable/types/circuit-value.ts:125

Returns

boolean

Inherited from

CircuitValue.isConstant

toBase58()

toBase58(): string

Defined in: lib/provable/crypto/signature.ts:312

Encodes a Signature in base58 format.

Returns

string


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

toJSON()

toJSON(): any

Defined in: lib/provable/types/circuit-value.ts:109

Returns

any

Inherited from

CircuitValue.toJSON

verify()

verify(publicKey: PublicKey, msg: Field[]): Bool

Defined in: lib/provable/crypto/signature.ts:290

Verifies the Signature using a message and the corresponding PublicKey.

Parameters

publicKey

PublicKey

msg

Field[]

Returns

Bool

a Bool


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

create()

static create(privKey: PrivateKey, msg: Field[]): Signature

Defined in: lib/provable/crypto/signature.ts:262

Signs a message using a PrivateKey.

Parameters

privKey

PrivateKey

msg

Field[]

Returns

Signature

a Signature


empty()

static empty<T>(): InstanceType<T>

Defined in: lib/provable/types/circuit-value.ts:205

Type Parameters

T extends AnyConstructor

Returns

InstanceType<T>

Inherited from

CircuitValue.empty

fromBase58()

static fromBase58(signatureBase58: string): Signature

Defined in: lib/provable/crypto/signature.ts:305

Decodes a base58 encoded signature into a Signature.

Parameters

signatureBase58

string

Returns

Signature


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

fromJSON()

static fromJSON<T>(this: T, value: any): InstanceType<T>

Defined in: lib/provable/types/circuit-value.ts:186

Type Parameters

T extends AnyConstructor

Parameters

this

T

value

any

Returns

InstanceType<T>

Inherited from

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

fromValue()

static fromValue<T>(this: T, __namedParameters: {
r: bigint | Field;
s: bigint | Scalar;
}): InstanceType<T>

Defined in: lib/provable/crypto/signature.ts:318

Type Parameters

T extends AnyConstructor

Parameters

this

T

__namedParameters
r

bigint | Field

s

bigint | Scalar

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

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<T>(this: T, v: InstanceType<T>): any

Defined in: lib/provable/types/circuit-value.ts:175

Type Parameters

T extends AnyConstructor

Parameters

this

T

v

InstanceType<T>

Returns

any

Inherited from

CircuitValue.toJSON

toValue()

static toValue<T>(this: T, v: InstanceType<T>): any

Defined in: lib/provable/types/circuit-value.ts:83

Type Parameters

T extends AnyConstructor

Parameters

this

T

v

InstanceType<T>

Returns

any

Inherited from

CircuitValue.toValue