Go-ethereum 源码解析之 core/types/receipt.go

package types

import (
    "bytes"
    "fmt"
    "io"
    "unsafe"

    "github.com/ethereum/go-ethereum/common"
    "github.com/ethereum/go-ethereum/common/hexutil"
    "github.com/ethereum/go-ethereum/rlp"
)

//go:generate gencodec -type Receipt -field-override receiptMarshaling -out gen_receipt_json.go

var (
    receiptStatusFailedRLP     = []byte{}
    receiptStatusSuccessfulRLP = []byte{0x01}
)

const (
    // ReceiptStatusFailed is the status code of a transaction if execution failed.
    ReceiptStatusFailed = uint64(0)

    // ReceiptStatusSuccessful is the status code of a transaction if execution succeeded.
    ReceiptStatusSuccessful = uint64(1)
)

// Receipt represents the results of a transaction.
type Receipt struct {
    // Consensus fields
    PostState         []byte `json:"root"`
    Status            uint64 `json:"status"`
    CumulativeGasUsed uint64 `json:"cumulativeGasUsed" gencodec:"required"`
    Bloom             Bloom  `json:"logsBloom"         gencodec:"required"`
    Logs              []*Log `json:"logs"              gencodec:"required"`

    // Implementation fields (don't reorder!)
    TxHash          common.Hash    `json:"transactionHash" gencodec:"required"`
    ContractAddress common.Address `json:"contractAddress"`
    GasUsed         uint64         `json:"gasUsed" gencodec:"required"`
}

type receiptMarshaling struct {
    PostState         hexutil.Bytes
    Status            hexutil.Uint64
    CumulativeGasUsed hexutil.Uint64
    GasUsed           hexutil.Uint64
}

// receiptRLP is the consensus encoding of a receipt.
type receiptRLP struct {
    PostStateOrStatus []byte
    CumulativeGasUsed uint64
    Bloom             Bloom
    Logs              []*Log
}

type receiptStorageRLP struct {
    PostStateOrStatus []byte
    CumulativeGasUsed uint64
    Bloom             Bloom
    TxHash            common.Hash
    ContractAddress   common.Address
    Logs              []*LogForStorage
    GasUsed           uint64
}

// NewReceipt creates a barebone transaction receipt, copying the init fields.
func NewReceipt(root []byte, failed bool, cumulativeGasUsed uint64) *Receipt {
    r := &Receipt{PostState: common.CopyBytes(root), CumulativeGasUsed: cumulativeGasUsed}
    if failed {
        r.Status = ReceiptStatusFailed
    } else {
        r.Status = ReceiptStatusSuccessful
    }
    return r
}

// EncodeRLP implements rlp.Encoder, and flattens the consensus fields of a receipt
// into an RLP stream. If no post state is present, byzantium fork is assumed.
func (r *Receipt) EncodeRLP(w io.Writer) error {
    return rlp.Encode(w, &receiptRLP{r.statusEncoding(), r.CumulativeGasUsed, r.Bloom, r.Logs})
}

// DecodeRLP implements rlp.Decoder, and loads the consensus fields of a receipt
// from an RLP stream.
func (r *Receipt) DecodeRLP(s *rlp.Stream) error {
    var dec receiptRLP
    if err := s.Decode(&dec); err != nil {
        return err
    }
    if err := r.setStatus(dec.PostStateOrStatus); err != nil {
        return err
    }
    r.CumulativeGasUsed, r.Bloom, r.Logs = dec.CumulativeGasUsed, dec.Bloom, dec.Logs
    return nil
}

func (r *Receipt) setStatus(postStateOrStatus []byte) error {
    switch {
    case bytes.Equal(postStateOrStatus, receiptStatusSuccessfulRLP):
        r.Status = ReceiptStatusSuccessful
    case bytes.Equal(postStateOrStatus, receiptStatusFailedRLP):
        r.Status = ReceiptStatusFailed
    case len(postStateOrStatus) == len(common.Hash{}):
        r.PostState = postStateOrStatus
    default:
        return fmt.Errorf("invalid receipt status %x", postStateOrStatus)
    }
    return nil
}

func (r *Receipt) statusEncoding() []byte {
    if len(r.PostState) == 0 {
        if r.Status == ReceiptStatusFailed {
            return receiptStatusFailedRLP
        }
        return receiptStatusSuccessfulRLP
    }
    return r.PostState
}

// Size returns the approximate memory used by all internal contents. It is used
// to approximate and limit the memory consumption of various caches.
func (r *Receipt) Size() common.StorageSize {
    size := common.StorageSize(unsafe.Sizeof(*r)) + common.StorageSize(len(r.PostState))

    size += common.StorageSize(len(r.Logs)) * common.StorageSize(unsafe.Sizeof(Log{}))
    for _, log := range r.Logs {
        size += common.StorageSize(len(log.Topics)*common.HashLength + len(log.Data))
    }
    return size
}

// ReceiptForStorage is a wrapper around a Receipt that flattens and parses the
// entire content of a receipt, as opposed to only the consensus fields originally.
type ReceiptForStorage Receipt

// EncodeRLP implements rlp.Encoder, and flattens all content fields of a receipt
// into an RLP stream.
func (r *ReceiptForStorage) EncodeRLP(w io.Writer) error {
    enc := &receiptStorageRLP{
        PostStateOrStatus: (*Receipt)(r).statusEncoding(),
        CumulativeGasUsed: r.CumulativeGasUsed,
        Bloom:             r.Bloom,
        TxHash:            r.TxHash,
        ContractAddress:   r.ContractAddress,
        Logs:              make([]*LogForStorage, len(r.Logs)),
        GasUsed:           r.GasUsed,
    }
    for i, log := range r.Logs {
        enc.Logs[i] = (*LogForStorage)(log)
    }
    return rlp.Encode(w, enc)
}

// DecodeRLP implements rlp.Decoder, and loads both consensus and implementation
// fields of a receipt from an RLP stream.
func (r *ReceiptForStorage) DecodeRLP(s *rlp.Stream) error {
    var dec receiptStorageRLP
    if err := s.Decode(&dec); err != nil {
        return err
    }
    if err := (*Receipt)(r).setStatus(dec.PostStateOrStatus); err != nil {
        return err
    }
    // Assign the consensus fields
    r.CumulativeGasUsed, r.Bloom = dec.CumulativeGasUsed, dec.Bloom
    r.Logs = make([]*Log, len(dec.Logs))
    for i, log := range dec.Logs {
        r.Logs[i] = (*Log)(log)
    }
    // Assign the implementation fields
    r.TxHash, r.ContractAddress, r.GasUsed = dec.TxHash, dec.ContractAddress, dec.GasUsed
    return nil
}

// Receipts is a wrapper around a Receipt array to implement DerivableList.
type Receipts []*Receipt

// Len returns the number of receipts in this list.
func (r Receipts) Len() int { return len(r) }

// GetRlp returns the RLP encoding of one receipt from the list.
func (r Receipts) GetRlp(i int) []byte {
    bytes, err := rlp.EncodeToBytes(r[i])
    if err != nil {
        panic(err)
    }
    return bytes
}

Appendix A. 总体批注

文件 core/types/receipt.go 中主要定义了数据结构 Receipt，用于存储事务处理结果的详细信息。

数据结构 Receipt 中包含共识字段和实现字段两部分。

- 共识字段同时支持 JSON 和 RLP 编码，分别由数据结构 receiptMarshaling 和 receiptRLP 表示。
- 共识字段和实现字段需要一起采用 RLP 编码进行归档，由数据结构 receiptStorageRLP。
- 数据结构 receiptMarshaling、receiptRLP、receiptStorageRLP 是流形式。
- 通过函数 NewReceipt() 新建空的 Receipt。
- 通过方法 EncodeRLP() 编码 Receipt。
- 通过方法 DecodeRLP() 解码 Receipt。
- 通过方法 Size() 评估 Receipt 的内存消耗。

数据结构 ReceiptForStorage 只是 Receipt 的封装器，便于与数据结构 receiptStorageRLP 进行映射。
- 通过方法 EncodeRLP() 编码 ReceiptForStorage。
- 通过方法 DecodeRLP() 解码 ReceiptForStorage。

数据结构 Receipts 表示 Receipt 列表的封装器。
- 通过方法 Len() 返回 Receipt 的元素个数。
- 通过方法 GetRlp() 返回某个 Receipt 的 RLP 编码。

Appendix B. 详细批注

var

receiptStatusFailedRLP：收据状态为失败的 RLP 编码
receiptStatusSuccessfulRLP：收据状态为成功的 RLP 编码

const

ReceiptStatusFailed：事务执行失败时的状态码
ReceiptStatusSuccessful：事务执行成功时的状态码

type Receipt struct

收据描述了事务的结果。

