Preparing search index...
The search index is not available snarkyjs
Constructors
constructor
new Field( x: string | number | bigint | boolean | Field ) : Field
Parameters
x: string | number | bigint | boolean | Field
Properties
Static
ORDER
ORDER: bigint
Methods
add
add( y: string | number | boolean | Field ) : Field
Parameters
y: string | number | boolean | Field
assert Bool
assert Bool( message?: string ) : void
Returns void
assert Boolean
assert Boolean( message?: string ) : void
Returns void
assert Equals
assert Equals( y: string | number | boolean | Field , message?: string ) : void
Parameters
y: string | number | boolean | Field
Optional
message: string
Returns void
assert Greater Than
assert Greater Than( y: string | number | boolean | Field , message?: string ) : void
Parameters
y: string | number | boolean | Field
Optional
message: string
Returns void
assert Greater Than Or Equal
assert Greater Than Or Equal( y: string | number | boolean | Field , message?: string ) : void
Parameters
y: string | number | boolean | Field
Optional
message: string
Returns void
assert Gt
assert Gt( y: string | number | boolean | Field , message?: string ) : void
Parameters
y: string | number | boolean | Field
Optional
message: string
Returns void
assert Gte
assert Gte( y: string | number | boolean | Field , message?: string ) : void
Parameters
y: string | number | boolean | Field
Optional
message: string
Returns void
assert Less Than
assert Less Than( y: string | number | boolean | Field , message?: string ) : void
Parameters
y: string | number | boolean | Field
Optional
message: string
Returns void
assert Less Than Or Equal
assert Less Than Or Equal( y: string | number | boolean | Field , message?: string ) : void
Parameters
y: string | number | boolean | Field
Optional
message: string
Returns void
assert Lt
assert Lt( y: string | number | boolean | Field , message?: string ) : void
Parameters
y: string | number | boolean | Field
Optional
message: string
Returns void
assert Lte
assert Lte( y: string | number | boolean | Field , message?: string ) : void
Parameters
y: string | number | boolean | Field
Optional
message: string
Returns void
div
div( y: string | number | boolean | Field ) : Field
Parameters
y: string | number | boolean | Field
equals
equals( y: string | number | boolean | Field ) : Bool
Parameters
y: string | number | boolean | Field
greater Than
greater Than( y: string | number | boolean | Field ) : Bool
Parameters
y: string | number | boolean | Field
greater Than Or Equal
greater Than Or Equal( y: string | number | boolean | Field ) : Bool
Parameters
y: string | number | boolean | Field
gt
gt( y: string | number | boolean | Field ) : Bool
Parameters
y: string | number | boolean | Field
gte
gte( y: string | number | boolean | Field ) : Bool
Parameters
y: string | number | boolean | Field
is Constant
is Constant( ) : boolean
Returns boolean
less Than
less Than( y: string | number | boolean | Field ) : Bool
Parameters
y: string | number | boolean | Field
less Than Or Equal
less Than Or Equal( y: string | number | boolean | Field ) : Bool
Parameters
y: string | number | boolean | Field
lt
lt( y: string | number | boolean | Field ) : Bool
Parameters
y: string | number | boolean | Field
lte
lte( y: string | number | boolean | Field ) : Bool
Parameters
y: string | number | boolean | Field
mul
mul( y: string | number | boolean | Field ) : Field
Parameters
y: string | number | boolean | Field
range Check Helper
range Check Helper( numBits: number ) : Field
size In Fields
size In Fields( ) : number
Returns number
sub
sub( y: string | number | boolean | Field ) : Field
Parameters
y: string | number | boolean | Field
to Big Int
to Big Int( ) : bigint
Returns bigint
toJSON
toJSON( ) : string
Returns string
to String
to String( ) : string
Returns string
Static
check
check( x: Field ) : void
Returns void
Static
from Bytes
from Bytes( bytes: number [] ) : Field
Static
fromJSON
fromJSON( x: string ) : Field
Static
read Bytes
read Bytes( bytes: number [] , offset: number ) : [ value: Field , offset: number ]
Parameters
bytes: number []
offset: number
Returns [ value: Field , offset: number ]
Static
size In Bytes
size In Bytes( ) : number
Returns number
Static
size In Fields
size In Fields( ) : number
Returns number
Static
to Auxiliary
to Auxiliary( x?: Field ) : [ ]
Returns [ ]
Static
to Bytes
to Bytes( x: Field ) : number []
Returns number []
Static
toJSON
toJSON( x: Field ) : string
Returns string
Coerces anything field-like to a Field.