fix: use both traceStartBlock calls where appropriate

[lu-pinto]

I rolled back usage of traceStartBlock(BlockHeader, BlockBody, Address) where appropriate because I feel we shouldn't be changing TraceServiceImpl on the Besu side just to fix the linea tracer. This avoids an inconsistency between traceStartBlock and traceEndBlock and also opening a can of worms going through yet another round of consensus as to why it was done like that in the first place.

I see that your tracer implementations were implementing both cases at the same time, so it's hard to see which is definitely being used, but given that we have to modify TraceServiceImpl to make things work I would say traceStartBlock(BlockHeader, BlockBody) was definitely being used.

Also with this you don't need another release from linea-besu to make the tracer work as both traceStartBlock(BlockHeader, BlockBody, Address) and traceStartBlock(ProcessableBlockHeader, Address) already exist.

[cla-assistant]

All committers have signed the CLA.

[cla-assistant]

Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
_{You have signed the CLA already but the status is still pending? Let us recheck it.}

[OlivierBBB]

Here you use the 2 parameter variant of traceStartBlock ?

[lu-pinto]

Yes, if you look at how it was before it was like this: https://github.com/Consensys/linea-tracer/pull/1694/files#diff-72836d8f02f4d5b6e4bfe40f1d1f199abcfefab3f5326c30d4c5e2c40808623fL185-L194

[OlivierBBB]

I rolled back usage of traceStartBlock(BlockHeader, BlockBody, Address) where appropriate

It seems that on the contrary we are now using traceStartBlock(BlockHeader, BlockBody, Address) far more than before, no ?

[OlivierBBB]

Also I count 15 occurrences of the previously dominant signature

traceStartBlock(BlockHeader, Address)

In the repo (prior to this PR.) Will those have to be switched over to

traceStartBlock(BlockHeader, BlockBody, Address)

?

[lu-pinto]

I rolled back usage of traceStartBlock(BlockHeader, BlockBody, Address) where appropriate

It seems that on the contrary we are now using traceStartBlock(BlockHeader, BlockBody, Address) far more than before, no ?

I did a grep for occurrences of traceStartBlock and it seems we are using the same amount:

$ git checkout c8748ddc^
$ grep -r -A 1 'traceStartBlock' reference-tests/src/ arithmetization/src/ testing/src/
./reference-tests/src/test/java/net/consensys/linea/GeneralStateReferenceTestTools.java:    zkTracer.traceStartBlock(blockHeader, blockBody);
./reference-tests/src/test/java/net/consensys/linea/BlockchainReferenceTestTools.java:        zkTracer.traceStartBlock(block.getHeader());
./arithmetization/src/main/java/net/consensys/linea/zktracer/ConflationAwareOperationTracer.java:    public void traceStartBlock(final BlockHeader blockHeader, final BlockBody blockBody) {
./arithmetization/src/main/java/net/consensys/linea/zktracer/ConflationAwareOperationTracer.java:      this.tracers.forEach(tracer -> tracer.traceStartBlock(blockHeader, blockBody));
./arithmetization/src/main/java/net/consensys/linea/zktracer/ConflationAwareOperationTracer.java:    public void traceStartBlock(final ProcessableBlockHeader processableBlockHeader) {
./arithmetization/src/main/java/net/consensys/linea/zktracer/ConflationAwareOperationTracer.java:      this.tracers.forEach(tracer -> tracer.traceStartBlock(processableBlockHeader));
./arithmetization/src/main/java/net/consensys/linea/zktracer/module/txndata/TxnData.java:  public final void traceStartBlock(final ProcessableBlockHeader blockHeader) {
./arithmetization/src/main/java/net/consensys/linea/zktracer/module/DebugMode.java:  public void traceStartBlock(ProcessableBlockHeader processableBlockHeader, final BlockBody body) {
./arithmetization/src/main/java/net/consensys/linea/zktracer/module/hub/Hub.java:  public void traceStartBlock(final ProcessableBlockHeader processableBlockHeader) {
./arithmetization/src/main/java/net/consensys/linea/zktracer/module/hub/Hub.java:      m.traceStartBlock(processableBlockHeader);
./arithmetization/src/main/java/net/consensys/linea/zktracer/module/blockhash/Blockhash.java:  public void traceStartBlock(final ProcessableBlockHeader processableBlockHeader) {
./arithmetization/src/main/java/net/consensys/linea/zktracer/container/module/Module.java:  default void traceStartBlock(final ProcessableBlockHeader processableBlockHeader) {}
./arithmetization/src/main/java/net/consensys/linea/zktracer/ZkTracer.java:  public void traceStartBlock(final ProcessableBlockHeader processableBlockHeader) {
./arithmetization/src/main/java/net/consensys/linea/zktracer/ZkTracer.java:      this.hub.traceStartBlock(processableBlockHeader);
./arithmetization/src/main/java/net/consensys/linea/zktracer/ZkTracer.java:  public void traceStartBlock(final BlockHeader blockHeader, final BlockBody blockBody) {
./arithmetization/src/main/java/net/consensys/linea/zktracer/ZkTracer.java:      this.hub.traceStartBlock(blockHeader);
./arithmetization/src/main/java/net/consensys/linea/zktracer/ZkTracer.java:      this.debugMode.ifPresent(x -> x.traceStartBlock(blockHeader, blockBody));
./arithmetization/src/main/java/net/consensys/linea/blockcapture/BlockCapturer.java:  public void traceStartBlock(BlockHeader blockHeader, BlockBody blockBody) {
./testing/src/main/java/net/consensys/linea/testing/ReplayExecutionEnvironment.java:      tracer.traceStartBlock(header, body);
./testing/src/main/java/net/consensys/linea/testing/GeneralStateReferenceTestTools.java:    tracer.traceStartBlock(blockHeader, blockBody);

$ git checkout fix/trace-start-block
$ grep -r -A 1 'traceStartBlock' reference-tests/src/ arithmetization/src/ testing/src/
reference-tests/src//test/java/net/consensys/linea/GeneralStateReferenceTestTools.java:    zkTracer.traceStartBlock(blockHeader, blockBody, blockHeader.getCoinbase());
reference-tests/src//test/java/net/consensys/linea/BlockchainReferenceTestTools.java:        zkTracer.traceStartBlock(block.getHeader(), block.getHeader().getCoinbase());
arithmetization/src//main/java/net/consensys/linea/zktracer/ConflationAwareOperationTracer.java:    public void traceStartBlock(final BlockHeader blockHeader, final BlockBody blockBody, final Address miningBeneficiary) {
arithmetization/src//main/java/net/consensys/linea/zktracer/ConflationAwareOperationTracer.java:          tracer -> tracer.traceStartBlock(blockHeader, blockBody, miningBeneficiary));
arithmetization/src//main/java/net/consensys/linea/zktracer/ConflationAwareOperationTracer.java:    public void traceStartBlock(final ProcessableBlockHeader processableBlockHeader, final Address miningBeneficiary) {
arithmetization/src//main/java/net/consensys/linea/zktracer/ConflationAwareOperationTracer.java:          tracer -> tracer.traceStartBlock(processableBlockHeader, miningBeneficiary));
arithmetization/src//main/java/net/consensys/linea/zktracer/module/txndata/TxnData.java:  public final void traceStartBlock(final ProcessableBlockHeader blockHeader, final Address miningBeneficiary) {
arithmetization/src//main/java/net/consensys/linea/zktracer/module/DebugMode.java:  public void traceStartBlock(ProcessableBlockHeader processableBlockHeader,
arithmetization/src//main/java/net/consensys/linea/zktracer/module/hub/Hub.java:  public void traceStartBlock(final ProcessableBlockHeader processableBlockHeader, final Address miningBeneficiary) {
arithmetization/src//main/java/net/consensys/linea/zktracer/module/hub/Hub.java:      m.traceStartBlock(processableBlockHeader, miningBeneficiary);
arithmetization/src//main/java/net/consensys/linea/zktracer/module/blockhash/Blockhash.java:  public void traceStartBlock(final ProcessableBlockHeader processableBlockHeader, final Address miningBeneficiary) {
arithmetization/src//main/java/net/consensys/linea/zktracer/container/module/Module.java:  default void traceStartBlock(final ProcessableBlockHeader processableBlockHeader, final Address miningBeneficiary) {}
arithmetization/src//main/java/net/consensys/linea/zktracer/ZkTracer.java:  public void traceStartBlock(final ProcessableBlockHeader processableBlockHeader, final Address miningBeneficiary) {
arithmetization/src//main/java/net/consensys/linea/zktracer/ZkTracer.java:      this.hub.traceStartBlock(processableBlockHeader, miningBeneficiary);
arithmetization/src//main/java/net/consensys/linea/zktracer/ZkTracer.java:  public void traceStartBlock(final BlockHeader blockHeader, final BlockBody blockBody, final Address miningBeneficiary) {
arithmetization/src//main/java/net/consensys/linea/zktracer/ZkTracer.java:      this.hub.traceStartBlock(blockHeader, miningBeneficiary);
arithmetization/src//main/java/net/consensys/linea/zktracer/ZkTracer.java:      this.debugMode.ifPresent(x -> x.traceStartBlock(blockHeader, blockBody, miningBeneficiary));
arithmetization/src//main/java/net/consensys/linea/blockcapture/BlockCapturer.java:  public void traceStartBlock(BlockHeader blockHeader, BlockBody blockBody, final Address miningBeneficiary) {
testing/src//main/java/net/consensys/linea/testing/ReplayExecutionEnvironment.java:      tracer.traceStartBlock(header, body, miningBeneficiary);
testing/src//main/java/net/consensys/linea/testing/GeneralStateReferenceTestTools.java:    tracer.traceStartBlock(blockHeader, blockBody, blockHeader.getCoinbase());

[lu-pinto]

Also I count 15 occurrences of the previously dominant signature

traceStartBlock(BlockHeader, Address)

In the repo (prior to this PR.) Will those have to be switched over to

traceStartBlock(BlockHeader, BlockBody, Address)

?

That's a good question - I don't think you will have to do anything from now on. But I suspect that, after this PR, you have some trace methods declared that are not used. But at the same time I want to avoid having to change TraceServiceImpl just for that

[OlivierBBB]

LGTM

[sonarqubecloud]

Quality Gate passed

Issues
1 New issue
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud