aboutsummaryrefslogtreecommitdiffstats
path: root/core/vm/log.go
blob: 347bd6e5dc2f27a76e187cdb0d38f9ebfdd20cb2 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
// Copyright 2014 The go-ethereum Authors
// This file is part of the go-ethereum library.
//
// The go-ethereum library is free software: you can redistribute it and/or modify
// it 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 go-ethereum library is distributed in the hope that it 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 vm

import (
    "encoding/json"
    "errors"
    "fmt"
    "io"

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

var errMissingLogFields = errors.New("missing required JSON log fields")

// Log represents a contract log event. These events are generated by the LOG opcode and
// stored/indexed by the node.
type Log struct {
    // Consensus fields.
    Address common.Address // address of the contract that generated the event
    Topics  []common.Hash  // list of topics provided by the contract.
    Data    []byte         // supplied by the contract, usually ABI-encoded

    // Derived fields. These fields are filled in by the node
    // but not secured by consensus.
    BlockNumber uint64      // block in which the transaction was included
    TxHash      common.Hash // hash of the transaction
    TxIndex     uint        // index of the transaction in the block
    BlockHash   common.Hash // hash of the block in which the transaction was included
    Index       uint        // index of the log in the receipt

    // The Removed field is true if this log was reverted due to a chain reorganisation.
    // You must pay attention to this field if you receive logs through a filter query.
    Removed bool
}

type rlpLog struct {
    Address common.Address
    Topics  []common.Hash
    Data    []byte
}

type rlpStorageLog struct {
    Address     common.Address
    Topics      []common.Hash
    Data        []byte
    BlockNumber uint64
    TxHash      common.Hash
    TxIndex     uint
    BlockHash   common.Hash
    Index       uint
}

type jsonLog struct {
    Address     *common.Address `json:"address"`
    Topics      *[]common.Hash  `json:"topics"`
    Data        *hexutil.Bytes  `json:"data"`
    BlockNumber *hexutil.Uint64 `json:"blockNumber"`
    TxIndex     *hexutil.Uint   `json:"transactionIndex"`
    TxHash      *common.Hash    `json:"transactionHash"`
    BlockHash   *common.Hash    `json:"blockHash"`
    Index       *hexutil.Uint   `json:"logIndex"`
    Removed     bool            `json:"removed"`
}

func NewLog(address common.Address, topics []common.Hash, data []byte, number uint64) *Log {
    return &Log{Address: address, Topics: topics, Data: data, BlockNumber: number}
}

// EncodeRLP implements rlp.Encoder.
func (l *Log) EncodeRLP(w io.Writer) error {
    return rlp.Encode(w, rlpLog{Address: l.Address, Topics: l.Topics, Data: l.Data})
}

// DecodeRLP implements rlp.Decoder.
func (l *Log) DecodeRLP(s *rlp.Stream) error {
    var dec rlpLog
    err := s.Decode(&dec)
    if err == nil {
        l.Address, l.Topics, l.Data = dec.Address, dec.Topics, dec.Data
    }
    return err
}

func (l *Log) String() string {
    return fmt.Sprintf(`log: %x %x %x %x %d %x %d`, l.Address, l.Topics, l.Data, l.TxHash, l.TxIndex, l.BlockHash, l.Index)
}

// MarshalJSON implements json.Marshaler.
func (l *Log) MarshalJSON() ([]byte, error) {
    jslog := &jsonLog{
        Address: &l.Address,
        Topics:  &l.Topics,
        Data:    (*hexutil.Bytes)(&l.Data),
        TxIndex: (*hexutil.Uint)(&l.TxIndex),
        TxHash:  &l.TxHash,
        Index:   (*hexutil.Uint)(&l.Index),
        Removed: l.Removed,
    }
    // Set block information for mined logs.
    if (l.BlockHash != common.Hash{}) {
        jslog.BlockHash = &l.BlockHash
        jslog.BlockNumber = (*hexutil.Uint64)(&l.BlockNumber)
    }
    return json.Marshal(jslog)
}

// UnmarshalJSON implements json.Umarshaler.
func (l *Log) UnmarshalJSON(input []byte) error {
    var dec jsonLog
    if err := json.Unmarshal(input, &dec); err != nil {
        return err
    }
    if dec.Address == nil || dec.Topics == nil || dec.Data == nil ||
        dec.TxIndex == nil || dec.TxHash == nil || dec.Index == nil {
        return errMissingLogFields
    }
    declog := Log{
        Address: *dec.Address,
        Topics:  *dec.Topics,
        Data:    *dec.Data,
        TxHash:  *dec.TxHash,
        TxIndex: uint(*dec.TxIndex),
        Index:   uint(*dec.Index),
        Removed: dec.Removed,
    }
    // Block information may be missing if the log is received through
    // the pending log filter, so it's handled specially here.
    if dec.BlockHash != nil && dec.BlockNumber != nil {
        declog.BlockHash = *dec.BlockHash
        declog.BlockNumber = uint64(*dec.BlockNumber)
    }
    *l = declog
    return nil
}

type Logs []*Log

// LogForStorage is a wrapper around a Log that flattens and parses the entire content of
// a log including non-consensus fields.
type LogForStorage Log

// EncodeRLP implements rlp.Encoder.
func (l *LogForStorage) EncodeRLP(w io.Writer) error {
    return rlp.Encode(w, rlpStorageLog{
        Address:     l.Address,
        Topics:      l.Topics,
        Data:        l.Data,
        BlockNumber: l.BlockNumber,
        TxHash:      l.TxHash,
        TxIndex:     l.TxIndex,
        BlockHash:   l.BlockHash,
        Index:       l.Index,
    })
}

// DecodeRLP implements rlp.Decoder.
func (l *LogForStorage) DecodeRLP(s *rlp.Stream) error {
    var dec rlpStorageLog
    err := s.Decode(&dec)
    if err == nil {
        *l = LogForStorage{
            Address:     dec.Address,
            Topics:      dec.Topics,
            Data:        dec.Data,
            BlockNumber: dec.BlockNumber,
            TxHash:      dec.TxHash,
            TxIndex:     dec.TxIndex,
            BlockHash:   dec.BlockHash,
            Index:       dec.Index,
        }
    }
    return err
}