mirror of
https://github.com/ethereum/go-ethereum.git
synced 2026-06-21 06:04:33 +00:00
eda3b59f67
## Why this should be merged
Allows for modification of `types.Body` payload data + RLP encoding
without placing the entire RLP burden on the `libevm` user as we did
with `types.HeaderHooks`.
## How this works
RLP encoding of a struct is simply a concatenation of RLP encodings of
fields, encompassed by an RLP "list". The
`AppendRLPFields(rlp.EncoderBuffer, ...)` hook exploits this and plugs
in before all `rlp:"optional"`-tagged fields to allow for inclusion of
any new fields. The `EncoderBuffer` SHOULD be used as the `io.Writer`
passed when encoding each field: `rlp.Encode(buffer, fieldValue)`.
`Body` doesn't have `{En,De}codeRLP` methods so they are implemented to
identically replicate original behaviour when a no-op hook is present.
This pattern is sufficient for the `ava-labs/coreth` modifications of
`Body` but can be modified / extended for more complex scenarios, like
`Header`.
> [!NOTE]
> This PR does not include registration of the hooks as that was not the
initial goal and adding them would create too much PR bloat. There is a
placeholder `var todoRegisteredBodyHooks` global variable that can only
be set in tests.
## How this was tested
- Backwards compatibility: the new methods are fuzzed against a `type
withoutMethods Body` passed directly to `rlp.{En,De}code()`
- `coreth` compatibility: unit test of a local implementation of
`BodyHooks` demonstrating reproducibility of RLP encoding.
---------
Signed-off-by: Arran Schlosberg <519948+ARR4N@users.noreply.github.com>
Co-authored-by: Quentin McGaw <quentin.mcgaw@avalabs.org>
66 lines
1.9 KiB
Go
66 lines
1.9 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 cmpeth provides ETH-specific options for the cmp package.
|
|
package cmpeth
|
|
|
|
import (
|
|
"bytes"
|
|
"testing"
|
|
|
|
"github.com/google/go-cmp/cmp"
|
|
|
|
"github.com/ava-labs/libevm/core/types"
|
|
)
|
|
|
|
// CompareHeadersByHash returns an option to compare Headers based on
|
|
// [types.Header.Hash] equality.
|
|
func CompareHeadersByHash() cmp.Option {
|
|
return cmp.Comparer(func(a, b *types.Header) bool {
|
|
return a.Hash() == b.Hash()
|
|
})
|
|
}
|
|
|
|
// CompareTransactionsByBinary returns an option to compare Transactions based
|
|
// on [types.Transaction.MarshalBinary] equality. Two nil pointers are
|
|
// considered equal.
|
|
//
|
|
// If MarshalBinary() returns an error, it will be reported with
|
|
// [testing.TB.Fatal].
|
|
func CompareTransactionsByBinary(tb testing.TB) cmp.Option {
|
|
tb.Helper()
|
|
return cmp.Comparer(func(a, b *types.Transaction) bool {
|
|
tb.Helper()
|
|
|
|
if a == nil && b == nil {
|
|
return true
|
|
}
|
|
if a == nil || b == nil {
|
|
return false
|
|
}
|
|
|
|
return bytes.Equal(marshalTxBinary(tb, a), marshalTxBinary(tb, b))
|
|
})
|
|
}
|
|
|
|
func marshalTxBinary(tb testing.TB, tx *types.Transaction) []byte {
|
|
tb.Helper()
|
|
buf, err := tx.MarshalBinary()
|
|
if err != nil {
|
|
tb.Fatalf("%T.MarshalBinary() error %v", tx, err)
|
|
}
|
|
return buf
|
|
}
|