feat: add inclusion status to tx-receipt #19733
Conversation
spalladino
added
the
ci-no-fail-fast
spalladino
force-pushed
the
palla/inclusion-status-in-tx-receipt
branch
2 times, most recently
from
c10c9e3 to
c2217cb
Compare
| if (blockNumber <= finalizedBlockNumber) { | ||
| status = TxStatus.FINALIZED; | ||
| } else if (blockNumber <= provenBlockNumber) { | ||
| status = TxStatus.PROVEN; | ||
| } else if (blockNumber <= checkpointedBlockNumber) { | ||
| status = TxStatus.CHECKPOINTED; | ||
| } else { | ||
| status = TxStatus.PROPOSED; | ||
| } |
There was a problem hiding this comment.
Feels like this is going to be used in multiple places in the codebase so maybe it should be a utility in foundation (alongside getFinalizedL2BlockNumber() so that it's easy to change in the future?
There was a problem hiding this comment.
Ah ok, I see this is the source for the 'finalized' definition. Ignore the part about creating helpers in foundation.
| // ); | ||
|
|
||
| expect(txReceipt.status).toBe(TxStatus.SUCCESS); | ||
| expect(txReceipt.isMined() && txReceipt.isSuccess()).toBe(true); |
There was a problem hiding this comment.
Hm, are these flags orthogonal?
There was a problem hiding this comment.
ooo mined=included in a block while success=executed correctly. I'd rename isSuccess to make it clearer. Maybe hasExecutedSuccessfully?
There was a problem hiding this comment.
It's weird because separating the status like this makes think an unmined but successfully executed tx is possible.
There was a problem hiding this comment.
Makes sense. Renamed to hasExecutionSucceeded and hasExecutionReverted.
spalladino
force-pushed
the
palla/inclusion-status-in-tx-receipt
branch
2 times, most recently
from
59968d2 to
342c421
Compare
spalladino
force-pushed
the
palla/inclusion-status-in-tx-receipt
branch
from
342c421 to
fc1c705
Compare
This PR splits
TxReceipt.statusinto two separate fields tobetter distinguish between block finalization level and transaction
execution outcome.
New
TxStatusvalues (block finalization level):DROPPED- Tx dropped by P2P nodePENDING- Tx pending in mempoolPROPOSED- Tx included in a proposed blockCHECKPOINTED- Block checkpointed on L1PROVEN- Checkpoint proven on L1FINALIZED- Proven on a finalized L1 blockNew
TxExecutionResultenum (execution outcome):SUCCESS- Transaction executed successfullyAPP_LOGIC_REVERTED- App logic revertedTEARDOWN_REVERTED- Teardown phase revertedBOTH_REVERTED- Both app logic and teardown revertedThis PR also adds an option to
waitForTxReceiptso that the user can choose the finalization status of the receipt. This is set to default toCHECKPOINTED, so we can preserve old behaviour where we do not proceed with an action until the tx was checkpointed to L1.Key changes:
TxReceiptclass with new fields and helper methods(
isSuccess(),isReverted(),isMined(),isPending(),isDropped())getFinalizedL2BlockNumber()andgetCheckpointedL2BlockNumber()methods
getSettledTxReceiptin BlockStore to determine properfinalization level based on archiver state
waitForStatustoCHECKPOINTED🤖 Generated with Claude Code