DocsReference@proto-kit/protocolClassesBlockProverPublicInput

@proto-kit/protocol • Docs

Documentation / @proto-kit/protocol / BlockProverPublicInput

Class: BlockProverPublicInput

Extends

  • object

Extended by

Constructors

new BlockProverPublicInput()

new BlockProverPublicInput(value): BlockProverPublicInput

Parameters

• value

• value.blockHashRoot: Field = Field

• value.blockNumber: Field = Field

• value.eternalTransactionsHash: Field = Field

• value.incomingMessagesHash: Field = Field

• value.networkStateHash: Field = Field

• value.proverStateRemainder: Field = Field

• value.stateRoot: Field = Field

Returns

BlockProverPublicInput

Inherited from

Struct({ // Tracker of the current block prover state proverStateRemainder: Field, ...BlockProverStateBaseFields, }).constructor

Defined in

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

Properties

blockHashRoot

blockHashRoot: Field = Field

Inherited from

Struct({ // Tracker of the current block prover state proverStateRemainder: Field, ...BlockProverStateBaseFields, }).blockHashRoot

Defined in

packages/protocol/src/prover/block/BlockProvable.ts:74

blockNumber

blockNumber: Field = Field

Inherited from

Struct({ // Tracker of the current block prover state proverStateRemainder: Field, ...BlockProverStateBaseFields, }).blockNumber

Defined in

packages/protocol/src/prover/block/BlockProvable.ts:75

eternalTransactionsHash

eternalTransactionsHash: Field = Field

Inherited from

Struct({ // Tracker of the current block prover state proverStateRemainder: Field, ...BlockProverStateBaseFields, }).eternalTransactionsHash

Defined in

packages/protocol/src/prover/block/BlockProvable.ts:71

incomingMessagesHash

incomingMessagesHash: Field = Field

Inherited from

Struct({ // Tracker of the current block prover state proverStateRemainder: Field, ...BlockProverStateBaseFields, }).incomingMessagesHash

Defined in

packages/protocol/src/prover/block/BlockProvable.ts:72

networkStateHash

networkStateHash: Field = Field

Inherited from

Struct({ // Tracker of the current block prover state proverStateRemainder: Field, ...BlockProverStateBaseFields, }).networkStateHash

Defined in

packages/protocol/src/prover/block/BlockProvable.ts:76

proverStateRemainder

proverStateRemainder: Field = Field

Inherited from

Struct({ // Tracker of the current block prover state proverStateRemainder: Field, ...BlockProverStateBaseFields, }).proverStateRemainder

Defined in

packages/protocol/src/prover/block/BlockProvable.ts:81

stateRoot

stateRoot: Field = Field

Inherited from

Struct({ // Tracker of the current block prover state proverStateRemainder: Field, ...BlockProverStateBaseFields, }).stateRoot

Defined in

packages/protocol/src/prover/block/BlockProvable.ts:73

_isStruct

static _isStruct: true

Inherited from

Struct({ // Tracker of the current block prover state proverStateRemainder: Field, ...BlockProverStateBaseFields, })._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.blockHashRoot: Field = Field

• value.blockNumber: Field = Field

• value.eternalTransactionsHash: Field = Field

• value.incomingMessagesHash: Field = Field

• value.networkStateHash: Field = Field

• value.proverStateRemainder: Field = Field

• value.stateRoot: Field = Field

Returns

void

Inherited from

Struct({ // Tracker of the current block prover state proverStateRemainder: Field, ...BlockProverStateBaseFields, }).check

Defined in

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

empty()

static empty: () => object

Returns

object

blockHashRoot

blockHashRoot: Field = Field

blockNumber

blockNumber: Field = Field

eternalTransactionsHash

eternalTransactionsHash: Field = Field

incomingMessagesHash

incomingMessagesHash: Field = Field

networkStateHash

networkStateHash: Field = Field

proverStateRemainder

proverStateRemainder: Field = Field

stateRoot

stateRoot: Field = Field

Inherited from

Struct({ // Tracker of the current block prover state proverStateRemainder: Field, ...BlockProverStateBaseFields, }).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

blockHashRoot

blockHashRoot: Field = Field

blockNumber

blockNumber: Field = Field

eternalTransactionsHash

eternalTransactionsHash: Field = Field

incomingMessagesHash

incomingMessagesHash: Field = Field

networkStateHash

networkStateHash: Field = Field

proverStateRemainder

proverStateRemainder: Field = Field

stateRoot

stateRoot: Field = Field

Inherited from

Struct({ // Tracker of the current block prover state proverStateRemainder: Field, ...BlockProverStateBaseFields, }).fromFields

Defined in

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

fromJSON()

static fromJSON: (x) => object

Parameters

• x

• x.blockHashRoot: string = Field

• x.blockNumber: string = Field

• x.eternalTransactionsHash: string = Field

• x.incomingMessagesHash: string = Field

• x.networkStateHash: string = Field

• x.proverStateRemainder: string = Field

• x.stateRoot: string = Field

Returns

object

blockHashRoot

blockHashRoot: Field = Field

blockNumber

blockNumber: Field = Field

eternalTransactionsHash

eternalTransactionsHash: Field = Field

incomingMessagesHash

incomingMessagesHash: Field = Field

networkStateHash

networkStateHash: Field = Field

proverStateRemainder

proverStateRemainder: Field = Field

stateRoot

stateRoot: Field = Field

Inherited from

Struct({ // Tracker of the current block prover state proverStateRemainder: Field, ...BlockProverStateBaseFields, }).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({ // Tracker of the current block prover state proverStateRemainder: Field, ...BlockProverStateBaseFields, }).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.blockHashRoot?: Field = Field

• value.blockNumber?: Field = Field

• value.eternalTransactionsHash?: Field = Field

• value.incomingMessagesHash?: Field = Field

• value.networkStateHash?: Field = Field

• value.proverStateRemainder?: Field = Field

• value.stateRoot?: 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({ // Tracker of the current block prover state proverStateRemainder: Field, ...BlockProverStateBaseFields, }).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.blockHashRoot: Field = Field

• x.blockNumber: Field = Field

• x.eternalTransactionsHash: Field = Field

• x.incomingMessagesHash: Field = Field

• x.networkStateHash: Field = Field

• x.proverStateRemainder: Field = Field

• x.stateRoot: Field = Field

Returns

object

blockHashRoot

blockHashRoot: Field = Field

blockNumber

blockNumber: Field = Field

eternalTransactionsHash

eternalTransactionsHash: Field = Field

incomingMessagesHash

incomingMessagesHash: Field = Field

networkStateHash

networkStateHash: Field = Field

proverStateRemainder

proverStateRemainder: Field = Field

stateRoot

stateRoot: Field = Field

Inherited from

Struct({ // Tracker of the current block prover state proverStateRemainder: Field, ...BlockProverStateBaseFields, }).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.blockHashRoot: Field = Field

• value.blockNumber: Field = Field

• value.eternalTransactionsHash: Field = Field

• value.incomingMessagesHash: Field = Field

• value.networkStateHash: Field = Field

• value.proverStateRemainder: Field = Field

• value.stateRoot: Field = Field

Returns

Field[]

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

Inherited from

Struct({ // Tracker of the current block prover state proverStateRemainder: Field, ...BlockProverStateBaseFields, }).toFields

Defined in

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

toInput()

static toInput: (x) => object

Parameters

• x

• x.blockHashRoot: Field = Field

• x.blockNumber: Field = Field

• x.eternalTransactionsHash: Field = Field

• x.incomingMessagesHash: Field = Field

• x.networkStateHash: Field = Field

• x.proverStateRemainder: Field = Field

• x.stateRoot: Field = Field

Returns

object

fields?

optional fields: Field[]

packed?

optional packed: [Field, number][]

Inherited from

Struct({ // Tracker of the current block prover state proverStateRemainder: Field, ...BlockProverStateBaseFields, }).toInput

Defined in

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

toJSON()

static toJSON: (x) => object

Parameters

• x

• x.blockHashRoot: Field = Field

• x.blockNumber: Field = Field

• x.eternalTransactionsHash: Field = Field

• x.incomingMessagesHash: Field = Field

• x.networkStateHash: Field = Field

• x.proverStateRemainder: Field = Field

• x.stateRoot: Field = Field

Returns

object

blockHashRoot

blockHashRoot: string = Field

blockNumber

blockNumber: string = Field

eternalTransactionsHash

eternalTransactionsHash: string = Field

incomingMessagesHash

incomingMessagesHash: string = Field

networkStateHash

networkStateHash: string = Field

proverStateRemainder

proverStateRemainder: string = Field

stateRoot

stateRoot: string = Field

Inherited from

Struct({ // Tracker of the current block prover state proverStateRemainder: Field, ...BlockProverStateBaseFields, }).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.blockHashRoot: Field = Field

• x.blockNumber: Field = Field

• x.eternalTransactionsHash: Field = Field

• x.incomingMessagesHash: Field = Field

• x.networkStateHash: Field = Field

• x.proverStateRemainder: Field = Field

• x.stateRoot: Field = Field

Returns

object

blockHashRoot

blockHashRoot: bigint = Field

blockNumber

blockNumber: bigint = Field

eternalTransactionsHash

eternalTransactionsHash: bigint = Field

incomingMessagesHash

incomingMessagesHash: bigint = Field

networkStateHash

networkStateHash: bigint = Field

proverStateRemainder

proverStateRemainder: bigint = Field

stateRoot

stateRoot: bigint = Field

Inherited from

Struct({ // Tracker of the current block prover state proverStateRemainder: Field, ...BlockProverStateBaseFields, }).toValue

Defined in

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

Methods

clone()

clone(): BlockProverPublicInput

Returns

BlockProverPublicInput

Defined in

packages/protocol/src/prover/block/BlockProvable.ts:92

equals()

equals(input): Bool

Parameters

• input: BlockProverPublicInput

Returns

Bool

Defined in

packages/protocol/src/prover/block/BlockProvable.ts:84

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({ // Tracker of the current block prover state proverStateRemainder: Field, ...BlockProverStateBaseFields, }).sizeInFields

Defined in

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

BlockProverProgrammableBlockProverPublicOutput