DocsReference@proto-kit/protocolClassesAppliedBatchHashList

@proto-kit/protocolDocs


Documentation / @proto-kit/protocol / AppliedBatchHashList

Class: AppliedBatchHashList

A HashList for AppliedSTBatches, that in addition to the default functionality, checks that the pushed batches are not empty. If they are, the pushing is skipped. Note that if the batch has applied: false, the batch still has to be appended if it has STs inside

Extends

Constructors

new AppliedBatchHashList()

new AppliedBatchHashList(commitment): AppliedBatchHashList

Parameters

commitment: Field = ...

Returns

AppliedBatchHashList

Overrides

DefaultProvableHashList.constructor

Defined in

packages/protocol/src/prover/accumulators/AppliedBatchHashList.ts:17

Properties

commitment

commitment: Field

Inherited from

DefaultProvableHashList.commitment

Defined in

packages/protocol/src/utils/ProvableHashList.ts:26


valueType

protected readonly valueType: ProvablePure<NonMethods<AppliedStateTransitionBatch>>

Inherited from

DefaultProvableHashList.valueType

Defined in

packages/protocol/src/utils/ProvableHashList.ts:29

Methods

empty()

empty(): Field

Returns

Field

Inherited from

DefaultProvableHashList.empty

Defined in

packages/protocol/src/utils/ProvableHashList.ts:152


fastForward()

fastForward(transition, message): void

Fast-forwards the state of the hashlist to a specified new tip. This assumes the transition (from -> to) to be already verified somewhere else that is outside this scope.

Parameters

transition: VerifiedTransition<Field>

message: string = "some hashlist"

Returns

void

Inherited from

DefaultProvableHashList.fastForward

Defined in

packages/protocol/src/utils/ProvableHashList.ts:62


fastForwardIf()

fastForwardIf(transition, condition, message): void

Parameters

transition: VerifiedTransition<Field>

condition: Bool

message: string = "some hashlist"

Returns

void

Inherited from

DefaultProvableHashList.fastForwardIf

Defined in

packages/protocol/src/utils/ProvableHashList.ts:75


getUnconstrainedValues()

getUnconstrainedValues(): Unconstrained<ProvableHashListData<NonMethods<AppliedStateTransitionBatch>>[]>

Returns

Unconstrained<ProvableHashListData<NonMethods<AppliedStateTransitionBatch>>[]>

Inherited from

DefaultProvableHashList.getUnconstrainedValues

Defined in

packages/protocol/src/utils/ProvableHashList.ts:140


hash()

hash(elements): Field

Parameters

elements: Field[]

Returns

Field

Inherited from

DefaultProvableHashList.hash

Defined in

packages/protocol/src/utils/ProvableHashList.ts:148


isEmpty()

isEmpty(): Bool

Returns

Bool

Inherited from

DefaultProvableHashList.isEmpty

Defined in

packages/protocol/src/utils/ProvableHashList.ts:136


push()

push(value): AppliedBatchHashList

Converts the provided value to Field[] and appends it to the current hashlist.

Parameters

value: AppliedStateTransitionBatch

Value to be appended to the hash list

Returns

AppliedBatchHashList

Current hash list.

Overrides

DefaultProvableHashList.push

Defined in

packages/protocol/src/prover/accumulators/AppliedBatchHashList.ts:25


pushIf()

pushIf(value, condition): AppliedBatchHashList

Parameters

value: AppliedStateTransitionBatch

condition: Bool

Returns

AppliedBatchHashList

Overrides

DefaultProvableHashList.pushIf

Defined in

packages/protocol/src/prover/accumulators/AppliedBatchHashList.ts:29


toField()

toField(): Field

Returns

Field

Traling hash of the current hashlist.

Inherited from

DefaultProvableHashList.toField

Defined in

packages/protocol/src/utils/ProvableHashList.ts:132


witnessTip()

witnessTip(preimage, value): Bool

Parameters

preimage: Field

value: NonMethods<AppliedStateTransitionBatch>

Returns

Bool

Inherited from

DefaultProvableHashList.witnessTip

Defined in

packages/protocol/src/utils/ProvableHashList.ts:93