@proto-kit/protocolDocs


Documentation / @proto-kit/protocol / TransactionHashList

Class: TransactionHashList

Utilities for creating a hash list from a given value type.

Extends

Constructors

new TransactionHashList()

new TransactionHashList(commitment): TransactionHashList

Parameters

commitment: Field = ...

Returns

TransactionHashList

Overrides

DefaultProvableHashList.constructor

Defined in

packages/protocol/src/prover/accumulators/TransactionHashList.ts:6

Properties

commitment

commitment: Field

Inherited from

DefaultProvableHashList.commitment

Defined in

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


valueType

protected readonly valueType: ProvablePure<Field>

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<Field>[]>

Returns

Unconstrained<ProvableHashListData<Field>[]>

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): TransactionHashList

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

Parameters

value: Field

Value to be appended to the hash list

Returns

TransactionHashList

Current hash list.

Inherited from

DefaultProvableHashList.push

Defined in

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


pushIf()

pushIf(value, condition): TransactionHashList

Parameters

value: Field

condition: Bool

Returns

TransactionHashList

Inherited from

DefaultProvableHashList.pushIf

Defined in

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


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: Field

Returns

Bool

Inherited from

DefaultProvableHashList.witnessTip

Defined in

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