Sign
Extends
CircuitValue
Constructors
new Sign()
new Sign(...props: any[]): Sign
Parameters
• ...props: any
[]
Returns
Inherited from
CircuitValue.constructor
Source
lib/provable/types/circuit-value.ts:13
Properties
value
value: Field;
Source
Accessors
minusOne
get static minusOne(): Sign
Returns
Source
one
get static one(): Sign
Returns
Source
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
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
Source
isPositive()
isPositive(): Bool
Returns
Source
mul()
mul(y: Sign): Sign
Parameters
• y: Sign
Returns
Source
neg()
neg(): Sign
Returns
Source
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
check()
static check(x: Sign): void
Parameters
• x: Sign
Returns
void
Overrides
CircuitValue.check
Source
empty()
static empty<T>(): InstanceType<T>
Type parameters
• T extends AnyConstructor
Returns
InstanceType
\<T
>
Overrides
CircuitValue.empty
Source
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
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
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
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:177
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
toJSON()
static toJSON(x: Sign): "Positive" | "Negative"
Parameters
• x: Sign
Returns
"Positive"
| "Negative"
Overrides
CircuitValue.toJSON
Source
toValue()
static toValue(x: Sign): Sign
Parameters
• x: Sign
Returns
Sign
Overrides
CircuitValue.toValue