path: root/tests/util.go

// 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 tests

import (
    "bytes"
    "fmt"
    "math/big"
    "os"

    "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/core/vm"
    "github.com/ethereum/go-ethereum/crypto"
    "github.com/ethereum/go-ethereum/ethdb"
    "github.com/ethereum/go-ethereum/logger/glog"
)

var (
    ForceJit  bool
    EnableJit bool
)

func init() {
    glog.SetV(0)
    if os.Getenv("JITVM") == "true" {
        ForceJit = true
        EnableJit = true
    }
}

func checkLogs(tlog []Log, logs vm.Logs) error {

    if len(tlog) != len(logs) {
        return fmt.Errorf("log length mismatch. Expected %d, got %d", len(tlog), len(logs))
    } else {
        for i, log := range tlog {
            if common.HexToAddress(log.AddressF) != logs[i].Address {
                return fmt.Errorf("log address expected %v got %x", log.AddressF, logs[i].Address)
            }

            if !bytes.Equal(logs[i].Data, common.FromHex(log.DataF)) {
                return fmt.Errorf("log data expected %v got %x", log.DataF, logs[i].Data)
            }

            if len(log.TopicsF) != len(logs[i].Topics) {
                return fmt.Errorf("log topics length expected %d got %d", len(log.TopicsF), logs[i].Topics)
            } else {
                for j, topic := range log.TopicsF {
                    if common.HexToHash(topic) != logs[i].Topics[j] {
                        return fmt.Errorf("log topic[%d] expected %v got %x", j, topic, logs[i].Topics[j])
                    }
                }
            }
            genBloom := common.LeftPadBytes(types.LogsBloom(vm.Logs{logs[i]}).Bytes(), 256)

            if !bytes.Equal(genBloom, common.Hex2Bytes(log.BloomF)) {
                return fmt.Errorf("bloom mismatch")
            }
        }
    }
    return nil
}

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

type Log struct {
    AddressF string   `json:"address"`
    DataF    string   `json:"data"`
    TopicsF  []string `json:"topics"`
    BloomF   string   `json:"bloom"`
}

func (self Log) Address() []byte      { return common.Hex2Bytes(self.AddressF) }
func (self Log) Data() []byte         { return common.Hex2Bytes(self.DataF) }
func (self Log) RlpData() interface{} { return nil }
func (self Log) Topics() [][]byte {
    t := make([][]byte, len(self.TopicsF))
    for i, topic := range self.TopicsF {
        t[i] = common.Hex2Bytes(topic)
    }
    return t
}

func StateObjectFromAccount(db ethdb.Database, addr string, account Account) *state.StateObject {
    obj := state.NewStateObject(common.HexToAddress(addr), db)
    obj.SetBalance(common.Big(account.Balance))

    if common.IsHex(account.Code) {
        account.Code = account.Code[2:]
    }
    obj.SetCode(common.Hex2Bytes(account.Code))
    obj.SetNonce(common.Big(account.Nonce).Uint64())

    return obj
}

type VmEnv struct {
    CurrentCoinbase   string
    CurrentDifficulty string
    CurrentGasLimit   string
    CurrentNumber     string
    CurrentTimestamp  interface{}
    PreviousHash      string
}

type VmTest struct {
    Callcreates interface{}
    //Env         map[string]string
    Env           VmEnv
    Exec          map[string]string
    Transaction   map[string]string
    Logs          []Log
    Gas           string
    Out           string
    Post          map[string]Account
    Pre           map[string]Account
    PostStateRoot string
}

type RuleSet struct {
    HomesteadBlock *big.Int
}

func (r RuleSet) IsHomestead(n *big.Int) bool {
    return n.Cmp(r.HomesteadBlock) >= 0
}

type Env struct {
    ruleSet      RuleSet
    depth        int
    state        *state.StateDB
    skipTransfer bool
    initial      bool
    Gas          *big.Int

    origin   common.Address
    parent   common.Hash
    coinbase common.Address

    number     *big.Int
    time       *big.Int
    difficulty *big.Int
    gasLimit   *big.Int

    logs []vm.StructLog

    vmTest bool

    evm *vm.EVM
}

func NewEnv(ruleSet RuleSet, state *state.StateDB) *Env {
    env := &Env{
        ruleSet: ruleSet,
        state:   state,
    }
    return env
}

func (self *Env) StructLogs() []vm.StructLog {
    return self.logs
}

func (self *Env) AddStructLog(log vm.StructLog) {
    self.logs = append(self.logs, log)
}

