state_transition.go

// Copyright 2018 The CortexTheseus Authors
// This file is part of the CortexFoundation library.
//
// The CortexFoundation 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 CortexFoundation 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 CortexFoundation library. If not, see <http://www.gnu.org/licenses/>.

package core

import (
	"errors"
	math2 "github.com/CortexFoundation/CortexTheseus/common/math"

	//	"fmt"
	"math"
	"math/big"

	"github.com/CortexFoundation/CortexTheseus/common"
	"github.com/CortexFoundation/CortexTheseus/core/vm"
	"github.com/CortexFoundation/CortexTheseus/log"
	"github.com/CortexFoundation/CortexTheseus/params"
	//"github.com/CortexFoundation/CortexTheseus/core/asm"
	//"github.com/CortexFoundation/CortexTheseus/common/mclock"
	//"github.com/CortexFoundation/CortexTheseus/torrentfs"
	//"time"
)

var (
	errInsufficientBalanceForGas = errors.New("insufficient balance to pay for gas")
	//PER_UPLOAD_BYTES             uint64 = 10 * 512 * 1024
)

/*
The State Transitioning Model

A state transition is a change made when a transaction is applied to the current world state
The state transitioning model does all the necessary work to work out a valid new state root.

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
*/
var (
	big0 = big.NewInt(0)
)

type StateTransition struct {
	gp         *GasPool
	qp         *QuotaPool
	msg        Message
	gas        uint64
	gasPrice   *big.Int
	initialGas uint64
	value      *big.Int
	data       []byte
	state      vm.StateDB
	cvm        *vm.CVM
	modelGas   map[common.Address]uint64
}

// Message represents a message sent to a contract.
type Message interface {
	From() common.Address
	//FromFrontier() (common.Address, error)
	To() *common.Address

	GasPrice() *big.Int
	Gas() uint64
	Value() *big.Int

	Nonce() uint64
	CheckNonce() bool
	Data() []byte
}

// IntrinsicGas computes the 'intrinsic gas' for a message with the given data.
func IntrinsicGas(data []byte, contractCreation, upload, homestead bool, isEIP2028 bool) (uint64, error) {
	// Set the starting gas for the raw transaction
	var gas uint64
	if contractCreation && homestead {
		gas = params.TxGasContractCreation
	} else {
		if upload {
			gas = params.UploadGas
		} else {
			gas = params.TxGas
		}
	}
	// Bump the required gas by the amount of transactional data
	if len(data) > 0 {
		// Zero and non-zero bytes are priced differently
		var nz uint64
		for _, byt := range data {
			if byt != 0 {
				nz++
			}
		}
		// Make sure we don't exceed uint64 for all data combinations
		nonZeroGas := params.TxDataNonZeroGasFrontier
		if isEIP2028 {
			nonZeroGas = params.TxDataNonZeroGasEIP2028
		}
		if (math.MaxUint64-gas)/nonZeroGas < nz {
			return 0, vm.ErrOutOfGas
		}
		gas += nz * nonZeroGas

		z := uint64(len(data)) - nz
		if (math.MaxUint64-gas)/params.TxDataZeroGas < z {
			return 0, vm.ErrOutOfGas
		}
		gas += z * params.TxDataZeroGas
	}
	return gas, nil
}

// NewStateTransition initialises and returns a new state transition object.
func NewStateTransition(cvm *vm.CVM, msg Message, gp *GasPool, qp *QuotaPool) *StateTransition {
	return &StateTransition{
		gp:       gp,
		qp:       qp,
		cvm:      cvm,
		msg:      msg,
		gasPrice: msg.GasPrice(),
		value:    msg.Value(),
		data:     msg.Data(),
		state:    cvm.StateDB,
	}
}

// ApplyMessage computes the new state by applying the given message
// against the old state within the environment.
//
// ApplyMessage returns the bytes returned by any CVM 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.
func ApplyMessage(cvm *vm.CVM, msg Message, gp *GasPool, qp *QuotaPool) ([]byte, uint64, uint64, bool, error) {
	return NewStateTransition(cvm, msg, gp, qp).TransitionDb()
}

// 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{}
	}
	return *st.msg.To()
}

