@proto-kit/protocol • Docs

Documentation / @proto-kit/protocol / ProvableOption

Class: ProvableOption

Extends

• object

Constructors

new ProvableOption()

new ProvableOption(value): ProvableOption

Parameters

• value

• value.isSome: Bool = Bool

• value.value: Field = Field

Returns

ProvableOption

Inherited from

Struct({ isSome: Bool, value: Field, }).constructor

Defined in

node_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103

Properties

isSome

isSome: Bool = Bool

Inherited from

Struct({ isSome: Bool, value: Field, }).isSome

Defined in

packages/protocol/src/model/Option.ts:12

value

value: Field = Field

Inherited from

Struct({ isSome: Bool, value: Field, }).value

Defined in

packages/protocol/src/model/Option.ts:13

_isStruct

static _isStruct: true

Inherited from

Struct({ isSome: Bool, value: Field, })._isStruct

Defined in

node_modules/o1js/dist/node/lib/provable/types/struct.d.ts:104

check()

static check: (value) => void

Add assertions to the proof to check if value is a valid member of type T. This function does not return anything, instead it creates any number of assertions to prove that value is a valid member of the type T.

For instance, calling check function on the type Bool asserts that the value of the element is either 1 or 0.

Parameters

• value

the element of type T to put assertions on.

• value.isSome: Bool = Bool

• value.value: Field = Field

Returns

void

Inherited from

Struct({ isSome: Bool, value: Field, }).check

Defined in

node_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:60

empty()

static empty: () => object

Returns

object

isSome

isSome: Bool = Bool

value

value: Field = Field

Inherited from

Struct({ isSome: Bool, value: Field, }).empty

Defined in

node_modules/o1js/dist/node/lib/provable/types/struct.d.ts:113

fromFields()

static fromFields: (fields) => object

Parameters

• fields: Field[]

Returns

object

isSome

isSome: Bool = Bool

value

value: Field = Field

Inherited from

Struct({ isSome: Bool, value: Field, }).fromFields

Defined in

node_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:95

fromJSON()

static fromJSON: (x) => object

Parameters

• x

• x.isSome: boolean = Bool

• x.value: string = Field

Returns

object

isSome

isSome: Bool = Bool

value

value: Field = Field

Inherited from

Struct({ isSome: Bool, value: Field, }).fromJSON

Defined in

node_modules/o1js/dist/node/lib/provable/types/struct.d.ts:112

fromValue

static fromValue: (x) => object & (value) => object

Convert provable type from a normal JS type.

Inherited from

Struct({ isSome: Bool, value: Field, }).fromValue

Defined in

node_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:68

toAuxiliary()

static toAuxiliary: (value?) => any[]

A function that takes value (optional), an element of type T, as argument and returns an array of any type that make up the “auxiliary” (non-provable) data of value.

Parameters

• value?

the element of type T to generate the auxiliary data array from, optional. If not provided, a default value for auxiliary data is returned.

• value.isSome?: Bool = Bool

• value.value?: Field = Field

Returns

any[]

An array of any type describing how this T element is made up of “auxiliary” (non-provable) data.

Inherited from

Struct({ isSome: Bool, value: Field, }).toAuxiliary

Defined in

node_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:34

toCanonical()?

static optional toCanonical: (x) => object

Optional method which transforms a provable type into its canonical representation.

This is needed for types that have multiple representations of the same underlying value, and might even not have perfect completeness for some of those representations.

An example is the ForeignField class, which allows non-native field elements to exist in unreduced form. The unreduced form is not perfectly complete, for example, addition of two unreduced field elements can cause a prover error.

Specific protocols need to be able to protect themselves against incomplete operations at all costs. For example, when using actions and reducer, the reducer must be able to produce a proof regardless of the input action. toCanonical() converts any input into a safe form and enables us to handle cases like this generically.

Note: For most types, this method is the identity function. The identity function will also be used when the toCanonical() is not present on a type.

Parameters

• x

• x.isSome: Bool = Bool

• x.value: Field = Field

Returns

object

isSome

isSome: Bool = Bool

value

value: Field = Field

Inherited from

Struct({ isSome: Bool, value: Field, }).toCanonical

Defined in

node_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:85

toFields()

static toFields: (value) => Field[]

A function that takes value, an element of type T, as argument and returns an array of Field elements that make up the provable data of value.

Parameters

• value

the element of type T to generate the Field array from.

• value.isSome: Bool = Bool

• value.value: Field = Field

Returns

Field[]

A Field array describing how this T element is made up of Field elements.

Inherited from

Struct({ isSome: Bool, value: Field, }).toFields

Defined in

node_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:24

toInput()

static toInput: (x) => object

Parameters

• x

• x.isSome: Bool = Bool

• x.value: Field = Field

Returns

object

fields?

optional fields: Field[]

packed?

optional packed: [Field, number][]

Inherited from

Struct({ isSome: Bool, value: Field, }).toInput

Defined in

node_modules/o1js/dist/node/lib/provable/types/struct.d.ts:107

toJSON()

static toJSON: (x) => object

Parameters

• x

• x.isSome: Bool = Bool

• x.value: Field = Field

Returns

object

isSome

isSome: boolean = Bool

value

value: string = Field

Inherited from

Struct({ isSome: Bool, value: Field, }).toJSON

Defined in

node_modules/o1js/dist/node/lib/provable/types/struct.d.ts:111

toValue()

static toValue: (x) => object

Convert provable type to a normal JS type.

Parameters

• x

• x.isSome: Bool = Bool

• x.value: Field = Field

Returns

object

isSome

isSome: boolean = Bool

value

value: bigint = Field

Inherited from

Struct({ isSome: Bool, value: Field, }).toValue

Defined in

node_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:64

Methods

toSome()

toSome(): ProvableOption

Returns

ProvableOption

Defined in

packages/protocol/src/model/Option.ts:15

sizeInFields()

static sizeInFields(): number

Return the size of the T type in terms of Field type, as Field is the primitive type.

Returns

number

A number representing the size of the T type in terms of Field type.

Inherited from

Struct({ isSome: Bool, value: Field, }).sizeInFields

Defined in

node_modules/o1js/dist/node/lib/provable/types/provable-intf.d.ts:51