Refactor/refactor provable types by saitunc · Pull Request #388 · proto-kit/framework

saitunc · 2026-01-12T10:44:35Z

Changes

In this PR, it is aimed to convert from provable types to non-provable types in out-of-circuit code.

Starting point changes in this refactoring was to implement or convert to JSON type of the followings:

Block
BlockWithResult

And since they are

TransactionExecutionResult
PendingTransaction
StateTransitionBatch
UntypedStateTransition
NetworkState

Especially last 3 is used all around the Sequencing and Tracing modules.

Commits

UntypedStateTransition & StateTransitionBatch

Implement UntypedStateTransitionJson 0199877 ( rename: 5934a13 )
Implement in block and tracing services 0199877
Change in tracing, block result services 5934a13

TransactionExecutionResult

Implemented Json interface, TransactionExecutionResultJson b017bb5
Implement conversion function between json type and provable type to use when needed 08f95bb
Changed in execution and tracing 564ba7a
Changed in Prisma storage 6905b36
Changed in various modules fb4c854

PendingTransaction

Changed in PrivateMempool d3c9336
Changed in various modules d5b6d7b
Changed in storage and mempool d8558f9
Changed in execution and tracing 564ba7a

NetworkState

Define NetworkStateJson by inferring it from Struct c29a51d
add RuntimeProofParametersJson type with NetworkStateJson and PendingTransactionJsonType a4ac392

Miscellanous

refactor CllientBlock with value types 1093afe

#### Test

Updated changes in test files 57ad69d

This PR closes #201

…on to

packages/sequencer/src/mempool/PendingTransaction.ts

…provable-types

packages/sequencer/src/protocol/production/sequencing/BlockProducerModule.ts

packages/sequencer/src/protocol/production/tracing/BlockTracingService.ts

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

packages/sequencer/src/protocol/production/helpers/UntypedStateTransition.ts

packages/sequencer/src/protocol/production/sequencing/BlockResultService.ts

packages/indexer/src/IndexerNotifier.ts

rpanic · 2026-01-23T10:21:06Z

packages/indexer/test/IndexerNotifier.test.ts

    );

-    console.log("tx nonce", tx.transaction?.nonce.toBigInt());
+    console.log("tx nonce", (tx.transaction as PendingTransaction).nonce);


Why do you do this? tx should already be of type PendingTransaction, no?

rpanic · 2026-01-23T11:01:54Z

packages/persistance/src/services/prisma/mappers/EventMapper.ts

 import { ObjectMapper } from "../../../ObjectMapper";