func (st *StateTransition) useGas(amount uint64) error {
	if st.gas < amount {
		return vm.ErrOutOfGas
	}
	st.gas -= amount

	return nil
}

func (st *StateTransition) buyGas() error {
	mgval := new(big.Int).Mul(new(big.Int).SetUint64(st.msg.Gas()), st.gasPrice)
	if st.state.GetBalance(st.msg.From()).Cmp(mgval) < 0 {
		return errInsufficientBalanceForGas
	}
	if err := st.gp.SubGas(st.msg.Gas()); err != nil {
		return err
	}
	st.gas += st.msg.Gas()

	st.initialGas = st.msg.Gas()
	st.state.SubBalance(st.msg.From(), mgval)
	return nil
}

//var confirmTime = params.CONFIRM_TIME * time.Second //-3600 * 24 * 30 * time.Second
func (st *StateTransition) preCheck() error {
	// Make sure this transaction's nonce is correct.
	if st.msg.CheckNonce() {
		nonce := st.state.GetNonce(st.msg.From())
		if nonce < st.msg.Nonce() {
			return ErrNonceTooHigh
		} else if nonce > st.msg.Nonce() {
			return ErrNonceTooLow
		}
	}

	if st.uploading() {
		// log.Debug("state_transition", "uploading", st.uploading(), "st.state.GetNum(st.to())", st.state.GetNum(st.to()))
		if st.state.GetNum(st.to()).Cmp(big0) <= 0 {
			log.Warn("Uploading block number is zero", "address", st.to(), "number", st.state.GetNum(st.to()), "current", st.cvm.BlockNumber)
			return ErrUnhandleTx
		}

		if st.state.GetNum(st.to()).Cmp(new(big.Int).Sub(st.cvm.BlockNumber, big.NewInt(params.SeedingBlks))) > 0 {
			log.Warn("Not ready for seeding", "address", st.to(), "number", st.state.GetNum(st.to()), "current", st.cvm.BlockNumber, "seeding", params.SeedingBlks)
			return ErrUnhandleTx
		}
		cost := math2.Uint64Min(params.PER_UPLOAD_BYTES, st.state.Upload(st.to()).Uint64())
		// log.Debug("state_transition",
		// 				  "new(big.Int).SetUint64(params.PER_UPLOAD_BYTES)", new(big.Int).SetUint64(params.PER_UPLOAD_BYTES),
		// 					"st.state.Upload(st.to())", st.state.Upload(st.to()), "cost", cost, "st.qp", st.qp)
		if err := st.qp.SubQuota(cost); err != nil {
			log.Warn("Quota waiting ... ...", "quotapool", st.qp.String(), "cost", st.state.Upload(st.to()), "current", st.cvm.BlockNumber)
			return ErrQuotaLimitReached
		}

		//meta, err := st.cvm.GetMetaHash(st.to())
		//if err != nil {
		//	log.Warn("Uploading meta is not exist", "address", st.to(), "number", st.state.GetNum(st.to()), "current", st.cvm.BlockNumber)
		//	return ErrUnhandleTx
		//}

		//errCh := make(chan error)
		//go st.TorrentSync(meta, st.cvm.Config().StorageDir, errCh)
		//select {
		//case err := <-errCh:
		//	if err != nil {
		//		return err
		//	}
		//}
	}

	return st.buyGas()
}

