go-ethereum/core/state/statedb.libevm_test.go
Arran Schlosberg 3a754099bf
feat: state.SnapshotTree interface for drop-in replacement (#77)
## Why this should be merged

Allows for a drop-in replacement of `snapshot.Tree` (i.e. one that uses
block hashes instead of state roots). This is intended as a temporary
solution while we investigate having the state root affected by the
block hash to remove path ambiguity.

## How this works

Introduction of:
1. `state.SnapshotTree` interface to match methods required on
`snapshot.Tree` as used by `state.StateDB`; and
2. `stateconf` package for variadic options plumbed by
`StateDB.Commit()` through to `SnapshotTree.Update()`.

Although variadic (to maintain function call-signature compatibility)
only the `stateconf.WithUpdatePayload(any)` is expected to be used.
Recipients of the options can access the payload with
`stateconf.ExtractUpdatePayload()`.

## How this was tested

Unit test demonstrating propagation of `stateconf.UpdateOption` payload.
2024-11-26 17:22:13 +00:00

80 lines
2.3 KiB
Go

// Copyright 2024 the libevm authors.
//
// The libevm additions to go-ethereum are free software: you can redistribute
// them and/or modify them under the terms of the GNU Lesser General Public License
// as published by the Free Software Foundation, either version 3 of the License,
// or (at your option) any later version.
//
// The libevm additions are distributed in the hope that they will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser
// General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with the go-ethereum library. If not, see
// <http://www.gnu.org/licenses/>.
package state
import (
"testing"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"github.com/ava-labs/libevm/common"
"github.com/ava-labs/libevm/core/rawdb"
"github.com/ava-labs/libevm/core/state/snapshot"
"github.com/ava-labs/libevm/core/types"
"github.com/ava-labs/libevm/libevm/stateconf"
)
func TestStateDBCommitPropagatesOptions(t *testing.T) {
var rec snapTreeRecorder
sdb, err := New(types.EmptyRootHash, NewDatabase(rawdb.NewMemoryDatabase()), &rec)
require.NoError(t, err, "New()")
// Ensures that rec.Update() will be called.
sdb.SetNonce(common.Address{}, 42)
const payload = "hello world"
opt := stateconf.WithUpdatePayload(payload)
_, err = sdb.Commit(0, false, opt)
require.NoErrorf(t, err, "%T.Commit(..., %T)", sdb, opt)
assert.Equalf(t, payload, rec.gotPayload, "%T payload propagated via %T.Commit() to %T.Update()", opt, sdb, rec)
}
type snapTreeRecorder struct {
SnapshotTree
gotPayload any
}
func (*snapTreeRecorder) Cap(common.Hash, int) error {
return nil
}
func (r *snapTreeRecorder) Update(
_, _ common.Hash,
_ map[common.Hash]struct{}, _ map[common.Hash][]byte, _ map[common.Hash]map[common.Hash][]byte,
opts ...stateconf.SnapshotUpdateOption,
) error {
r.gotPayload = stateconf.ExtractUpdatePayload(opts...)
return nil
}
func (*snapTreeRecorder) Snapshot(common.Hash) snapshot.Snapshot {
return snapshotStub{}
}
type snapshotStub struct {
snapshot.Snapshot
}
func (snapshotStub) Account(common.Hash) (*types.SlimAccount, error) {
return &types.SlimAccount{}, nil
}
func (snapshotStub) Root() common.Hash {
return common.Hash{}
}