-type EventData = {
+type EventDataJson = {


I think we should leave this as EventData - there's not provable version of it, so that name is fine imo

rpanic · 2026-01-23T11:03:15Z

packages/persistance/test-integration/PrismaBlockProduction.test.ts


+      let txHash: string;
+
+      if (transaction.transaction instanceof PendingTransaction) {


Whaat - why do we have this conditional in a test?

rpanic · 2026-01-23T11:04:35Z

packages/processor/src/triggers/TimedProcessorTrigger.ts

    }

-    if (lastProcessedBlockHeight === Number(block?.block.height.toBigInt())) {
+    if (lastProcessedBlockHeight === Number(block?.block.height)) {


Can't we skip this cast to number since it's already a number?

rpanic · 2026-01-23T14:11:09Z

packages/sequencer/src/settlement/messages/MinaIncomingMessageAdapter.ts

    const args = await methodEncoder.decode(fieldArgs, []);

    const { fields, auxiliary } = methodEncoder.encode(args);
+    const hash = Poseidon.hash([


Like I mentioned in PendingTransaction.ts, we shouldn't do this!

rpanic · 2026-01-23T14:13:14Z

packages/sequencer/test/integration/BlockProduction-test.ts

-      latestBlockWithResult.result.afterNetworkState.hash().toString()
-    ).toStrictEqual(batch!.toNetworkState.hash().toString());
+      new ProvableNetworkState(
+        ProvableNetworkState.fromJSON(


We have these 5 lines at least 20 times in the codebase - should we make NetworkState a class and implement toProvable and fromProvable on it?

Not sure - even though toProvable and fromProvable will be good to remove these parts, we could need fromJson and toJson in that class too.

Maybe not though, have to check where NetworkState is used.

rpanic · 2026-01-23T14:14:21Z

packages/sequencer/src/mempool/PendingTransaction.ts

+interface PendingTransactionJSONType {
+  hash: string;
+  methodId: string;
+  nonce: string;


Why is nonce a string? It should be a number

rpanic · 2026-01-23T14:16:43Z

packages/sequencer/test/settlement/Settlement-only.ts

  async function createBatch(
    withTransactions: boolean,
    customNonce: number = 0,
+    // Why is it like this?


What are you referring to?

A note for myself that where i thought of using PendingTransaction as json, this line will be removed.

rpanic · 2026-01-23T14:17:38Z

packages/stack/test/graphql/graphql.test.ts


-    const txHash = tx.transaction?.hash().toString()!;
+    const txHash =
+      tx.transaction instanceof UnsignedTransaction


Yeah no, we need to fix the PendingTransaction implementation :)

saitunc and others added 30 commits January 7, 2026 10:34

feat: add type alias for FieldString and helper function for it

d2e2160

refactor: change Field typed properties to FieldString type

4336578

refactor: update codebase to use string properties of Block

be7c06e

refactor: allow Field in FieldString input

86f87db

refactor: Infer JSON type of NetworkState and use in Block interface

c29a51d

refactor: update codebase for use of NetworkStateJson type

adc99a0

refactor: remove unnecessary stringifications and type conversions

2483e82

refactor: change use of NetworkState to NetworkStateJson in codebase

ae96af1

refactor: refactor ClientBlock and used parts in codebase

1093afe

refactor: update UntypedStateTransition with UntypedSTJson

0199877

refactor: add utility function for hashing NetworkStateJson values

76e1417

refactor: apply refactoring where NetworkStateJson is used

55d5dec

refactor: add BlockHahMerkleTreewitnessJson and refactor with it

78aae19

refactor: refactor BlockMapper and BlockResultMapper with new types

31db4aa

refactor: update methodId type to string

7706aa3

refactor: add minor change to use methodId

b46e81d

refactor: rename UntypedSTJson to UntypedStateTranisitionJson

5934a13

refactor: implement TransactionExecutionResultJson and use it for Block

b017bb5

refactor: refactor PrivateMempool to use PendingTransactionJson type

d3c9336

refactor: add serialization utility functions for non-provable types

08f95bb

refactor: use non-provable types in storage and mempool interfaces

d8558f9

refactor:use non-provable types in execution and tracing services

564ba7a

refactor: update Prisma interactions to use non-provable types

6905b36

refactor: use non-provable types in object mappers

fb4c854

refactor: update PendingTransaction related code PendingTransactionJs…

d5b6d7b

…on to

refactor(test): update with changes in codebase

57ad69d

refactor: use non-provable types in tracing and task layers

a4ac392

refactor: use non-provable types in tracing services

bc53d88

style: run lint fix

57c3520

Merge branch 'develop' into refactor/refactor-provable-types

08e7d35

saitunc added 13 commits January 19, 2026 00:01

refactor(fix): fix use of PendingTransaction attributes

8053677

refactor: remove STBatchFromJson and fix UntypedStateTransition code

f8bb8e2

refactor: update RuntimeProofParameters and TaskStateRecord

4ed3853

refactor(fix): fix missing changes on refactored non-provable code

a959f99

refactor: add helper methods to UntypedOption and UntypedStateTransition

0c38966

refactor: flatten PendingTransaction like UnsignedTransaction

019591f

refactor: update code using PendingTransaction

9fd7a92

refactor: make decode to take string array as input

cbecb5a

refactor: remove unnecessary lines and fix mappings

44e9ea6

style: run lint fix

4f776a7

fix(test): fix test code to pass

cb059f4

refactor: use JSONTaskSerializer for RuntimeProofParameters

81c0df7

style: run lint fix

92ee61b

saitunc commented Jan 20, 2026

View reviewed changes

packages/sequencer/src/mempool/PendingTransaction.ts Show resolved Hide resolved

refactor: minor line changes

9ef4aea

saitunc requested a review from rpanic January 20, 2026 10:55

saitunc added 7 commits January 20, 2026 15:09

refactor: remove block and pendingTx serializers

39505c8

style: run lint fix

3f72d18

refactor(fix): fix mistaken conversions and fix lint errors

e3789b8

refactor: use JSONTaskSerializer in batch and settlement tasks

d636e67

Merge remote-tracking branch 'origin/develop' into refactor/refactor-…

2b8bd2d

…provable-types

style: fix lint errors

fe529bd

refactor: assign networkState to variable to avoid repetition

3b08e94

rpanic reviewed Jan 22, 2026

View reviewed changes

saitunc added 5 commits January 23, 2026 14:23

Merge branch 'develop' into refactor/refactor-provable-types

6a7899b

refactor: update and fix UntypedOption and UntypedStateTransition

851d36e

refactor: refactor codebase for updated classes

c944bdd

refactor: get ProvableOption values from fromJSON method

e5f1fbd

style: run lint fix

ffac7b6

rpanic reviewed Jan 23, 2026

View reviewed changes


		let txHash: string;

		if (transaction.transaction instanceof PendingTransaction) {

Conversation

saitunc commented Jan 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes

Commits

UntypedStateTransition & StateTransitionBatch

TransactionExecutionResult

PendingTransaction

NetworkState

Miscellanous

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Comments

saitunc commented Jan 12, 2026 •

edited

Loading