aboutsummaryrefslogtreecommitdiffstats
path: root/tests/block_test_util.go
blob: f34c5d2008b22f402d0841731d93b8d371e0674e (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
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
package tests

import (
    "bytes"
    "encoding/hex"
    "encoding/json"
    "fmt"
    "io/ioutil"
    "math/big"
    "runtime"
    "strconv"
    "strings"

    "github.com/ethereum/go-ethereum/common"
    "github.com/ethereum/go-ethereum/core"
    "github.com/ethereum/go-ethereum/core/state"
    "github.com/ethereum/go-ethereum/core/types"
    "github.com/ethereum/go-ethereum/rlp"
)

// Block Test JSON Format
type BlockTest struct {
    Genesis *types.Block

    Json        *btJSON
    preAccounts map[string]btAccount
}

type btJSON struct {
    Blocks             []btBlock
    GenesisBlockHeader btHeader
    Pre                map[string]btAccount
    PostState          map[string]btAccount
}

type btBlock struct {
    BlockHeader  *btHeader
    Rlp          string
    Transactions []btTransaction
    UncleHeaders []*btHeader
}

type btAccount struct {
    Balance string
    Code    string
    Nonce   string
    Storage map[string]string
}

type btHeader struct {
    Bloom            string
    Coinbase         string
    MixHash          string
    Nonce            string
    Number           string
    ParentHash       string
    ReceiptTrie      string
    SeedHash         string
    StateRoot        string
    TransactionsTrie string
    UncleHash        string

    ExtraData  string
    Difficulty string
    GasLimit   string
    GasUsed    string
    Timestamp  string
}

type btTransaction struct {
    Data     string
    GasLimit string
    GasPrice string
    Nonce    string
    R        string
    S        string
    To       string
    V        string
    Value    string
}

// LoadBlockTests loads a block test JSON file.
func LoadBlockTests(file string) (map[string]*BlockTest, error) {
    bt := make(map[string]*btJSON)
    if err := LoadJSON(file, &bt); err != nil {
        return nil, err
    }
    out := make(map[string]*BlockTest)
    for name, in := range bt {
        var err error
        if out[name], err = convertTest(in); err != nil {
            return out, fmt.Errorf("bad test %q: %v", name, err)
        }
    }
    return out, nil
}

// InsertPreState populates the given database with the genesis
// accounts defined by the test.
func (t *BlockTest) InsertPreState(db common.Database) (*state.StateDB, error) {
    statedb := state.New(common.Hash{}, db)
    for addrString, acct := range t.preAccounts {
        // XXX: is is worth it checking for errors here?
        //addr, _ := hex.DecodeString(addrString)
        code, _ := hex.DecodeString(strings.TrimPrefix(acct.Code, "0x"))
        balance, _ := new(big.Int).SetString(acct.Balance, 0)
        nonce, _ := strconv.ParseUint(acct.Nonce, 16, 64)

        obj := statedb.CreateAccount(common.HexToAddress(addrString))
        obj.SetCode(code)
        obj.SetBalance(balance)
        obj.SetNonce(nonce)
        for k, v := range acct.Storage {
            statedb.SetState(common.HexToAddress(addrString), common.HexToHash(k), common.FromHex(v))
        }
    }
    // sync objects to trie
    statedb.Update()
    // sync trie to disk
    statedb.Sync()

    if !bytes.Equal(t.Genesis.Root().Bytes(), statedb.Root().Bytes()) {
        return nil, fmt.Errorf("computed state root does not match genesis block %x %x", t.Genesis.Root().Bytes()[:4], statedb.Root().Bytes()[:4])
    }
    return statedb, nil
}

/* See https://github.com/ethereum/tests/wiki/Blockchain-Tests-II

   Whether a block is valid or not is a bit subtle, it's defined by presence of
   blockHeader, transactions and uncleHeaders fields. If they are missing, the block is
   invalid and we must verify that we do not accept it.

   Since some tests mix valid and invalid blocks we need to check this for every block.

   If a block is invalid it does not necessarily fail the test, if it's invalidness is
   expected we are expected to ignore it and continue processing and then validate the
   post state.
*/
func (t *BlockTest) TryBlocksInsert(chainManager *core.ChainManager) error {
    // insert the test blocks, which will execute all transactions
    for _, b := range t.Json.Blocks {
        cb, err := mustConvertBlock(b)
        if err != nil {
            if b.BlockHeader == nil {
                continue // OK - block is supposed to be invalid, continue with next block
            } else {
                return fmt.Errorf("Block RLP decoding failed when expected to succeed: ", err)
            }
        }
        // RLP decoding worked, try to insert into chain:
        err = chainManager.InsertChain(types.Blocks{cb})
        if err != nil {
            if b.BlockHeader == nil {
                continue // OK - block is supposed to be invalid, continue with next block
            } else {
                return fmt.Errorf("Block insertion into chain failed: ", err)
            }
        }
        if b.BlockHeader == nil {
            return fmt.Errorf("Block insertion should have failed")
        }
        err = validateBlockHeader(b.BlockHeader, cb.Header())
        if err != nil {
            return fmt.Errorf("Block header validation failed: ", err)
        }
    }
    return nil
}

func validateBlockHeader(h *btHeader, h2 *types.Header) error {
    expectedBloom := mustConvertBytes(h.Bloom)
    if !bytes.Equal(expectedBloom, h2.Bloom.Bytes()) {
        return fmt.Errorf("Bloom: expected: %v, decoded: %v", expectedBloom, h2.Bloom.Bytes())
    }

    expectedCoinbase := mustConvertBytes(h.Coinbase)
    if !bytes.Equal(expectedCoinbase, h2.Coinbase.Bytes()) {
        return fmt.Errorf("Coinbase: expected: %v, decoded: %v", expectedCoinbase, h2.Coinbase.Bytes())
    }

    expectedMixHashBytes := mustConvertBytes(h.MixHash)
    if !bytes.Equal(expectedMixHashBytes, h2.MixDigest.Bytes()) {
        return fmt.Errorf("MixHash: expected: %v, decoded: %v", expectedMixHashBytes, h2.MixDigest.Bytes())
    }

    expectedNonce := mustConvertBytes(h.Nonce)
    if !bytes.Equal(expectedNonce, h2.Nonce[:]) {
        return fmt.Errorf("Nonce: expected: %v, decoded: %v", expectedNonce, h2.Nonce[:])
    }

    expectedNumber := mustConvertBigInt(h.Number, 16)
    if expectedNumber.Cmp(h2.Number) != 0 {
        return fmt.Errorf("Number: expected: %v, decoded: %v", expectedNumber, h2.Number)
    }

    expectedParentHash := mustConvertBytes(h.ParentHash)
    if !bytes.Equal(expectedParentHash, h2.ParentHash.Bytes()) {
        return fmt.Errorf("Parent hash: expected: %v, decoded: %v", expectedParentHash, h2.ParentHash.Bytes())
    }

    expectedReceiptHash := mustConvertBytes(h.ReceiptTrie)
    if !bytes.Equal(expectedReceiptHash, h2.ReceiptHash.Bytes()) {
        return fmt.Errorf("Receipt hash: expected: %v, decoded: %v", expectedReceiptHash, h2.ReceiptHash.Bytes())
    }

    expectedTxHash := mustConvertBytes(h.TransactionsTrie)
    if !bytes.Equal(expectedTxHash, h2.TxHash.Bytes()) {
        return fmt.Errorf("Tx hash: expected: %v, decoded: %v", expectedTxHash, h2.TxHash.Bytes())
    }

    expectedStateHash := mustConvertBytes(h.StateRoot)
    if !bytes.Equal(expectedStateHash, h2.Root.Bytes()) {
        return fmt.Errorf("State hash: expected: %v, decoded: %v", expectedStateHash, h2.Root.Bytes())
    }

    expectedUncleHash := mustConvertBytes(h.UncleHash)
    if !bytes.Equal(expectedUncleHash, h2.UncleHash.Bytes()) {
        return fmt.Errorf("Uncle hash: expected: %v, decoded: %v", expectedUncleHash, h2.UncleHash.Bytes())
    }

    expectedExtraData := mustConvertBytes(h.ExtraData)
    if !bytes.Equal(expectedExtraData, h2.Extra) {
        return fmt.Errorf("Extra data: expected: %v, decoded: %v", expectedExtraData, h2.Extra)
    }

    expectedDifficulty := mustConvertBigInt(h.Difficulty, 16)
    if expectedDifficulty.Cmp(h2.Difficulty) != 0 {
        return fmt.Errorf("Difficulty: expected: %v, decoded: %v", expectedDifficulty, h2.Difficulty)
    }

    expectedGasLimit := mustConvertBigInt(h.GasLimit, 16)
    if expectedGasLimit.Cmp(h2.GasLimit) != 0 {
        return fmt.Errorf("GasLimit: expected: %v, decoded: %v", expectedGasLimit, h2.GasLimit)
    }
    expectedGasUsed := mustConvertBigInt(h.GasUsed, 16)
    if expectedGasUsed.Cmp(h2.GasUsed) != 0 {
        return fmt.Errorf("GasUsed: expected: %v, decoded: %v", expectedGasUsed, h2.GasUsed)
    }

    expectedTimestamp := mustConvertUint(h.Timestamp, 16)
    if expectedTimestamp != h2.Time {
        return fmt.Errorf("Timestamp: expected: %v, decoded: %v", expectedTimestamp, h2.Time)
    }

    return nil
}

func (t *BlockTest) ValidatePostState(statedb *state.StateDB) error {
    for addrString, acct := range t.preAccounts {
        // XXX: is is worth it checking for errors here?
        addr, _ := hex.DecodeString(addrString)
        code, _ := hex.DecodeString(strings.TrimPrefix(acct.Code, "0x"))
        balance, _ := new(big.Int).SetString(acct.Balance, 0)
        nonce, _ := strconv.ParseUint(acct.Nonce, 16, 64)

        // address is indirectly verified by the other fields, as it's the db key
        code2 := statedb.GetCode(common.BytesToAddress(addr))
        balance2 := statedb.GetBalance(common.BytesToAddress(addr))
        nonce2 := statedb.GetNonce(common.BytesToAddress(addr))
        if !bytes.Equal(code2, code) {
            return fmt.Errorf("account code mismatch, addr, found, expected: ", addrString, hex.EncodeToString(code2), hex.EncodeToString(code))
        }
        if balance2.Cmp(balance) != 0 {
            return fmt.Errorf("account balance mismatch, addr, found, expected: ", addrString, balance2, balance)
        }
        if nonce2 != nonce {
            return fmt.Errorf("account nonce mismatch, addr, found, expected: ", addrString, nonce2, nonce)
        }
    }
    return nil
}

func convertTest(in *btJSON) (out *BlockTest, err error) {
    // the conversion handles errors by catching panics.
    // you might consider this ugly, but the alternative (passing errors)
    // would be much harder to read.
    defer func() {
        if recovered := recover(); recovered != nil {
            buf := make([]byte, 64<<10)
            buf = buf[:runtime.Stack(buf, false)]
            err = fmt.Errorf("%v\n%s", recovered, buf)
        }
    }()
    out = &BlockTest{preAccounts: in.Pre, Json: in}
    out.Genesis = mustConvertGenesis(in.GenesisBlockHeader)
    return out, err
}

func mustConvertGenesis(testGenesis btHeader) *types.Block {
    hdr := mustConvertHeader(testGenesis)
    hdr.Number = big.NewInt(0)
    b := types.NewBlockWithHeader(hdr)
    b.Td = new(big.Int)
    return b
}

func mustConvertHeader(in btHeader) *types.Header {
    // hex decode these fields
    header := &types.Header{
        //SeedHash:    mustConvertBytes(in.SeedHash),
        MixDigest:   mustConvertHash(in.MixHash),
        Bloom:       mustConvertBloom(in.Bloom),
        ReceiptHash: mustConvertHash(in.ReceiptTrie),
        TxHash:      mustConvertHash(in.TransactionsTrie),
        Root:        mustConvertHash(in.StateRoot),
        Coinbase:    mustConvertAddress(in.Coinbase),
        UncleHash:   mustConvertHash(in.UncleHash),
        ParentHash:  mustConvertHash(in.ParentHash),
        Extra:       mustConvertBytes(in.ExtraData),
        GasUsed:     mustConvertBigInt(in.GasUsed, 16),
        GasLimit:    mustConvertBigInt(in.GasLimit, 16),
        Difficulty:  mustConvertBigInt(in.Difficulty, 16),
        Time:        mustConvertUint(in.Timestamp, 16),
    }
    // XXX cheats? :-)
    header.SetNonce(mustConvertUint(in.Nonce, 16))
    return header
}

func mustConvertBlock(testBlock btBlock) (*types.Block, error) {
    var b types.Block
    r := bytes.NewReader(mustConvertBytes(testBlock.Rlp))
    err := rlp.Decode(r, &b)
    return &b, err
}

func mustConvertBytes(in string) []byte {
    if in == "0x" {
        return []byte{}
    }
    h := unfuckFuckedHex(strings.TrimPrefix(in, "0x"))
    out, err := hex.DecodeString(h)
    if err != nil {
        panic(fmt.Errorf("invalid hex: %q: ", h, err))
    }
    return out
}

func mustConvertHash(in string) common.Hash {
    out, err := hex.DecodeString(strings.TrimPrefix(in, "0x"))
    if err != nil {
        panic(fmt.Errorf("invalid hex: %q", in))
    }
    return common.BytesToHash(out)
}

func mustConvertAddress(in string) common.Address {
    out, err := hex.DecodeString(strings.TrimPrefix(in, "0x"))
    if err != nil {
        panic(fmt.Errorf("invalid hex: %q", in))
    }
    return common.BytesToAddress(out)
}

func mustConvertBloom(in string) types.Bloom {
    out, err := hex.DecodeString(strings.TrimPrefix(in, "0x"))
    if err != nil {
        panic(fmt.Errorf("invalid hex: %q", in))
    }
    return types.BytesToBloom(out)
}

func mustConvertBigInt(in string, base int) *big.Int {
    in = prepInt(base, in)
    out, ok := new(big.Int).SetString(in, base)
    if !ok {
        panic(fmt.Errorf("invalid integer: %q", in))
    }
    return out
}

func mustConvertUint(in string, base int) uint64 {
    in = prepInt(base, in)
    out, err := strconv.ParseUint(in, base, 64)
    if err != nil {
        panic(fmt.Errorf("invalid integer: %q", in))
    }
    return out
}

// LoadJSON reads the given file and unmarshals its content.
func LoadJSON(file string, val interface{}) error {
    content, err := ioutil.ReadFile(file)
    if err != nil {
        return err
    }
    if err := json.Unmarshal(content, val); err != nil {
        if syntaxerr, ok := err.(*json.SyntaxError); ok {
            line := findLine(content, syntaxerr.Offset)
            return fmt.Errorf("JSON syntax error at %v:%v: %v", file, line, err)
        }
        return fmt.Errorf("JSON unmarshal error in %v: %v", file, err)
    }
    return nil
}

// findLine returns the line number for the given offset into data.
func findLine(data []byte, offset int64) (line int) {
    line = 1
    for i, r := range string(data) {
        if int64(i) >= offset {
            return
        }
        if r == '\n' {
            line++
        }
    }
    return
}

// Nothing to see here, please move along...
func prepInt(base int, s string) string {
    if base == 16 {
        if strings.HasPrefix(s, "0x") {
            s = s[2:]
        }
        if len(s) == 0 {
            s = "00"
        }
        s = nibbleFix(s)
    }
    return s
}

// don't ask
func unfuckFuckedHex(almostHex string) string {
    return nibbleFix(strings.Replace(almostHex, "v", "", -1))
}

func nibbleFix(s string) string {
    if len(s)%2 != 0 {
        s = "0" + s
    }
    return s
}