runtime

Documentation

Overview

Copyright (C) 2021 The Ontology Authors

Package runtime provides a basic execution model for executing EVM code.

Index

• func Call(address common.Address, input []byte, cfg *Config) ([]byte, uint64, error)
• func CanTransfer(db evm.StateDB, addr common.Address, amount *big.Int) bool
• func Create(input []byte, cfg *Config) ([]byte, common.Address, uint64, error)
• func Create2(input []byte, cfg *Config, salt *uint256.Int) ([]byte, common.Address, uint64, error)
• func Ensure(err error)
• func Execute(code, input []byte, cfg *Config) ([]byte, *storage.StateDB, error)
• func NewEnv(cfg *Config) *evm.EVM
• func Transfer(db evm.StateDB, sender, recipient common.Address, amount *big.Int)
• type Config
• type Contract
  • func Create2Contract(cfg *Config, jsonABI, hexCode string, salt uint64, params ...interface{}) *Contract
  • func CreateContract(cfg *Config, jsonABI string, hexCode string, params ...interface{}) *Contract
  • func NewContract(cfg *Config, jsonABI string, addr common.Address) *Contract
  • func (self *Contract) Balance() *big.Int
  • func (self *Contract) BalanceOf(addr common.Address) *big.Int
  • func (self *Contract) Call(method string, params ...interface{}) ([]byte, uint64, error)

Examples

• Execute

Functions

func Call

func Call(address common.Address, input []byte, cfg *Config) ([]byte, uint64, error)

Call executes the code given by the contract's address. It will return the EVM's return value or an error if it failed.

Call, unlike Execute, requires a config and also requires the State field to be set.

func CanTransfer

func CanTransfer(db evm.StateDB, addr common.Address, amount *big.Int) bool

CanTransfer checks whether there are enough funds in the address' account to make a transfer. This does not take the necessary gas in to account to make the transfer valid.

func Create

func Create(input []byte, cfg *Config) ([]byte, common.Address, uint64, error)

Create executes the code using the EVM create method

func Create2

func Create2(input []byte, cfg *Config, salt *uint256.Int) ([]byte, common.Address, uint64, error)

Create2 executes the code using the EVM create2 method

func Ensure

func Ensure(err error)

func Execute

func Execute(code, input []byte, cfg *Config) ([]byte, *storage.StateDB, error)

Execute executes the code using the input as call data during the execution. It returns the EVM's return value, the new state and an error if it failed.

Execute sets up an in-memory, temporary, environment for the execution of the given code. It makes sure that it's restored to its original state afterwards.

Example

package main

import (
	"fmt"

	"github.com/ethereum/go-ethereum/common"
	"github.com/ontio/ontology/vm/evm/runtime"
)

func main() {
	ret, _, err := runtime.Execute(common.Hex2Bytes("6060604052600a8060106000396000f360606040526008565b00"), nil, nil)
	if err != nil {
		fmt.Println(err)
	}
	fmt.Println(ret)
}

Output:

[96 96 96 64 82 96 8 86 91 0]

func NewEnv

func NewEnv(cfg *Config) *evm.EVM

func Transfer

func Transfer(db evm.StateDB, sender, recipient common.Address, amount *big.Int)

Transfer subtracts amount from sender and adds amount to recipient using the given Db

Types

type Config

type Config struct {
	ChainConfig *params.ChainConfig
	Difficulty  *big.Int
	Origin      common.Address
	Coinbase    common.Address
	BlockNumber *big.Int
	Time        *big.Int
	GasLimit    uint64
	GasPrice    *big.Int
	Value       *big.Int
	Debug       bool
	EVMConfig   evm.Config

	State     *storage.StateDB
	GetHashFn func(n uint64) common.Hash
}

Config is a basic type specifying certain configuration flags for running the EVM.

type Contract

type Contract struct {
	Abi        abi.ABI
	Cfg        *Config
	Address    common.Address
	AutoCommit bool
}

func Create2Contract

func Create2Contract(cfg *Config, jsonABI, hexCode string, salt uint64, params ...interface{}) *Contract

func CreateContract

func CreateContract(cfg *Config, jsonABI string, hexCode string, params ...interface{}) *Contract

func NewContract

func NewContract(cfg *Config, jsonABI string, addr common.Address) *Contract

func (*Contract) Balance

func (self *Contract) Balance() *big.Int

func (*Contract) BalanceOf

func (self *Contract) BalanceOf(addr common.Address) *big.Int

func (*Contract) Call

func (self *Contract) Call(method string, params ...interface{}) ([]byte, uint64, error)