aboutsummaryrefslogtreecommitdiffstats
path: root/core/vm/log.go
blob: e4cc6021bd4a1954b17b95a65df063d64cd91a63 (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
// 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"
    "fmt"
    "io"

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

type Log struct {
    // Consensus fields
    Address common.Address
    Topics  []common.Hash
    Data    []byte

    // Derived fields (don't reorder!)
    BlockNumber uint64
    TxHash      common.Hash
    TxIndex     uint
    BlockHash   common.Hash
    Index       uint
}

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

func (l *Log) EncodeRLP(w io.Writer) error {
    return rlp.Encode(w, []interface{}{l.Address, l.Topics, l.Data})
}

func (l *Log) DecodeRLP(s *rlp.Stream) error {
    var log struct {
        Address common.Address
        Topics  []common.Hash
        Data    []byte
    }
    if err := s.Decode(&log); err != nil {
        return err
    }
    l.Address, l.Topics, l.Data = log.Address, log.Topics, log.Data
    return nil
}

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)
}

func (r *Log) MarshalJSON() ([]byte, error) {
    fields := map[string]interface{}{
        "address":          r.Address,
        "data":             fmt.Sprintf("%#x", r.Data),
        "blockNumber":      fmt.Sprintf("%#x", r.BlockNumber),
        "logIndex":         fmt.Sprintf("%#x", r.Index),
        "blockHash":        r.BlockHash,
        "transactionHash":  r.TxHash,
        "transactionIndex": fmt.Sprintf("%#x", r.TxIndex),
        "topics":           r.Topics,
    }

    return json.Marshal(fields)
}

type Logs []*Log

// LogForStorage is a wrapper around a Log that flattens and parses the entire
// content of a log, as opposed to only the consensus fields originally (by hiding
// the rlp interface methods).
type LogForStorage Log