mirror of
https://github.com/ethereum/go-ethereum.git
synced 2026-06-24 07:34:31 +00:00
35926db4d6
## Why this should be merged Registration of extras requires runtime enforcement of payload types. In production, only a single set of types can be registered and any attempts at re-registration will panic (by design). Although this makes production usage safe, it doesn't allow downstream consumers (e.g. data indexers) to use extras from different chains (e.g. `coreth` _and_ `subnet-evm`) at the same time. ## How this works 1. The `libevm/register.AtMostOnce` type can now be overridden temporarily. 2. `params`, `core/types`, `core/vm`, and `state` packages introduce `WithTempRegisteredExtras()` functions. 3. `libevm/temporary.WithRegisteredExtras()` provides "atomic" override of all extras. In all cases, the scope of the override is limited to the life of a single function call. ## How this was tested Relative to numbered list above: 1. Unit test of new and existing functionality. 2. Integration tests of both packages, demonstrating both payload and behavioural override.
65 lines
2.3 KiB
Go
65 lines
2.3 KiB
Go
// Copyright 2025 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 temporary provides thread-safe, temporary registration of all libevm
|
|
// hooks and payloads.
|
|
package temporary
|
|
|
|
import (
|
|
"sync"
|
|
|
|
"github.com/ava-labs/libevm/core/state"
|
|
"github.com/ava-labs/libevm/core/types"
|
|
"github.com/ava-labs/libevm/core/vm"
|
|
"github.com/ava-labs/libevm/params"
|
|
)
|
|
|
|
var mu sync.Mutex
|
|
|
|
// WithRegisteredExtras takes a global lock and temporarily registers [params],
|
|
// [state], [types], and [vm] extras before calling the provided function. It
|
|
// can be thought of as an atomic call to all functions equivalent to
|
|
// [params.WithTempRegisteredExtras].
|
|
//
|
|
// This is the *only* safe way to override libevm functionality. Direct calls to
|
|
// the package-specific temporary registration functions are not advised.
|
|
//
|
|
// WithRegisteredExtras MUST NOT be used on a live chain. It is solely intended
|
|
// for off-chain consumers that require access to extras.
|
|
func WithRegisteredExtras[
|
|
C params.ChainConfigHooks, R params.RulesHooks,
|
|
H, B, SA any,
|
|
HPtr types.HeaderHooksPointer[H],
|
|
BPtr types.BlockBodyHooksPointer[B, BPtr],
|
|
](
|
|
paramsExtras params.Extras[C, R],
|
|
sdbHooks state.StateDBHooks,
|
|
vmHooks vm.Hooks,
|
|
fn func(params.ExtraPayloads[C, R], types.ExtraPayloads[HPtr, BPtr, SA]),
|
|
) {
|
|
mu.Lock()
|
|
defer mu.Unlock()
|
|
|
|
params.WithTempRegisteredExtras(paramsExtras, func(paramsPayloads params.ExtraPayloads[C, R]) {
|
|
types.WithTempRegisteredExtras(func(typesPayloads types.ExtraPayloads[HPtr, BPtr, SA]) {
|
|
state.WithTempRegisteredExtras(sdbHooks, func() {
|
|
vm.WithTempRegisteredHooks(vmHooks, func() {
|
|
fn(paramsPayloads, typesPayloads)
|
|
})
|
|
})
|
|
})
|
|
})
|
|
}
|