Signature

SnarkyJS / Modules / Signature

Class: Signature

A Schnorr Signature over the Pasta Curves.

Hierarchy

• CircuitValue

  ↳ Signature

Table of contents

Constructors

• constructor

Properties

• r
• s

Methods

• assertEquals
• equals
• isConstant
• toBase58
• toConstant
• toFields
• toJSON
• verify
• check
• create
• fromBase58
• fromFields
• fromJSON
• fromObject
• sizeInFields
• toAuxiliary
• toConstant
• toFields
• toInput
• toJSON

Constructors

constructor

• new Signature(...props)

Parameters

Name	Type
...props	any[]

Inherited from

CircuitValue.constructor

Defined in

lib/circuit_value.ts:70

Properties

r

• r: Field

Defined in

lib/signature.ts:226

---

s

• s: Scalar

Defined in

lib/signature.ts:227

Methods

assertEquals

▸ assertEquals(x): void

Parameters

Name	Type
x	Signature

Returns

void

Inherited from

CircuitValue.assertEquals

Defined in

lib/circuit_value.ts:158

---

equals

▸ equals(x): Bool

Parameters

Name	Type
x	Signature

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 Signature in base58 format.

Returns

string

Defined in

lib/signature.ts:287

---

toConstant

▸ toConstant(): Signature

Returns

Signature

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

---

verify

▸ verify(publicKey, msg): Bool

Verifies the Signature using a message and the corresponding PublicKey.

Parameters

Name	Type
publicKey	PublicKey
msg	Field[]

Returns

Bool

a Bool

Defined in

lib/signature.ts:261

---

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

---

create

▸ Static create(privKey, msg): Signature

Signs a message using a PrivateKey.

Parameters

Name	Type
privKey	PrivateKey
msg	Field[]

Returns

Signature

a Signature

Defined in

lib/signature.ts:233

---

fromBase58

▸ Static fromBase58(signatureBase58): Signature

Decodes a base58 encoded signature into a Signature.

Parameters

Name	Type
signatureBase58	string

Returns

Signature

Defined in

lib/signature.ts:277

---

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

---

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

---

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