path: root/consensus/ethash/ethash_test.go

// Copyright 2017 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 ethash

import (
    "io/ioutil"
    "math/big"
    "math/rand"
    "os"
    "sync"
    "testing"
    "time"

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

// Tests that ethash works correctly in test mode.
func TestTestMode(t *testing.T) {
    header := &types.Header{Number: big.NewInt(1), Difficulty: big.NewInt(100)}

    ethash := NewTester(nil)
    defer ethash.Close()

    block, err := ethash.Seal(nil, types.NewBlockWithHeader(header), nil)
    if err != nil {
        t.Fatalf("failed to seal block: %v", err)
    }
    header.Nonce = types.EncodeNonce(block.Nonce())
    header.MixDigest = block.MixDigest()
    if err := ethash.VerifySeal(nil, header); err != nil {
        t.Fatalf("unexpected verification error: %v", err)
    }
}

// This test checks that cache lru logic doesn't crash under load.
// It reproduces https://github.com/ethereum/go-ethereum/issues/14943
func TestCacheFileEvict(t *testing.T) {
    tmpdir, err := ioutil.TempDir("", "ethash-test")
    if err != nil {
        t.Fatal(err)
    }
    defer os.RemoveAll(tmpdir)
    e := New(Config{CachesInMem: 3, CachesOnDisk: 10, CacheDir: tmpdir, PowMode: ModeTest}, nil)
    defer e.Close()

    workers := 8
    epochs := 100
    var wg sync.WaitGroup
    wg.Add(workers)
    for i := 0; i < workers; i++ {
        go verifyTest(&wg, e, i, epochs)
    }
    wg.Wait()
}

func verifyTest(wg *sync.WaitGroup, e *Ethash, workerIndex, epochs int) {
    defer wg.Done()

    const wiggle = 4 * epochLength
    r := rand.New(rand.NewSource(int64(workerIndex)))
    for epoch := 0; epoch < epochs; epoch++ {
        block := int64(epoch)*epochLength - wiggle/2 + r.Int63n(wiggle)
        if block < 0 {
            block = 0
        }
        header := &types.Header{Number: big.NewInt(block), Difficulty: big.NewInt(100)}
        e.VerifySeal(nil, header)
    }
}

func TestRemoteSealer(t *testing.T) {
    ethash := NewTester(nil)
    defer ethash.Close()

    api := &API{ethash}
    if _, err := api.GetWork(); err != errNoMiningWork {
        t.Error("expect to return an error indicate there is no mining work")
    }
    header := &types.Header{Number: big.NewInt(1), Difficulty: big.NewInt(100)}
    block := types.NewBlockWithHeader(header)

    // Push new work.
    ethash.Seal(nil, block, nil)

    var (
        work [3]string
        err  error
    )
    if work, err = api.GetWork(); err != nil || work[0] != block.HashNoNonce().Hex() {
        t.Error("expect to return a mining work has same hash")
    }

    if res := api.SubmitWork(types.BlockNonce{}, block.HashNoNonce(), common.Hash{}); res {
        t.Error("expect to return false when submit a fake solution")
    }
    // Push new block with same block number to replace the original one.
    header = &types.Header{Number: big.NewInt(1), Difficulty: big.NewInt(1000)}
    block = types.NewBlockWithHeader(header)
    ethash.Seal(nil, block, nil)

    if work, err = api.GetWork(); err != nil || work[0] != block.HashNoNonce().Hex() {
        t.Error("expect to return the latest pushed work")
    }
    // Push block with higher block number.
    newHead := &types.Header{Number: big.NewInt(2), Difficulty: big.NewInt(100)}
    newBlock := types.NewBlockWithHeader(newHead)
    ethash.Seal(nil, newBlock, nil)

    if res := api.SubmitWork(types.BlockNonce{}, block.HashNoNonce(), common.Hash{}); res {
        t.Error("expect to return false when submit a stale solution")
    }
}

func TestHashRate(t *testing.T) {
    var (
        hashrate = []hexutil.Uint64{100, 200, 300}
        expect   uint64
        ids      = []common.Hash{common.HexToHash("a"), common.HexToHash("b"), common.HexToHash("c")}
    )
    ethash := NewTester(nil)
    defer ethash.Close()

    if tot := ethash.Hashrate(); tot != 0 {
        t.Error("expect the result should be zero")
    }

    api := &API{ethash}
    for i := 0; i < len(hashrate); i += 1 {
        if res := api.SubmitHashRate(hashrate[i], ids[i]); !res {
            t.Error("remote miner submit hashrate failed")
        }
        expect += uint64(hashrate[i])
    }
    if tot := ethash.Hashrate(); tot != float64(expect) {
        t.Error("expect total hashrate should be same")
    }
}

func TestClosedRemoteSealer(t *testing.T) {
    ethash := NewTester(nil)
    time.Sleep(1 * time.Second) // ensure exit channel is listening
    ethash.Close()

    api := &API{ethash}
    if _, err := api.GetWork(); err != errEthashStopped {
        t.Error("expect to return an error to indicate ethash is stopped")
    }

    if res := api.SubmitHashRate(hexutil.Uint64(100), common.HexToHash("a")); res {
        t.Error("expect to return false when submit hashrate to a stopped ethash")
    }
}