From 1da7d700c737e19e864b74f04d33bb39073fdcef Mon Sep 17 00:00:00 2001 From: Quentin Mc Gaw Date: Mon, 10 Feb 2025 16:45:16 +0100 Subject: [PATCH 1/2] chore!(core/types): change method names of JSON header hooks - MarshalJSON -> EncodeJSON - UnmarshalJSON -> DecodeJSON - Placates the gopls forced linter - Aligns with EncodeRLP and DecodeRLP hook functions --- core/types/block.libevm.go | 12 ++++++------ core/types/block.libevm_test.go | 4 ++-- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/core/types/block.libevm.go b/core/types/block.libevm.go index 832fe421f0a..dc11907e998 100644 --- a/core/types/block.libevm.go +++ b/core/types/block.libevm.go @@ -29,8 +29,8 @@ import ( // HeaderHooks are required for all types registered with [RegisterExtras] for // [Header] payloads. type HeaderHooks interface { - MarshalJSON(*Header) ([]byte, error) //nolint:govet // Type-specific override hook - UnmarshalJSON(*Header, []byte) error //nolint:govet + EncodeJSON(*Header) ([]byte, error) // Type-specific override hook + DecodeJSON(*Header, []byte) error EncodeRLP(*Header, io.Writer) error DecodeRLP(*Header, *rlp.Stream) error PostCopy(dst *Header) @@ -58,12 +58,12 @@ var _ interface { // MarshalJSON implements the [json.Marshaler] interface. func (h *Header) MarshalJSON() ([]byte, error) { - return h.hooks().MarshalJSON(h) + return h.hooks().EncodeJSON(h) } // UnmarshalJSON implements the [json.Unmarshaler] interface. func (h *Header) UnmarshalJSON(b []byte) error { - return h.hooks().UnmarshalJSON(h, b) + return h.hooks().DecodeJSON(h, b) } // EncodeRLP implements the [rlp.Encoder] interface. @@ -94,11 +94,11 @@ type NOOPHeaderHooks struct{} var _ HeaderHooks = (*NOOPHeaderHooks)(nil) -func (*NOOPHeaderHooks) MarshalJSON(h *Header) ([]byte, error) { //nolint:govet +func (*NOOPHeaderHooks) EncodeJSON(h *Header) ([]byte, error) { return h.marshalJSON() } -func (*NOOPHeaderHooks) UnmarshalJSON(h *Header, b []byte) error { //nolint:govet +func (*NOOPHeaderHooks) DecodeJSON(h *Header, b []byte) error { return h.unmarshalJSON(b) } diff --git a/core/types/block.libevm_test.go b/core/types/block.libevm_test.go index e8992676732..84f13984e6c 100644 --- a/core/types/block.libevm_test.go +++ b/core/types/block.libevm_test.go @@ -51,11 +51,11 @@ func fakeHeaderRLP(h *Header, suffix []byte) []byte { return append(crypto.Keccak256(h.ParentHash[:]), suffix...) } -func (hh *stubHeaderHooks) MarshalJSON(h *Header) ([]byte, error) { //nolint:govet +func (hh *stubHeaderHooks) EncodeJSON(h *Header) ([]byte, error) { return fakeHeaderJSON(h, hh.suffix), hh.errMarshal } -func (hh *stubHeaderHooks) UnmarshalJSON(h *Header, b []byte) error { //nolint:govet +func (hh *stubHeaderHooks) DecodeJSON(h *Header, b []byte) error { hh.gotRawJSONToUnmarshal = b *h = hh.setHeaderToOnUnmarshalOrDecode return hh.errUnmarshal From 6c1ff62afd5d45fac3a506ff50299ed1d707cf07 Mon Sep 17 00:00:00 2001 From: Quentin McGaw Date: Mon, 10 Feb 2025 17:42:22 +0100 Subject: [PATCH 2/2] remove now unneeded nolint comment Co-authored-by: Arran Schlosberg <519948+ARR4N@users.noreply.github.com> Signed-off-by: Quentin McGaw --- core/types/block.libevm.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/core/types/block.libevm.go b/core/types/block.libevm.go index dc11907e998..ca5413a61fc 100644 --- a/core/types/block.libevm.go +++ b/core/types/block.libevm.go @@ -29,7 +29,7 @@ import ( // HeaderHooks are required for all types registered with [RegisterExtras] for // [Header] payloads. type HeaderHooks interface { - EncodeJSON(*Header) ([]byte, error) // Type-specific override hook + EncodeJSON(*Header) ([]byte, error) DecodeJSON(*Header, []byte) error EncodeRLP(*Header, io.Writer) error DecodeRLP(*Header, *rlp.Stream) error