feat: use collect mcycle root hashes API

Author: mpolitzer

pkg/emulator/machine.go

@@ -354,7 +354,7 @@ func (m *Machine) Run(mcycleEnd uint64) (BreakReason, error) {
 }
 
 // collect_mcycle_root_hashes
-func (m *Machine) CollectMCycleRootHashes(mcycleEnd, mcyclePeriod, mcyclePhase uint64, log2BundleMcycleCount int32, previousBackTree string) ([]byte, error) {
+func (m *Machine) CollectMCycleRootHashes(mcycleEnd, log2McyclePeriod, mcyclePhase uint64, log2BundleMcycleCount int32, previousBackTree string) ([]byte, error) {
 	var err error
 	var result []byte
 
@@ -368,7 +368,7 @@ func (m *Machine) CollectMCycleRootHashes(mcycleEnd, mcyclePeriod, mcyclePhase u
 		err = newError(C.cm_collect_mcycle_root_hashes(
 			m.ptr,
 			C.uint64_t(mcycleEnd),
-			C.uint64_t(mcyclePeriod),
+			C.uint64_t(log2McyclePeriod),
 			C.uint64_t(mcyclePhase),
 			C.int32_t(log2BundleMcycleCount),
 			previousBackTreeC,

pkg/machine/libcartesi.go

@@ -8,6 +8,7 @@ import (
 	"encoding/json"
 	"errors"
 	"fmt"
+	"math/bits"
 	"time"
 
 	"github.com/cartesi/rollups-node/pkg/emulator"
@@ -28,6 +29,7 @@ type RemoteMachineInterface interface {
 	Delete()
 	ForkServer() (*emulator.RemoteMachine, string, uint32, error)
 	ShutdownServer() error
+	CollectMCycleRootHashes(mcycleEnd, log2McyclePeriod, mcyclePhase uint64, log2BundleMcycleCount int32, previousBackTree string) ([]byte, error)
 }
 
 type proofJson struct {
@@ -230,10 +232,82 @@ func (e *LibCartesiBackend) CmioRxBufferSize() uint64 {
 	return 1 << emulator.CmioRxBufferLog2Size
 }
 
+func decodeBreakReason(s string) BreakReason {
+	switch s {
+	case "yielded_automatically":
+		return YieldedAutomatically
+	case "yielded_manually":
+		return YieldedManually
+	case "yielded_softly":
+		return YieldedSoftly
+	case "reached_target_mcycle":
+		return ReachedTargetMcycle
+	case "halted":
+		return Halted
+	case "failed":
+		return Failed
+	default:
+		return Failed
+	}
+}
+
 func (e *LibCartesiBackend) RunAndCollectRootHashes(
 	mcycleEnd uint64,
 	state *HashCollectorState,
 	timeout time.Duration,
+) (reason BreakReason, err error) {
+	return e.RunAndCollectRootHashesNew(mcycleEnd, state, timeout)
+	//return e.RunAndCollectRootHashesOld(mcycleEnd, state, timeout)
+}
+
+func (e *LibCartesiBackend) RunAndCollectRootHashesNew(
+	mcycleEnd uint64,
+	state *HashCollectorState,
+	timeout time.Duration,
+) (reason BreakReason, err error) {
+
+	// v0.21 API expects log2(mcycle_period) instead of the raw period value
+	// Use exact integer arithmetic: for powers of 2, log2 = position of highest set bit
+	log2Period := uint64(bits.Len64(state.Period) - 1)
+	if (1 << log2Period != state.Period) {
+		return Failed, fmt.Errorf("period must be a power of 2, got %v.", state.Period)
+	}
+
+	rawResult, err := e.inner.CollectMCycleRootHashes(mcycleEnd, log2Period, state.Phase, state.BundleLog2, "")
+	if err != nil {
+		return Failed, err
+	}
+
+	result := struct {
+		RootHashes  []string        `json:"hashes"`
+		MCyclePhase uint64          `json:"mcycle_phase"`
+		BreakReason string          `json:"break_reason"`
+		BackTree    json.RawMessage `json:"back_tree,omitempty"`
+	}{}
+	err = json.Unmarshal(rawResult, &result)
+	if err != nil {
+		return Failed, errors.New("failed to unmarshal CollectMCycleRootHashes result")
+	}
+
+	// convert from base64
+	for i, base64Hash := range result.RootHashes {
+		rawHash, err := base64.StdEncoding.DecodeString(base64Hash)
+		if err != nil {
+			return Failed, err
+		}
+		if len(rawHash) != HashSize {
+			return Failed, fmt.Errorf("received an invalid hash during RunAndCollectRootHashes at index %v, with value: %v.", i, base64Hash)
+		}
+		state.Hashes = append(state.Hashes, (Hash)(rawHash))
+
+	}
+	return decodeBreakReason(result.BreakReason), nil
+}
+
+func (e *LibCartesiBackend) RunAndCollectRootHashesOld(
+	mcycleEnd uint64,
+	state *HashCollectorState,
+	timeout time.Duration,
 ) (reason BreakReason, err error) {
 	if state == nil {
 		return Failed, errors.New("nil state")

pkg/machine/libcartesi_test.go

@@ -486,3 +486,8 @@ func (m *MockRemoteMachine) ShutdownServer() error {
 	args := m.Called()
 	return args.Error(0)
 }
+
+func (m *MockRemoteMachine) CollectMCycleRootHashes(mcycleEnd, log2McyclePeriod, mcyclePhase uint64, log2BundleMcycleCount int32, previousBackTree string) ([]byte, error) {
+	args := m.Called(mcycleEnd, log2McyclePeriod, mcyclePhase, log2BundleMcycleCount, previousBackTree)
+	return args.Get(0).([]byte), args.Error(1)
+}