/*const interv = 5

func (st *StateTransition) TorrentSync(meta common.Address, dir string, errCh chan error) {
	street := big.NewInt(0).Sub(st.cvm.PeekNumber, st.cvm.BlockNumber)
	point := big.NewInt(time.Now().Add(confirmTime).Unix())
	if point.Cmp(st.cvm.Context.Time) > 0 || street.Cmp(big.NewInt(params.CONFIRM_BLOCKS)) > 0 {
		duration := big.NewInt(0).Sub(big.NewInt(time.Now().Unix()), st.cvm.Context.Time)
		cost := big.NewInt(0)
		for i := 0; i < 3600 && duration.Cmp(cost) > 0; i++ {
			if !torrentfs.ExistTorrent(meta.Hex()) {
				log.Warn("Torrent synchronizing ... ...", "tvm", st.cvm.Context.Time, "duration", duration, "ago", common.PrettyDuration(time.Duration(duration.Uint64()*1000000000)), "level", i, "number", st.cvm.BlockNumber, "cost", cost, "peek", st.cvm.PeekNumber, "street", street)
				cost.Add(cost, big.NewInt(interv))
				time.Sleep(time.Second * interv)
				continue
			} else {
				log.Debug("Torrent has been found", "address", st.to(), "number", st.state.GetNum(st.to()), "current", st.cvm.BlockNumber, "meta", meta, "storage", dir, "level", i, "duration", duration, "ago", common.PrettyDuration(time.Duration(duration.Uint64()*1000000000)), "cost", cost)
				errCh <- nil
				return
			}
		}

		log.Error("Torrent synchronized timeout", "address", st.to(), "number", st.state.GetNum(st.to()), "current", st.cvm.BlockNumber, "meta", meta, "storage", dir, "street", street, "duration", duration, "cost", cost)
	} else {
		if !torrentfs.ExistTorrent(meta.Hex()) {
			log.Warn("Torrent not exist", "address", st.to(), "number", st.state.GetNum(st.to()), "current", st.cvm.BlockNumber, "meta", meta, "storage", dir)
			errCh <- ErrUnhandleTx
			return
		} else {
			errCh <- nil
			return
		}
	}

	if !torrentfs.ExistTorrent(meta.Hex()) {
		log.Error("Torrent synchronized failed", "address", st.to(), "number", st.state.GetNum(st.to()), "current", st.cvm.BlockNumber, "meta", meta, "storage", dir, "street", street)
		errCh <- ErrUnhandleTx
		return
	} else {
		errCr <- nil
		return
	}
}*/

// TransitionDb will transition the state by applying the current message and
// returning the result including the used gas. It returns an error if failed.
// An error indicates a consensus issue.

