@proto-kit/sequencer • Docs

Documentation / @proto-kit/sequencer / UntypedOption

Class: UntypedOption

Option facilitating in-circuit values that may or may not exist.

Extends

• OptionBase

Constructors

new UntypedOption()

new UntypedOption(isSome, value, enforceEmpty): UntypedOption

Parameters

• isSome: Bool

• value: Field[]

• enforceEmpty: Bool

Returns

UntypedOption

Overrides

OptionBase.constructor

Defined in

packages/sequencer/src/protocol/production/helpers/UntypedOption.ts:32

Properties

isForcedSome

isForcedSome: Bool

Inherited from

OptionBase.isForcedSome

Defined in

packages/protocol/dist/model/Option.d.ts:60

isSome

isSome: Bool

Inherited from

OptionBase.isSome

Defined in

packages/protocol/dist/model/Option.d.ts:59

value

value: Field[]

Defined in

packages/sequencer/src/protocol/production/helpers/UntypedOption.ts:34

Accessors

treeValue

Get Signature

get treeValue(): Field

Returns

Field

Tree representation of the current value

Inherited from

OptionBase.treeValue

Defined in

packages/protocol/dist/model/Option.d.ts:67

Methods

clone()

clone(): UntypedOption

Returns

UntypedOption

Overrides

OptionBase.clone

Defined in

packages/sequencer/src/protocol/production/helpers/UntypedOption.ts:40

encodeValueToFields()

protected encodeValueToFields(): Field[]

Returns

Field[]

Overrides

OptionBase.encodeValueToFields

Defined in

packages/sequencer/src/protocol/production/helpers/UntypedOption.ts:44

forceSome()

forceSome(): void

Returns

void

Inherited from

OptionBase.forceSome

Defined in

packages/protocol/dist/model/Option.d.ts:68

toFields()

toFields(): Field[]

Returns the to-value as decoded as a list of fields Not in circuit

Returns

Field[]

Inherited from

OptionBase.toFields

Defined in

packages/protocol/dist/model/Option.d.ts:73

toJSON()

toJSON(): object

Returns

object

isForcedSome

isForcedSome: boolean

isSome

isSome: boolean

value

value: string[]

Inherited from

OptionBase.toJSON

Defined in

packages/protocol/dist/model/Option.d.ts:78

toProvable()

toProvable(): ProvableOption

Returns

ProvableOption

Provable representation of the current option.

Inherited from

OptionBase.toProvable

Defined in

packages/protocol/dist/model/Option.d.ts:77

fromJSON()

static fromJSON(__namedParameters): UntypedOption

Parameters

• __namedParameters

• __namedParameters.isForcedSome: boolean

• __namedParameters.isSome: boolean

• __namedParameters.value: string[]

Returns

UntypedOption

Defined in

packages/sequencer/src/protocol/production/helpers/UntypedOption.ts:16

fromOption()

static fromOption<Value>(option): UntypedOption

Type Parameters

• Value

Parameters

• option: Option<Value> | Option<Field>

Returns

UntypedOption

Defined in

packages/sequencer/src/protocol/production/helpers/UntypedOption.ts:8