vm

Documentation

Index

• Constants
• Variables
• func HasPermission(appState AppState, acc *Account, perm ptypes.PermFlag) bool
• func RegisterNativeContract(addr Word256, fn NativeContract) bool
• func RegisteredNativeContract(addr Word256) bool
• func S256(x *big.Int) *big.Int
• func SetDebug(d bool)
• func U256(x *big.Int) *big.Int
• func ValidPermN(n ptypes.PermFlag) bool
• type Account
  • func (acc *Account) String() string
• type AppState
• type Debug
  • func (d Debug) Printf(s string, a ...interface{})
• type ErrInvalidPermission
  • func (e ErrInvalidPermission) Error() string
• type ErrPermission
  • func (err ErrPermission) Error() string
• type NativeContract
• type Params
• type SNativeFuncDescription
• type Stack
  • func NewStack(capacity int, gas *int64, err *error) *Stack
  • func (st *Stack) Dup(n int)
  • func (st *Stack) Len() int
  • func (st *Stack) Peek() Word256
  • func (st *Stack) Pop() Word256
  • func (st *Stack) Pop64() int64
  • func (st *Stack) PopBytes() []byte
  • func (st *Stack) Print(n int)
  • func (st *Stack) Push(d Word256)
  • func (st *Stack) Push64(i int64)
  • func (st *Stack) PushBytes(bz []byte)
  • func (st *Stack) Swap(n int)
• type VM
  • func NewVM(appState AppState, params Params, origin Word256, txid []byte) *VM
  • func (vm *VM) Call(caller, callee *Account, code, input []byte, value int64, gas *int64) (output []byte, err error)
  • func (vm *VM) DelegateCall(caller, callee *Account, code, input []byte, value int64, gas *int64) (output []byte, err error)
  • func (vm *VM) SetFireable(evc events.Fireable)

Constants

const (
	GasSha3          int64 = 1
	GasGetAccount    int64 = 1
	GasStorageUpdate int64 = 1

	GasBaseOp  int64 = 0 // TODO: make this 1
	GasStackOp int64 = 1

	GasEcRecover     int64 = 1
	GasSha256Word    int64 = 1
	GasSha256Base    int64 = 1
	GasRipemd160Word int64 = 1
	GasRipemd160Base int64 = 1
	GasIdentityWord  int64 = 1
	GasIdentityBase  int64 = 1
)

Variables

var (
	ErrUnknownAddress      = errors.New("Unknown address")
	ErrInsufficientBalance = errors.New("Insufficient balance")
	ErrInvalidJumpDest     = errors.New("Invalid jump dest")
	ErrInsufficientGas     = errors.New("Insufficient gas")
	ErrMemoryOutOfBounds   = errors.New("Memory out of bounds")
	ErrCodeOutOfBounds     = errors.New("Code out of bounds")
	ErrInputOutOfBounds    = errors.New("Input out of bounds")
	ErrCallStackOverflow   = errors.New("Call stack overflow")
	ErrCallStackUnderflow  = errors.New("Call stack underflow")
	ErrDataStackOverflow   = errors.New("Data stack overflow")
	ErrDataStackUnderflow  = errors.New("Data stack underflow")
	ErrInvalidContract     = errors.New("Invalid contract")
)

var PermissionsContract = "permissions_contract"

var PermsMap = map[string]SNativeFuncDescription{
	"e8145855": SNativeFuncDescription{"has_role", 2, ptypes.HasRole, has_role},
	"180d26f2": SNativeFuncDescription{"unset_base", 2, ptypes.UnsetBase, unset_base},
	"3a3fcc59": SNativeFuncDescription{"set_global", 2, ptypes.SetGlobal, set_global},
	"3fbf7da5": SNativeFuncDescription{"add_role", 2, ptypes.AddRole, add_role},
	"9ea53314": SNativeFuncDescription{"set_base", 3, ptypes.SetBase, set_base},
	"bb37737a": SNativeFuncDescription{"has_base", 2, ptypes.HasBase, has_base},
	"28fd0194": SNativeFuncDescription{"rm_role", 2, ptypes.RmRole, rm_role},
}

function identifiers from the solidity abi

Functions

func HasPermission

func HasPermission(appState AppState, acc *Account, perm ptypes.PermFlag) bool

CONTRACT: it is the duty of the contract writer to call known permissions we do not convey if a permission is not set (unlike in state/execution, where we guarantee HasPermission is called on known permissions and panics else) If the perm is not defined in the acc nor set by default in GlobalPermissions, prints a log warning and returns false.

func RegisterNativeContract

func RegisterNativeContract(addr Word256, fn NativeContract) bool

func RegisteredNativeContract

func RegisteredNativeContract(addr Word256) bool

func S256

func S256(x *big.Int) *big.Int

func SetDebug

func SetDebug(d bool)

func U256

func U256(x *big.Int) *big.Int

func ValidPermN

func ValidPermN(n ptypes.PermFlag) bool

Checks if a permission flag is valid (a known base chain or snative permission)

Types

type Account

type Account struct {
	Address Word256
	Balance int64
	Code    []byte
	Nonce   int64
	Other   interface{} // For holding all other data.

	Permissions ptypes.AccountPermissions
}

func (*Account) String

func (acc *Account) String() string

type AppState

type AppState interface {

	// Accounts
	GetAccount(addr Word256) *Account
	UpdateAccount(*Account)
	RemoveAccount(*Account)
	CreateAccount(*Account) *Account

	// Storage
	GetStorage(Word256, Word256) Word256
	SetStorage(Word256, Word256, Word256) // Setting to Zero is deleting.

}

type Debug

type Debug bool

func (Debug) Printf

func (d Debug) Printf(s string, a ...interface{})

type ErrInvalidPermission

type ErrInvalidPermission struct {
	Address Word256
	SNative string
}

func (ErrInvalidPermission) Error

func (e ErrInvalidPermission) Error() string

type ErrPermission

type ErrPermission struct {
	// contains filtered or unexported fields
}

func (ErrPermission) Error

func (err ErrPermission) Error() string

type NativeContract

type NativeContract func(appState AppState, caller *Account, input []byte, gas *int64) (output []byte, err error)

type Params

type Params struct {
	BlockHeight int64
	BlockHash   Word256
	BlockTime   int64
	GasLimit    int64
}

type SNativeFuncDescription

type SNativeFuncDescription struct {
	Name     string
	NArgs    int
	PermFlag ptypes.PermFlag
	F        NativeContract
}

type Stack

type Stack struct {
	// contains filtered or unexported fields
}

Not goroutine safe

func NewStack

func NewStack(capacity int, gas *int64, err *error) *Stack

func (*Stack) Dup

func (st *Stack) Dup(n int)

func (*Stack) Len

func (st *Stack) Len() int

func (*Stack) Peek

func (st *Stack) Peek() Word256

Not an opcode, costs no gas.

func (*Stack) Pop

func (st *Stack) Pop() Word256

func (*Stack) Pop64

func (st *Stack) Pop64() int64

func (*Stack) PopBytes

func (st *Stack) PopBytes() []byte

func (*Stack) Print

func (st *Stack) Print(n int)

func (*Stack) Push

func (st *Stack) Push(d Word256)

func (*Stack) Push64

func (st *Stack) Push64(i int64)

func (*Stack) PushBytes

func (st *Stack) PushBytes(bz []byte)

currently only called after Sha3

func (*Stack) Swap

func (st *Stack) Swap(n int)

type VM

type VM struct {
	// contains filtered or unexported fields
}

func NewVM

func NewVM(appState AppState, params Params, origin Word256, txid []byte) *VM

func (*VM) Call

func (vm *VM) Call(caller, callee *Account, code, input []byte, value int64, gas *int64) (output []byte, err error)

CONTRACT appState is aware of caller and callee, so we can just mutate them. CONTRACT code and input are not mutated. CONTRACT returned 'ret' is a new compact slice. value: To be transferred from caller to callee. Refunded upon error. gas: Available gas. No refunds for gas. code: May be nil, since the CALL opcode may be used to send value from contracts to accounts

func (*VM) DelegateCall

func (vm *VM) DelegateCall(caller, callee *Account, code, input []byte, value int64, gas *int64) (output []byte, err error)

DelegateCall is executed by the DELEGATECALL opcode, introduced as off Ethereum Homestead. The intent of delegate call is to run the code of the callee in the storage context of the caller; while preserving the original caller to the previous callee. Different to the normal CALL or CALLCODE, the value does not need to be transferred to the callee.

func (*VM) SetFireable

func (vm *VM) SetFireable(evc events.Fireable)

satisfies events.Eventable