func (st *StateTransition) TransitionDb() (ret []byte, usedGas uint64, quotaUsed uint64, failed bool, err error) {
	if err = st.preCheck(); err != nil {
		return
	}

	msg := st.msg
	sender := vm.AccountRef(msg.From())
	homestead := st.cvm.ChainConfig().IsHomestead(st.cvm.BlockNumber)
	istanbul := st.cvm.ChainConfig().IsIstanbul(st.cvm.BlockNumber)
	matureBlockNumber := st.cvm.ChainConfig().GetMatureBlock()
	contractCreation := msg.To() == nil

	/*if st.uploading() {
		if st.qp.Cmp(st.state.Upload(st.to())) < 0 {
			return nil, 0, big0, false,ErrQuotaLimitReached
		}
	}*/

	// Pay intrinsic gas
	gas, err := IntrinsicGas(st.data, contractCreation, st.uploading(), homestead, istanbul)
	if err != nil {
		return nil, 0, 0, false, err
	}
	if err = st.useGas(gas); err != nil {
		return nil, 0, 0, false, err
	}

	if msg.Value().Sign() > 0 && !st.cvm.Context.CanTransfer(st.state, msg.From(), msg.Value()) {
		return nil, 0, 0, false, ErrInsufficientFundsForTransfer
	}

	var (
		cvm = st.cvm
		// vm errors do not effect consensus and are therefor
		// not assigned to err, except for insufficient balance
		// error.
		vmerr error
	)
	if contractCreation {
		ret, _, st.gas, st.modelGas, vmerr = st.cvm.Create(sender, st.data, st.gas, st.value)
	} else {
		// Increment the nonce for the next transaction
		//if pool.config.NoInfers && asm.HasInferOp(tx.Data()) {
		//	fmt.Println("Has INFER operation !!! continue ...")
		//}
		st.state.SetNonce(msg.From(), st.state.GetNonce(sender.Address())+1)
		ret, st.gas, st.modelGas, vmerr = st.cvm.Call(sender, st.to(), st.data, st.gas, st.value)
	}

	if vmerr != nil {
		//log.Warn("VM returned with error", "err", vmerr)

		//log.Warn("VM returned with error", "err", vmerr, "number", cvm.BlockNumber, "from", msg.From().Hex())

		if vmerr == vm.ErrRuntime {
			return nil, 0, 0, false, vmerr
		}

		log.Debug("VM returned with error", "err", vmerr, "number", cvm.BlockNumber, "from", msg.From().Hex())

		// 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 {
			return nil, 0, 0, false, vmerr
		}

		//if vmerr == vm.ErrMetaInfoNotMature {
		//	return nil, 0, big0, false, vmerr
		//}
	}

	//gas cost below this line

	st.refundGas()
	//model gas
	gu := st.gasUsed()
	//if (vmerr == nil || vmerr == vm.ErrOutOfGas) && st.modelGas != nil && len(st.modelGas) > 0 { //pay ctx to the model authors by the model gas * current price
	if (vmerr == nil || (st.cvm.ChainConfig().ChainID.Uint64() == 21 && st.cvm.BlockNumber.Cmp(big.NewInt(16000)) < 0 && vmerr == vm.ErrOutOfGas)) && st.modelGas != nil && len(st.modelGas) > 0 {
		for addr, mgas := range st.modelGas {
			if int64(mgas) <= 0 || mgas > params.MODEL_GAS_UP_LIMIT {
				continue
			}

			gu -= mgas
			if gu < 0 { //should never happen
				//if mgas+gu > 0 {
				//	st.state.AddBalance(addr, new(big.Int).Mul(new(big.Int).SetUint64(mgas+gu), st.gasPrice))
				//}

				return nil, 0, 0, false, vm.ErrInsufficientBalance
			}
			reward := new(big.Int).Mul(new(big.Int).SetUint64(mgas), st.gasPrice)
			log.Debug("Model author reward", "author", addr.Hex(), "reward", reward, "number", cvm.BlockNumber)
			st.state.AddBalance(addr, reward)
		}
	}

	//normal gas
	st.state.AddBalance(st.cvm.Coinbase, new(big.Int).Mul(new(big.Int).SetUint64(gu), st.gasPrice))

	quota := uint64(0) //default used 4 k quota every tx for testing
	if vmerr == nil && st.uploading() {
		quota = math2.Uint64Min(params.PER_UPLOAD_BYTES, st.state.Upload(st.to()).Uint64())

		st.state.SubUpload(st.to(), new(big.Int).SetUint64(quota)) //64 ~ 1024 bytes
		if !st.state.Uploading(st.to()) {
			st.state.SetNum(st.to(), st.cvm.BlockNumber)
			log.Debug("Upload OK", "address", st.to().Hex(), "waiting", matureBlockNumber, "number", cvm.BlockNumber)
			//todo vote for model
		} else {
			log.Debug("Waiting ...", "ticket", st.state.Upload(st.to()).Uint64(), "address", st.to().Hex(), "number", cvm.BlockNumber)
		}
	}

	//if quota.Cmp(big0) > 0 {
	//	log.Info("Quota consumption", "address", st.to().Hex(), "amount", quota)
	//}

	return ret, st.gasUsed(), quota, vmerr != nil, err
}

func Min(x, y *big.Int) *big.Int {
	if x.Cmp(y) < 0 {
		return x
	}
	return y
}

func Max(x, y *big.Int) *big.Int {
	if x.Cmp(y) > 0 {
		return x
	}
	return y
}

//vote to model
func (st *StateTransition) uploading() bool {
	log.Trace("Vote tx", "to", st.msg.To(), "sign", st.value.Sign(), "uploading", st.state.Uploading(st.to()), "gas", st.gas, "limit", params.UploadGas)
	return st.msg != nil && st.msg.To() != nil && st.value.Sign() == 0 && st.state.Uploading(st.to()) // && st.gas >= params.UploadGas
}

func (st *StateTransition) refundGas() {
	// Apply refund counter, capped to half of the used gas.
	refund := st.gasUsed() / 2
	if refund > st.state.GetRefund() {
		refund = st.state.GetRefund()
	}
	st.gas += refund

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

	// Also return remaining gas to the block gas counter so it is
	// available for the next transaction.
	st.gp.AddGas(st.gas)
}

// gasUsed returns the amount of gas used up by the state transition.
func (st *StateTransition) gasUsed() uint64 {
	return st.initialGas - st.gas
}