func NewEnvFromMap(ruleSet RuleSet, state *state.StateDB, envValues map[string]string, exeValues map[string]string) *Env {
    env := NewEnv(ruleSet, state)

    env.origin = common.HexToAddress(exeValues["caller"])
    env.parent = common.HexToHash(envValues["previousHash"])
    env.coinbase = common.HexToAddress(envValues["currentCoinbase"])
    env.number = common.Big(envValues["currentNumber"])
    env.time = common.Big(envValues["currentTimestamp"])
    env.difficulty = common.Big(envValues["currentDifficulty"])
    env.gasLimit = common.Big(envValues["currentGasLimit"])
    env.Gas = new(big.Int)

    env.evm = vm.New(env, vm.Config{
        EnableJit: EnableJit,
        ForceJit:  ForceJit,
    })

    return env
}

func (self *Env) RuleSet() vm.RuleSet      { return self.ruleSet }
func (self *Env) Vm() vm.Vm                { return self.evm }
func (self *Env) Origin() common.Address   { return self.origin }
func (self *Env) BlockNumber() *big.Int    { return self.number }
func (self *Env) Coinbase() common.Address { return self.coinbase }
func (self *Env) Time() *big.Int           { return self.time }
func (self *Env) Difficulty() *big.Int     { return self.difficulty }
func (self *Env) Db() vm.Database          { return self.state }
func (self *Env) GasLimit() *big.Int       { return self.gasLimit }
func (self *Env) VmType() vm.Type          { return vm.StdVmTy }
func (self *Env) GetHash(n uint64) common.Hash {
    return common.BytesToHash(crypto.Keccak256([]byte(big.NewInt(int64(n)).String())))
}
func (self *Env) AddLog(log *vm.Log) {
    self.state.AddLog(log)
}
func (self *Env) Depth() int     { return self.depth }
func (self *Env) SetDepth(i int) { self.depth = i }
func (self *Env) CanTransfer(from common.Address, balance *big.Int) bool {
    if self.skipTransfer {
        if self.initial {
            self.initial = false
            return true
        }
    }

    return self.state.GetBalance(from).Cmp(balance) >= 0
}
func (self *Env) MakeSnapshot() vm.Database {
    return self.state.Copy()
}
func (self *Env) SetSnapshot(copy vm.Database) {
    self.state.Set(copy.(*state.StateDB))
}

func (self *Env) Transfer(from, to vm.Account, amount *big.Int) {
    if self.skipTransfer {
        return
    }
    core.Transfer(from, to, amount)
}

func (self *Env) Call(caller vm.ContractRef, addr common.Address, data []byte, gas, price, value *big.Int) ([]byte, error) {
    if self.vmTest && self.depth > 0 {
        caller.ReturnGas(gas, price)

        return nil, nil
    }
    ret, err := core.Call(self, caller, addr, data, gas, price, value)
    self.Gas = gas

    return ret, err

}
func (self *Env) CallCode(caller vm.ContractRef, addr common.Address, data []byte, gas, price, value *big.Int) ([]byte, error) {
    if self.vmTest && self.depth > 0 {
        caller.ReturnGas(gas, price)

        return nil, nil
    }
    return core.CallCode(self, caller, addr, data, gas, price, value)
}

func (self *Env) DelegateCall(caller vm.ContractRef, addr common.Address, data []byte, gas, price *big.Int) ([]byte, error) {
    if self.vmTest && self.depth > 0 {
        caller.ReturnGas(gas, price)

        return nil, nil
    }
    return core.DelegateCall(self, caller, addr, data, gas, price)
}

func (self *Env) Create(caller vm.ContractRef, data []byte, gas, price, value *big.Int) ([]byte, common.Address, error) {
    if self.vmTest {
        caller.ReturnGas(gas, price)

        nonce := self.state.GetNonce(caller.Address())
        obj := self.state.GetOrNewStateObject(crypto.CreateAddress(caller.Address(), nonce))

        return nil, obj.Address(), nil
    } else {
        return core.Create(self, caller, data, gas, price, value)
    }
}

type Message struct {
    from              common.Address
    to                *common.Address
    value, gas, price *big.Int
    data              []byte
    nonce             uint64
}

func NewMessage(from common.Address, to *common.Address, data []byte, value, gas, price *big.Int, nonce uint64) Message {
    return Message{from, to, value, gas, price, data, nonce}
}

func (self Message) Hash() []byte                          { return nil }
func (self Message) From() (common.Address, error)         { return self.from, nil }
func (self Message) FromFrontier() (common.Address, error) { return self.from, nil }
func (self Message) To() *common.Address                   { return self.to }
func (self Message) GasPrice() *big.Int                    { return self.price }
func (self Message) Gas() *big.Int                         { return self.gas }
func (self Message) Value() *big.Int                       { return self.value }
func (self Message) Nonce() uint64                         { return self.nonce }
func (self Message) Data() []byte                          { return self.data }