[Canyon Hard Fork] Receipt Root Deposit Nonce Hashing Bug Fix

[pcw109550]

All codes referenced from

• post-Canyon receipt-root deposit tx hashing fix ethereum-optimism/op-geth#152
• fix receipt json marshaling/unmarshaling ethereum-optimism/op-geth#167

Description

This PR fixes two issues.

Issue 1: Receipt Root Deposit Nonce Hashing Bug

When receipt is hashed and alters receipt root, method EncodeIndex is invoked.

op-erigon/core/types/receipt.go

Line 489 in 91382cb

func (rs Receipts) EncodeIndex(i int, w *bytes.Buffer) {

When receipt is generated from deposit tx, following case will be executed.

op-erigon/core/types/receipt.go

Lines 508 to 512 in 91382cb

	case DepositTxType:
	w.WriteByte(DepositTxType)
	if err := rlp.Encode(w, data); err != nil {
	panic(err)
	}

receiptRLP struct does not contain DepositNonce field, resulting in not including DepositNonce to receipt root. We must use depositReceiptRLP struct to correctly encode deposit receipts into receipt root. For backwards compatibility, we add DepositReceiptVersion field to receipts.

• Canyon: DepositReceiptVersion is not nil. Encode using depositReceiptRLP
• Pre-Canyon: DepositReceiptVersion is nil. Encode using receiptRLP.

Ran

codecgen -o receipt_codecgen_gen.go -r "^Receipts$|^Receipt$|^Logs$|^Log$" -st "codec" -j=false -nx=true -ta=true -oe=false -d 2 receipt.go log.go

to update cbor encoding/decoding code.

Issue 2: Receipt JSON Marshaling/Unmarshaling Bug

When receipt is JSON marshalled, it uses receiptMarshaling struct. Based on this, gencodec generates MarshalJSON() method. This custom method will be called when json.Marshal is called to receipt.

receiptMarshaling struct did not contain optimism related fields. Added them for correct json marshaling for optimism.

Ran

gencodec -type Receipt -field-override receiptMarshaling -out gen_receipt_json.go

to update autogenerated codes.

Testing

Unit tests added.

Misc

No erigon-lib update.

[ImTei]

left some comments about code style - not mandatory.