2015-07-06 17:54:22 -07:00
|
|
|
// Copyright 2014 The go-ethereum Authors
|
2015-07-22 09:48:40 -07:00
|
|
|
// This file is part of the go-ethereum library.
|
2015-07-06 17:54:22 -07:00
|
|
|
//
|
2015-07-23 09:35:11 -07:00
|
|
|
// The go-ethereum library is free software: you can redistribute it and/or modify
|
2015-07-06 17:54:22 -07:00
|
|
|
// 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.
|
|
|
|
//
|
2015-07-22 09:48:40 -07:00
|
|
|
// The go-ethereum library is distributed in the hope that it will be useful,
|
2015-07-06 17:54:22 -07:00
|
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
2015-07-22 09:48:40 -07:00
|
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
2015-07-06 17:54:22 -07:00
|
|
|
// GNU Lesser General Public License for more details.
|
|
|
|
//
|
|
|
|
// You should have received a copy of the GNU Lesser General Public License
|
2015-07-22 09:48:40 -07:00
|
|
|
// along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.
|
2015-07-06 17:54:22 -07:00
|
|
|
|
2014-12-04 01:28:02 -08:00
|
|
|
package core
|
2014-06-13 03:58:01 -07:00
|
|
|
|
|
|
|
import (
|
2017-10-31 15:24:11 -07:00
|
|
|
"errors"
|
2018-05-23 22:32:26 -07:00
|
|
|
"math"
|
2014-07-29 15:31:15 -07:00
|
|
|
"math/big"
|
2015-03-09 10:05:56 -07:00
|
|
|
|
2015-03-16 03:27:38 -07:00
|
|
|
"github.com/ethereum/go-ethereum/common"
|
2015-03-23 08:59:09 -07:00
|
|
|
"github.com/ethereum/go-ethereum/core/vm"
|
2017-10-31 15:24:11 -07:00
|
|
|
"github.com/ethereum/go-ethereum/log"
|
2015-04-01 20:17:15 -07:00
|
|
|
"github.com/ethereum/go-ethereum/params"
|
2016-11-13 21:16:20 -08:00
|
|
|
"github.com/ethereum/go-ethereum/private"
|
2014-06-13 03:58:01 -07:00
|
|
|
)
|
|
|
|
|
2015-11-27 06:40:29 -08:00
|
|
|
var (
|
2017-10-31 15:24:11 -07:00
|
|
|
errInsufficientBalanceForGas = errors.New("insufficient balance to pay for gas")
|
2015-11-27 06:40:29 -08:00
|
|
|
)
|
|
|
|
|
2014-06-13 04:06:27 -07:00
|
|
|
/*
|
2015-09-02 03:55:11 -07:00
|
|
|
The State Transitioning Model
|
|
|
|
|
|
|
|
A state transition is a change made when a transaction is applied to the current world state
|
2018-07-24 03:17:12 -07:00
|
|
|
The state transitioning model does all the necessary work to work out a valid new state root.
|
2015-09-02 03:55:11 -07:00
|
|
|
|
|
|
|
1) Nonce handling
|
|
|
|
2) Pre pay gas
|
|
|
|
3) Create a new state object if the recipient is \0*32
|
|
|
|
4) Value transfer
|
|
|
|
== If contract creation ==
|
|
|
|
4a) Attempt to run transaction data
|
|
|
|
4b) If valid, use result as code for the new state object
|
|
|
|
== end ==
|
|
|
|
5) Run Script section
|
|
|
|
6) Derive new state root
|
|
|
|
*/
|
2014-06-13 03:58:01 -07:00
|
|
|
type StateTransition struct {
|
2017-10-31 15:24:11 -07:00
|
|
|
gp *GasPool
|
|
|
|
msg Message
|
|
|
|
gas uint64
|
|
|
|
gasPrice *big.Int
|
2018-05-23 22:32:26 -07:00
|
|
|
initialGas uint64
|
2017-10-31 15:24:11 -07:00
|
|
|
value *big.Int
|
|
|
|
data []byte
|
|
|
|
state vm.StateDB
|
|
|
|
evm *vm.EVM
|
2014-12-18 06:18:13 -08:00
|
|
|
}
|
|
|
|
|
2015-03-17 04:00:29 -07:00
|
|
|
// Message represents a message sent to a contract.
|
2014-12-18 06:18:13 -08:00
|
|
|
type Message interface {
|
2017-10-31 15:24:11 -07:00
|
|
|
From() common.Address
|
|
|
|
//FromFrontier() (common.Address, error)
|
2015-03-17 04:00:29 -07:00
|
|
|
To() *common.Address
|
2014-12-18 06:18:13 -08:00
|
|
|
|
|
|
|
GasPrice() *big.Int
|
2018-05-23 22:32:26 -07:00
|
|
|
Gas() uint64
|
2014-12-18 06:18:13 -08:00
|
|
|
Value() *big.Int
|
|
|
|
|
|
|
|
Nonce() uint64
|
2016-07-11 02:58:10 -07:00
|
|
|
CheckNonce() bool
|
2014-12-18 06:18:13 -08:00
|
|
|
Data() []byte
|
2014-06-13 03:58:01 -07:00
|
|
|
}
|
2015-03-18 05:00:01 -07:00
|
|
|
|
2016-11-17 03:15:04 -08:00
|
|
|
// PrivateMessage implements a private message
|
|
|
|
type PrivateMessage interface {
|
|
|
|
Message
|
|
|
|
IsPrivate() bool
|
|
|
|
}
|
|
|
|
|
2018-05-23 22:32:26 -07:00
|
|
|
// IntrinsicGas computes the 'intrinsic gas' for a message with the given data.
|
|
|
|
func IntrinsicGas(data []byte, contractCreation, homestead bool) (uint64, error) {
|
|
|
|
// Set the starting gas for the raw transaction
|
|
|
|
var gas uint64
|
2015-11-27 06:40:29 -08:00
|
|
|
if contractCreation && homestead {
|
2018-05-23 22:32:26 -07:00
|
|
|
gas = params.TxGasContractCreation
|
2015-11-27 06:40:29 -08:00
|
|
|
} else {
|
2018-05-23 22:32:26 -07:00
|
|
|
gas = params.TxGas
|
2015-11-27 06:40:29 -08:00
|
|
|
}
|
2018-05-23 22:32:26 -07:00
|
|
|
// Bump the required gas by the amount of transactional data
|
2015-06-25 05:46:44 -07:00
|
|
|
if len(data) > 0 {
|
2018-05-23 22:32:26 -07:00
|
|
|
// Zero and non-zero bytes are priced differently
|
|
|
|
var nz uint64
|
2015-06-25 05:46:44 -07:00
|
|
|
for _, byt := range data {
|
|
|
|
if byt != 0 {
|
|
|
|
nz++
|
|
|
|
}
|
2015-04-08 11:47:32 -07:00
|
|
|
}
|
2018-05-23 22:32:26 -07:00
|
|
|
// Make sure we don't exceed uint64 for all data combinations
|
|
|
|
if (math.MaxUint64-gas)/params.TxDataNonZeroGas < nz {
|
|
|
|
return 0, vm.ErrOutOfGas
|
|
|
|
}
|
|
|
|
gas += nz * params.TxDataNonZeroGas
|
|
|
|
|
|
|
|
z := uint64(len(data)) - nz
|
|
|
|
if (math.MaxUint64-gas)/params.TxDataZeroGas < z {
|
|
|
|
return 0, vm.ErrOutOfGas
|
|
|
|
}
|
|
|
|
gas += z * params.TxDataZeroGas
|
2015-04-08 11:47:32 -07:00
|
|
|
}
|
2018-05-23 22:32:26 -07:00
|
|
|
return gas, nil
|
2015-04-08 11:47:32 -07:00
|
|
|
}
|
|
|
|
|
2016-03-31 15:30:21 -07:00
|
|
|
// NewStateTransition initialises and returns a new state transition object.
|
2017-10-31 15:24:11 -07:00
|
|
|
func NewStateTransition(evm *vm.EVM, msg Message, gp *GasPool) *StateTransition {
|
|
|
|
return &StateTransition{
|
2018-05-29 06:05:18 -07:00
|
|
|
gp: gp,
|
|
|
|
evm: evm,
|
|
|
|
msg: msg,
|
|
|
|
gasPrice: msg.GasPrice(),
|
|
|
|
value: msg.Value(),
|
|
|
|
data: msg.Data(),
|
|
|
|
state: evm.PublicState(),
|
2014-12-18 06:18:13 -08:00
|
|
|
}
|
2016-03-31 15:30:21 -07:00
|
|
|
}
|
|
|
|
|
|
|
|
// ApplyMessage computes the new state by applying the given message
|
|
|
|
// against the old state within the environment.
|
|
|
|
//
|
|
|
|
// ApplyMessage returns the bytes returned by any EVM execution (if it took place),
|
|
|
|
// the gas used (which includes gas refunds) and an error if it failed. An error always
|
|
|
|
// indicates a core error meaning that the message would always fail for that particular
|
|
|
|
// state and would never be accepted within a block.
|
2017-10-31 15:24:11 -07:00
|
|
|
|
2018-05-23 22:32:26 -07:00
|
|
|
func ApplyMessage(evm *vm.EVM, msg Message, gp *GasPool) ([]byte, uint64, bool, error) {
|
|
|
|
return NewStateTransition(evm, msg, gp).TransitionDb()
|
2018-05-29 06:05:18 -07:00
|
|
|
}
|
2017-10-31 15:24:11 -07:00
|
|
|
|
2018-05-23 22:32:26 -07:00
|
|
|
// to returns the recipient of the message.
|
|
|
|
func (st *StateTransition) to() common.Address {
|
|
|
|
if st.msg == nil || st.msg.To() == nil /* contract creation */ {
|
|
|
|
return common.Address{}
|
2015-08-30 01:19:10 -07:00
|
|
|
}
|
2018-05-23 22:32:26 -07:00
|
|
|
return *st.msg.To()
|
2014-06-13 03:58:01 -07:00
|
|
|
}
|
2016-02-03 14:46:27 -08:00
|
|
|
|
2017-10-31 15:24:11 -07:00
|
|
|
func (st *StateTransition) useGas(amount uint64) error {
|
|
|
|
if st.gas < amount {
|
|
|
|
return vm.ErrOutOfGas
|
2014-06-13 03:58:01 -07:00
|
|
|
}
|
2017-10-31 15:24:11 -07:00
|
|
|
st.gas -= amount
|
2014-06-13 03:58:01 -07:00
|
|
|
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
2017-10-31 15:24:11 -07:00
|
|
|
func (st *StateTransition) buyGas() error {
|
2018-05-23 22:32:26 -07:00
|
|
|
mgval := new(big.Int).Mul(new(big.Int).SetUint64(st.msg.Gas()), st.gasPrice)
|
|
|
|
if st.state.GetBalance(st.msg.From()).Cmp(mgval) < 0 {
|
2017-10-31 15:24:11 -07:00
|
|
|
return errInsufficientBalanceForGas
|
2014-06-13 03:58:01 -07:00
|
|
|
}
|
2018-05-23 22:32:26 -07:00
|
|
|
if err := st.gp.SubGas(st.msg.Gas()); err != nil {
|
2014-06-13 03:58:01 -07:00
|
|
|
return err
|
|
|
|
}
|
2018-05-23 22:32:26 -07:00
|
|
|
st.gas += st.msg.Gas()
|
2017-10-31 15:24:11 -07:00
|
|
|
|
2018-05-23 22:32:26 -07:00
|
|
|
st.initialGas = st.msg.Gas()
|
|
|
|
st.state.SubBalance(st.msg.From(), mgval)
|
2014-06-13 03:58:01 -07:00
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
2017-10-31 15:24:11 -07:00
|
|
|
func (st *StateTransition) preCheck() error {
|
2018-05-23 22:32:26 -07:00
|
|
|
// Make sure this transaction's nonce is correct.
|
|
|
|
if st.msg.CheckNonce() {
|
|
|
|
nonce := st.state.GetNonce(st.msg.From())
|
|
|
|
if nonce < st.msg.Nonce() {
|
2017-10-31 15:24:11 -07:00
|
|
|
return ErrNonceTooHigh
|
2018-05-23 22:32:26 -07:00
|
|
|
} else if nonce > st.msg.Nonce() {
|
2017-10-31 15:24:11 -07:00
|
|
|
return ErrNonceTooLow
|
2015-03-13 09:47:11 -07:00
|
|
|
}
|
2014-06-19 04:41:17 -07:00
|
|
|
}
|
2017-10-31 15:24:11 -07:00
|
|
|
return st.buyGas()
|
2014-06-19 04:41:17 -07:00
|
|
|
}
|
|
|
|
|
2018-05-23 22:32:26 -07:00
|
|
|
// TransitionDb will transition the state by applying the current message and
|
2018-07-24 03:17:12 -07:00
|
|
|
// returning the result including the used gas. It returns an error if failed.
|
|
|
|
// An error indicates a consensus issue.
|
2018-05-23 22:32:26 -07:00
|
|
|
func (st *StateTransition) TransitionDb() (ret []byte, usedGas uint64, failed bool, err error) {
|
2017-10-31 15:24:11 -07:00
|
|
|
if err = st.preCheck(); err != nil {
|
2014-06-19 04:41:17 -07:00
|
|
|
return
|
|
|
|
}
|
2017-10-31 15:24:11 -07:00
|
|
|
msg := st.msg
|
2018-05-23 22:32:26 -07:00
|
|
|
sender := vm.AccountRef(msg.From())
|
2017-10-31 15:24:11 -07:00
|
|
|
homestead := st.evm.ChainConfig().IsHomestead(st.evm.BlockNumber)
|
|
|
|
contractCreation := msg.To() == nil
|
|
|
|
isQuorum := st.evm.ChainConfig().IsQuorum
|
|
|
|
|
|
|
|
var data []byte
|
|
|
|
isPrivate := false
|
|
|
|
publicState := st.state
|
|
|
|
if msg, ok := msg.(PrivateMessage); ok && isQuorum && msg.IsPrivate() {
|
2016-11-16 10:03:42 -08:00
|
|
|
isPrivate = true
|
2017-10-31 15:24:11 -07:00
|
|
|
data, err = private.P.Receive(st.data)
|
2016-11-16 15:05:44 -08:00
|
|
|
// Increment the public account nonce if:
|
|
|
|
// 1. Tx is private and *not* a participant of the group and either call or create
|
|
|
|
// 2. Tx is private we are part of the group and is a call
|
|
|
|
if err != nil || !contractCreation {
|
|
|
|
publicState.SetNonce(sender.Address(), publicState.GetNonce(sender.Address())+1)
|
|
|
|
}
|
|
|
|
|
2016-11-13 21:16:20 -08:00
|
|
|
if err != nil {
|
2018-05-23 22:32:26 -07:00
|
|
|
return nil, 0, false, nil
|
2016-11-13 21:16:20 -08:00
|
|
|
}
|
|
|
|
} else {
|
2017-10-31 15:24:11 -07:00
|
|
|
data = st.data
|
2016-11-13 21:16:20 -08:00
|
|
|
}
|
2016-11-13 21:34:50 -08:00
|
|
|
|
2018-12-10 01:58:16 -08:00
|
|
|
// Pay intrinsic gas. For a private contract this is done using the public hash passed in,
|
|
|
|
// not the private data retrieved above. This is because we need any (participant) validator
|
|
|
|
// node to get the same result as a (non-participant) minter node, to avoid out-of-gas issues.
|
2018-05-23 22:32:26 -07:00
|
|
|
gas, err := IntrinsicGas(st.data, contractCreation, homestead)
|
|
|
|
if err != nil {
|
|
|
|
return nil, 0, false, err
|
2017-10-31 15:24:11 -07:00
|
|
|
}
|
2018-05-23 22:32:26 -07:00
|
|
|
if err = st.useGas(gas); err != nil {
|
|
|
|
return nil, 0, false, err
|
2014-06-13 03:58:01 -07:00
|
|
|
}
|
|
|
|
|
2017-10-31 15:24:11 -07:00
|
|
|
var (
|
2018-12-10 01:58:16 -08:00
|
|
|
leftoverGas uint64
|
2019-05-20 08:23:12 -07:00
|
|
|
evm = st.evm
|
2017-10-31 15:24:11 -07:00
|
|
|
// vm errors do not effect consensus and are therefor
|
|
|
|
// not assigned to err, except for insufficient balance
|
|
|
|
// error.
|
|
|
|
vmerr error
|
|
|
|
)
|
2015-11-27 06:40:29 -08:00
|
|
|
if contractCreation {
|
2018-12-10 01:58:16 -08:00
|
|
|
ret, _, leftoverGas, vmerr = evm.Create(sender, data, st.gas, st.value)
|
2014-07-07 04:59:09 -07:00
|
|
|
} else {
|
2016-11-16 15:05:44 -08:00
|
|
|
// Increment the account nonce only if the transaction isn't private.
|
|
|
|
// If the transaction is private it has already been incremented on
|
|
|
|
// the public state.
|
|
|
|
if !isPrivate {
|
2018-05-23 22:32:26 -07:00
|
|
|
publicState.SetNonce(msg.From(), publicState.GetNonce(sender.Address())+1)
|
2016-11-16 15:05:44 -08:00
|
|
|
}
|
2017-10-31 15:24:11 -07:00
|
|
|
var to common.Address
|
|
|
|
if isQuorum {
|
|
|
|
to = *st.msg.To()
|
|
|
|
} else {
|
2018-05-23 22:32:26 -07:00
|
|
|
to = st.to()
|
2016-01-19 14:50:00 -08:00
|
|
|
}
|
2018-06-07 12:45:24 -07:00
|
|
|
//if input is empty for the smart contract call, return
|
2018-06-17 21:27:22 -07:00
|
|
|
if len(data) == 0 && isPrivate {
|
2018-06-13 21:12:20 -07:00
|
|
|
return nil, 0, false, nil
|
2018-06-11 11:12:52 -07:00
|
|
|
}
|
2018-08-06 04:03:51 -07:00
|
|
|
|
2018-12-10 01:58:16 -08:00
|
|
|
ret, leftoverGas, vmerr = evm.Call(sender, to, data, st.gas, st.value)
|
2014-07-07 04:59:09 -07:00
|
|
|
}
|
2017-10-31 15:24:11 -07:00
|
|
|
if vmerr != nil {
|
2019-01-09 21:54:38 -08:00
|
|
|
log.Info("VM returned with error", "err", vmerr)
|
2017-10-31 15:24:11 -07:00
|
|
|
// The only possible consensus-error would be if there wasn't
|
|
|
|
// sufficient balance to make the transfer happen. The first
|
|
|
|
// balance transfer may never fail.
|
|
|
|
if vmerr == vm.ErrInsufficientBalance {
|
2018-05-23 22:32:26 -07:00
|
|
|
return nil, 0, false, vmerr
|
2017-10-31 15:24:11 -07:00
|
|
|
}
|
2015-07-06 02:54:11 -07:00
|
|
|
}
|
2018-12-10 01:58:16 -08:00
|
|
|
|
2018-12-10 07:30:28 -08:00
|
|
|
// Pay gas used during contract creation or execution (st.gas tracks remaining gas)
|
|
|
|
// However, if private contract then we don't want to do this else we can get
|
|
|
|
// a mismatch between a (non-participant) minter and (participant) validator,
|
|
|
|
// which can cause a 'BAD BLOCK' crash.
|
2018-12-10 01:58:16 -08:00
|
|
|
if !isPrivate {
|
|
|
|
st.gas = leftoverGas
|
|
|
|
}
|
|
|
|
|
2017-10-31 15:24:11 -07:00
|
|
|
st.refundGas()
|
2018-05-23 22:32:26 -07:00
|
|
|
st.state.AddBalance(st.evm.Coinbase, new(big.Int).Mul(new(big.Int).SetUint64(st.gasUsed()), st.gasPrice))
|
2014-07-24 03:04:15 -07:00
|
|
|
|
2016-11-16 10:03:42 -08:00
|
|
|
if isPrivate {
|
2018-05-23 22:32:26 -07:00
|
|
|
return ret, 0, vmerr != nil, err
|
2016-11-16 10:03:42 -08:00
|
|
|
}
|
2018-05-23 22:32:26 -07:00
|
|
|
return ret, st.gasUsed(), vmerr != nil, err
|
2014-07-24 03:04:15 -07:00
|
|
|
}
|
2014-12-18 12:58:26 -08:00
|
|
|
|
2017-10-31 15:24:11 -07:00
|
|
|
func (st *StateTransition) refundGas() {
|
2015-09-02 03:55:11 -07:00
|
|
|
// Apply refund counter, capped to half of the used gas.
|
2018-05-23 22:32:26 -07:00
|
|
|
refund := st.gasUsed() / 2
|
|
|
|
if refund > st.state.GetRefund() {
|
|
|
|
refund = st.state.GetRefund()
|
|
|
|
}
|
|
|
|
st.gas += refund
|
2017-10-31 15:24:11 -07:00
|
|
|
|
2018-05-23 22:32:26 -07:00
|
|
|
// Return ETH for remaining gas, exchanged at the original rate.
|
|
|
|
remaining := new(big.Int).Mul(new(big.Int).SetUint64(st.gas), st.gasPrice)
|
|
|
|
st.state.AddBalance(st.msg.From(), remaining)
|
2014-12-18 12:58:26 -08:00
|
|
|
|
2015-09-02 03:55:11 -07:00
|
|
|
// Also return remaining gas to the block gas counter so it is
|
|
|
|
// available for the next transaction.
|
2018-05-23 22:32:26 -07:00
|
|
|
st.gp.AddGas(st.gas)
|
2014-12-18 12:58:26 -08:00
|
|
|
}
|
|
|
|
|
2018-05-23 22:32:26 -07:00
|
|
|
// gasUsed returns the amount of gas used up by the state transition.
|
|
|
|
func (st *StateTransition) gasUsed() uint64 {
|
|
|
|
return st.initialGas - st.gas
|
2014-12-18 12:58:26 -08:00
|
|
|
}
|