Sign

Extends

• CircuitValue

Constructors

new Sign()

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

Parameters

• ...props: any[]

Returns

Sign

Inherited from

CircuitValue.constructor

Source

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

Properties

value

value: Field;

Source

lib/provable/int.ts:1034

Accessors

minusOne

get static minusOne(): Sign

Returns

Sign

Source

lib/provable/int.ts:1039

---

one

get static one(): Sign

Returns

Sign

Source

lib/provable/int.ts:1036

Methods

assertEquals()

assertEquals(x: this): void

Parameters

• x: this

Returns

void

Inherited from

CircuitValue.assertEquals

Source

lib/provable/types/circuit-value.ts:130

---

equals()

equals(x: this): Bool

Parameters

• x: this

Returns

Bool

Inherited from

CircuitValue.equals

Source

lib/provable/types/circuit-value.ts:126

---

isConstant()

isConstant(): boolean

Returns

boolean

Inherited from

CircuitValue.isConstant

Source

lib/provable/types/circuit-value.ts:134

---

isNegative()

isNegative(): Bool

Returns

Bool

Source

lib/provable/int.ts:1071

---

isPositive()

isPositive(): Bool

Returns

Bool

Source

lib/provable/int.ts:1068

---

mul()

mul(y: Sign): Sign

Parameters

• y: Sign

Returns

Sign

Source

lib/provable/int.ts:1065

---

neg()

neg(): Sign

Returns

Sign

Source

lib/provable/int.ts:1062

---

toConstant()

toConstant(): this

Returns

this

Inherited from

CircuitValue.toConstant

Source

lib/provable/types/circuit-value.ts:122

---

toFields()

toFields(): Field[]

Returns

Field[]

Inherited from

CircuitValue.toFields

Source

lib/provable/types/circuit-value.ts:85

---

toJSON()

toJSON(): any

Returns

any

Inherited from

CircuitValue.toJSON

Source

lib/provable/types/circuit-value.ts:118

---

toString()

toString(): string

Returns

string

Source

lib/provable/int.ts:1075

---

check()

static check(x: Sign): void

Parameters

• x: Sign

Returns

void

Overrides

CircuitValue.check

Source

lib/provable/int.ts:1042

---

empty()

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

Type parameters

• T extends AnyConstructor

Returns

InstanceType\<T>

Overrides

CircuitValue.empty

Source

lib/provable/int.ts:1046

---

fromFields()

static fromFields<T>(this: T, xs: Field[]): InstanceType<T>

Type parameters

• T extends AnyConstructor

Parameters

• this: T

• xs: Field[]

Returns

InstanceType\<T>

Inherited from

CircuitValue.fromFields

Source

lib/provable/types/circuit-value.ts:138

---

fromJSON()

static fromJSON<T>(x: "Positive" | "Negative"): InstanceType<T>

Type parameters

• T extends AnyConstructor

Parameters

• x: "Positive" | "Negative"

Returns

InstanceType\<T>

Overrides

CircuitValue.fromJSON

Source

lib/provable/int.ts:1057

---

fromObject()

static fromObject<T>(this: T, value: NonMethods<InstanceType<T>>): InstanceType<T>

Type parameters

• T extends AnyConstructor

Parameters

• this: T

• value: NonMethods\<InstanceType\<T>>

Returns

InstanceType\<T>

Inherited from

CircuitValue.fromObject

Source

lib/provable/types/circuit-value.ts:30

---

fromValue()

static fromValue<T>(x: bigint | Sign): InstanceType<T>

Type parameters

• T extends AnyConstructor

Parameters

• x: bigint | Sign

Returns

InstanceType\<T>

Overrides

CircuitValue.fromValue

Source

lib/provable/int.ts:1083

---

sizeInFields()

static sizeInFields(): number

Returns

number

Inherited from

CircuitValue.sizeInFields

Source

lib/provable/types/circuit-value.ts:37

---

toAuxiliary()

static toAuxiliary(): []

Returns

[]

Inherited from

CircuitValue.toAuxiliary

Source

lib/provable/types/circuit-value.ts:59

---

toCanonical()

static toCanonical<T>(this: T, value: InstanceType<T>): InstanceType<T>

Type parameters

• T extends AnyConstructor

Parameters

• this: T

• value: InstanceType\<T>

Returns

InstanceType\<T>

Inherited from

CircuitValue.toCanonical

Source

lib/provable/types/circuit-value.ts:177

---

toConstant()

static toConstant<T>(this: T, t: InstanceType<T>): InstanceType<T>

Type parameters

• T extends AnyConstructor

Parameters

• this: T

• t: InstanceType\<T>

Returns

InstanceType\<T>

Inherited from

CircuitValue.toConstant

Source

lib/provable/types/circuit-value.ts:189

---

toFields()

static toFields<T>(this: T, v: InstanceType<T>): Field[]

Type parameters

• T extends AnyConstructor

Parameters

• this: T

• v: InstanceType\<T>

Returns

Field[]

Inherited from

CircuitValue.toFields

Source

lib/provable/types/circuit-value.ts:42

---

toInput()

static toInput(x: Sign): HashInput

Parameters

• x: Sign

Returns

HashInput

Overrides

CircuitValue.toInput

Source

lib/provable/int.ts:1049

---

toJSON()

static toJSON(x: Sign): "Positive" | "Negative"

Parameters

• x: Sign

Returns

"Positive" | "Negative"

Overrides

CircuitValue.toJSON

Source

lib/provable/int.ts:1052

---

toValue()

static toValue(x: Sign): Sign

Parameters

• x: Sign

Returns

Sign

Overrides

CircuitValue.toValue

Source

lib/provable/int.ts:1079