// Consensus fields
- PostState         []byte：    receiptStatusFailedRLP 或 receiptStatusSuccessfulRLP
- Status            uint64：    ReceiptStatusFailed 或 ReceiptStatusSuccessful
- CumulativeGasUsed uint64：    到此事务时累计使用掉的 gas
- Bloom             Bloom：     ??? 用于描述什么的布隆过滤器呢
- Logs              []*Log：    事务中用于描述智能合约的日志事件列表

// Implementation fields (don't reorder!)
- TxHash          common.Hash：     事务的哈希
- ContractAddress common.Address：  智能合约地址
- GasUsed         uint64：          此事务使用的 gas

func (r *Receipt) EncodeRLP(w io.Writer) error
方法 EncodeRLP() 实现了 rlp.Encoder 接口，并将收据的共识字段扁平化成 RLP 流。

将收据的 RLP 编码写入到参数 w 中。

- 具体的实现是调用函数 rlp.Encode() 完成的。

func (r *Receipt) DecodeRLP(s *rlp.Stream) error
方法 DecodeRLP() 实现了 rlp.Decoder 接口，并从 RLP 流中加载收据的共识字段。

从参数 s 中加载共识字段。

- 具体的实现是调用方法 rlp.Stream.Decode() 完成的。
- 通过方法 setStatus() 完成 receiptRLP.PostStateOrStatus 与 Receipt.PostState & Receipt.Status 字段之间的映射。

func (r *Receipt) setStatus(postStateOrStatus []byte) error
方法 setStatus() 从参数 postStateOrStatus 中映射出 Status 或 PostState 字段。
func (r *Receipt) statusEncoding() []byte
方法 statusEncoding() 返回状态的 RLP 编码。
- 如果 PostState 为空，则根据 Status 的值来决定
  - 如果 Status 为 ReceiptStatusFailed，则返回 receiptStatusFailedRLP，否则返回 receiptStatusSuccessfulRLP
- 否则，返回 PostState
func (r *Receipt) Size() common.StorageSize
方法 Size() 返回所由内部内容所使用的大致内存。它被用于评估或限制各种缓存对于内存的消耗。
- 主要是深度计算了字段 PostState 和 Logs 的大小。

type receiptMarshaling struct

收据序列化所包含的成员。

- PostState         hexutil.Bytes：     
- Status            hexutil.Uint64：    
- CumulativeGasUsed hexutil.Uint64：    
- GasUsed           hexutil.Uint64：

type receiptRLP struct

收据的共识 RLP 编码。

- PostStateOrStatus []byte：    
- CumulativeGasUsed uint64：    
- Bloom             Bloom：     
- Logs              []*Log：

type receiptStorageRLP struct

收据存储的 RLP 编码。

PostStateOrStatus []byte
CumulativeGasUsed uint64
Bloom             Bloom
TxHash            common.Hash
ContractAddress   common.Address
Logs              []*LogForStorage
GasUsed           uint64

type ReceiptForStorage Receipt

ReceiptForStorage 是 Receipt 的封装器，用于扁平化和分析 Receipt 的整个内容，而不仅仅是原始的共识字段。

func (r *ReceiptForStorage) EncodeRLP(w io.Writer) error
方法 EncodeRLP() 实现了 rlp.Encoder 接口，并将收据的共识字段扁平化成 RLP 流。

将 ReceiptForStorage 的 RLP 编码写入到参数 w 中。

- 具体的实现是调用函数 rlp.Encode() 完成的。

func (r *ReceiptForStorage) DecodeRLP(s *rlp.Stream) error
方法 DecodeRLP() 实现了 rlp.Decoder 接口，并从 RLP 流中加载收据的共识字段。

从参数 s 中同时加载共识字段和实现字段。

- 具体的实现是调用方法 rlp.Stream.Decode() 完成的。
- 通过方法 setStatus() 完成 receiptStorageRLP.PostStateOrStatus 与 PostState & Status 字段之间的映射。
- 从解码后的 receiptStorageRLP 中还原其它字段。

type Receipts []*Receipt

Receipts 表示 Receipt 列表的封装器

func (r Receipts) Len()
方法 Len() 返回列表中 Receipt 的元素个数。
func (r Receipts) GetRlp(i int) []byte
方法 GetRlp() 返回列表中某个 Receipt 的 RLP 编码。

func NewReceipt(root []byte, failed bool, cumulativeGasUsed uint64) *Receipt

函数 NewReceipt() 创建空的事务收据，拷贝初始成员。

Reference

https://github.com/ethereum/go-ethereum/blob/master/core/types/receipt.go

Contributor

Windstamp