aboutsummaryrefslogtreecommitdiffstats
path: root/common/types.go
blob: 70b7e7aae86c1e1d7ef1e622f1881bc06e4d6374 (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
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
// Copyright 2015 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 common

import (
    "encoding/hex"
    "encoding/json"
    "errors"
    "fmt"
    "math/big"
    "math/rand"
    "reflect"
    "strings"
)

const (
    HashLength    = 32
    AddressLength = 20
)

var hashJsonLengthErr = errors.New("common: unmarshalJSON failed: hash must be exactly 32 bytes")

type (
    // Hash represents the 32 byte Keccak256 hash of arbitrary data.
    Hash [HashLength]byte

    // Address represents the 20 byte address of an Ethereum account.
    Address [AddressLength]byte
)

func BytesToHash(b []byte) Hash {
    var h Hash
    h.SetBytes(b)
    return h
}
func StringToHash(s string) Hash { return BytesToHash([]byte(s)) }
func BigToHash(b *big.Int) Hash  { return BytesToHash(b.Bytes()) }
func HexToHash(s string) Hash    { return BytesToHash(FromHex(s)) }

// Don't use the default 'String' method in case we want to overwrite

// Get the string representation of the underlying hash
func (h Hash) Str() string   { return string(h[:]) }
func (h Hash) Bytes() []byte { return h[:] }
func (h Hash) Big() *big.Int { return Bytes2Big(h[:]) }
func (h Hash) Hex() string   { return "0x" + Bytes2Hex(h[:]) }

// UnmarshalJSON parses a hash in its hex from to a hash.
func (h *Hash) UnmarshalJSON(input []byte) error {
    length := len(input)
    if length >= 2 && input[0] == '"' && input[length-1] == '"' {
        input = input[1 : length-1]
    }
    // strip "0x" for length check
    if len(input) > 1 && strings.ToLower(string(input[:2])) == "0x" {
        input = input[2:]
    }

    // validate the length of the input hash
    if len(input) != HashLength*2 {
        return hashJsonLengthErr
    }
    h.SetBytes(FromHex(string(input)))
    return nil
}

// Serialize given hash to JSON
func (h Hash) MarshalJSON() ([]byte, error) {
    return json.Marshal(h.Hex())
}

// Sets the hash to the value of b. If b is larger than len(h) it will panic
func (h *Hash) SetBytes(b []byte) {
    if len(b) > len(h) {
        b = b[len(b)-HashLength:]
    }

    copy(h[HashLength-len(b):], b)
}

// Set string `s` to h. If s is larger than len(h) it will panic
func (h *Hash) SetString(s string) { h.SetBytes([]byte(s)) }

// Sets h to other
func (h *Hash) Set(other Hash) {
    for i, v := range other {
        h[i] = v
    }
}

// Generate implements testing/quick.Generator.
func (h Hash) Generate(rand *rand.Rand, size int) reflect.Value {
    m := rand.Intn(len(h))
    for i := len(h) - 1; i > m; i-- {
        h[i] = byte(rand.Uint32())
    }
    return reflect.ValueOf(h)
}

func EmptyHash(h Hash) bool {
    return h == Hash{}
}

/////////// Address
func BytesToAddress(b []byte) Address {
    var a Address
    a.SetBytes(b)
    return a
}
func StringToAddress(s string) Address { return BytesToAddress([]byte(s)) }
func BigToAddress(b *big.Int) Address  { return BytesToAddress(b.Bytes()) }
func HexToAddress(s string) Address    { return BytesToAddress(FromHex(s)) }

// IsHexAddress verifies whether a string can represent a valid hex-encoded
// Ethereum address or not.
func IsHexAddress(s string) bool {
    if len(s) == 2+2*AddressLength && IsHex(s) {
        return true
    }
    if len(s) == 2*AddressLength && IsHex("0x"+s) {
        return true
    }
    return false
}

// Get the string representation of the underlying address
func (a Address) Str() string   { return string(a[:]) }
func (a Address) Bytes() []byte { return a[:] }
func (a Address) Big() *big.Int { return Bytes2Big(a[:]) }
func (a Address) Hash() Hash    { return BytesToHash(a[:]) }
func (a Address) Hex() string   { return "0x" + Bytes2Hex(a[:]) }

// Sets the address to the value of b. If b is larger than len(a) it will panic
func (a *Address) SetBytes(b []byte) {
    if len(b) > len(a) {
        b = b[len(b)-AddressLength:]
    }
    copy(a[AddressLength-len(b):], b)
}

// Set string `s` to a. If s is larger than len(a) it will panic
func (a *Address) SetString(s string) { a.SetBytes([]byte(s)) }

// Sets a to other
func (a *Address) Set(other Address) {
    for i, v := range other {
        a[i] = v
    }
}

// Serialize given address to JSON
func (a Address) MarshalJSON() ([]byte, error) {
    return json.Marshal(a.Hex())
}

// Parse address from raw json data
func (a *Address) UnmarshalJSON(data []byte) error {
    if len(data) > 2 && data[0] == '"' && data[len(data)-1] == '"' {
        data = data[1 : len(data)-1]
    }

    if len(data) > 2 && data[0] == '0' && data[1] == 'x' {
        data = data[2:]
    }

    if len(data) != 2*AddressLength {
        return fmt.Errorf("Invalid address length, expected %d got %d bytes", 2*AddressLength, len(data))
    }

    n, err := hex.Decode(a[:], data)
    if err != nil {
        return err
    }

    if n != AddressLength {
        return fmt.Errorf("Invalid address")
    }

    a.Set(HexToAddress(string(data)))
    return nil
}

// PP Pretty Prints a byte slice in the following format:
//  hex(value[:4])...(hex[len(value)-4:])
func PP(value []byte) string {
    if len(value) <= 8 {
        return Bytes2Hex(value)
    }

    return fmt.Sprintf("%x...%x", value[:4], value[len(value)-4])
}