coreutil

Documentation

Overview

package coreutil provides functions to describe interface of the core contract in a compact way

Index

• Constants
• Variables
• func CoreHname(name string) isc.Hname
• type ChainStateSync
• type ChainStateSyncImpl
  • func NewChainStateSync() *ChainStateSyncImpl
  • func (g *ChainStateSyncImpl) GetSolidIndexBaseline() StateBaseline
  • func (g *ChainStateSyncImpl) InvalidateSolidIndex() ChainStateSync
  • func (g *ChainStateSyncImpl) SetSolidIndex(idx uint32) ChainStateSync
• type ContractInfo
  • func NewContract(name, description string) *ContractInfo
  • func (i *ContractInfo) FullKey(postfix []byte) []byte
  • func (i *ContractInfo) Hname() isc.Hname
  • func (i *ContractInfo) Processor(init Handler, eps ...ProcessorEntryPoint) *ContractProcessor
• type ContractProcessor
  • func (p *ContractProcessor) GetDescription() string
  • func (p *ContractProcessor) GetEntryPoint(code isc.Hname) (isc.VMProcessorEntryPoint, bool)
  • func (p *ContractProcessor) GetStateReadOnly(chainState kv.KVStoreReader) kv.KVStoreReader
• type EntryPointHandler
  • func (h *EntryPointHandler) Call(ctx interface{}) dict.Dict
  • func (h *EntryPointHandler) Hname() isc.Hname
  • func (h *EntryPointHandler) IsView() bool
  • func (h *EntryPointHandler) Name() string
• type EntryPointInfo
  • func Func(name string) EntryPointInfo
  • func (ep *EntryPointInfo) Hname() isc.Hname
  • func (ep *EntryPointInfo) WithHandler(fn Handler) *EntryPointHandler
• type Handler
• type ProcessorEntryPoint
• type StateBaseline
• type ViewEntryPointHandler
  • func (h *ViewEntryPointHandler) Call(ctx interface{}) dict.Dict
  • func (h *ViewEntryPointHandler) Hname() isc.Hname
  • func (h *ViewEntryPointHandler) IsView() bool
  • func (h *ViewEntryPointHandler) Name() string
• type ViewEntryPointInfo
  • func ViewFunc(name string) ViewEntryPointInfo
  • func (ep *ViewEntryPointInfo) Hname() isc.Hname
  • func (ep *ViewEntryPointInfo) WithHandler(fn ViewHandler) *ViewEntryPointHandler
• type ViewHandler

Constants

const (
	CoreContractDefault         = "_default"
	CoreContractRoot            = "root"
	CoreContractAccounts        = "accounts"
	CoreContractBlob            = "blob"
	CoreContractEventlog        = "eventlog"
	CoreContractBlocklog        = "blocklog"
	CoreContractErrors          = "errors"
	CoreContractGovernance      = "governance"
	CoreEPRotateStateController = "rotateStateController"
)

names of core contracts

const (
	StateVarTimestamp           = "T"
	StateVarBlockIndex          = "I"
	StateVarPrevL1Commitment    = "H"
	ParamStateControllerAddress = "S"
)

the global names used in 'blocklog' contract and in 'state' package

Variables

var (
	FuncFallback           = Func("fallbackHandler")
	FuncDefaultInitializer = Func("initializer")
)

var (
	CoreContractDefaultHname         = isc.Hname(0)
	CoreContractRootHname            = isc.Hn(CoreContractRoot)
	CoreContractAccountsHname        = isc.Hn(CoreContractAccounts)
	CoreContractBlobHname            = isc.Hn(CoreContractBlob)
	CoreContractEventlogHname        = isc.Hn(CoreContractEventlog)
	CoreContractBlocklogHname        = isc.Hn(CoreContractBlocklog)
	CoreContractErrorsHname          = isc.Hn(CoreContractErrors)
	CoreContractGovernanceHname      = isc.Hn(CoreContractGovernance)
	CoreEPRotateStateControllerHname = isc.Hn(CoreEPRotateStateController)
)

var (
	StatePrefixTimestamp        = string(CoreContractBlocklogHname.Bytes()) + StateVarTimestamp
	StatePrefixBlockIndex       = string(CoreContractBlocklogHname.Bytes()) + StateVarBlockIndex
	StatePrefixPrevL1Commitment = string(CoreContractBlocklogHname.Bytes()) + StateVarPrevL1Commitment
)

used in 'state' package as key for timestamp and block index

var ErrorStateInvalidated = xerrors.New("virtual state has been invalidated")

Functions

func CoreHname

func CoreHname(name string) isc.Hname

Types

type ChainStateSync

type ChainStateSync interface {
	GetSolidIndexBaseline() StateBaseline
	SetSolidIndex(idx uint32) ChainStateSync // for use in state manager
	InvalidateSolidIndex() ChainStateSync    // only for state manager
}

type ChainStateSyncImpl

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

func NewChainStateSync

func NewChainStateSync() *ChainStateSyncImpl

func (*ChainStateSyncImpl) GetSolidIndexBaseline

func (g *ChainStateSyncImpl) GetSolidIndexBaseline() StateBaseline

GetSolidIndexBaseline creates an instance of the state baseline linked to the global sync

func (*ChainStateSyncImpl) InvalidateSolidIndex

func (g *ChainStateSyncImpl) InvalidateSolidIndex() ChainStateSync

InvalidateSolidIndex invalidates state index and, globally, all baselines. All baselines remain invalid until SetSolidIndex is called globally and Set for each baseline individually

func (*ChainStateSyncImpl) SetSolidIndex

func (g *ChainStateSyncImpl) SetSolidIndex(idx uint32) ChainStateSync

SetSolidIndex sets solid index to the global sync and makes it valid To validate baselines, method Set should be called for each

type ContractInfo

type ContractInfo struct {
	Name        string
	Description string
	ProgramHash hashing.HashValue
}

ContractInfo holds basic information about a native smart contract

func NewContract

func NewContract(name, description string) *ContractInfo

func (*ContractInfo) FullKey

func (i *ContractInfo) FullKey(postfix []byte) []byte

FullKey concatenates 4 bytes of hname with postfix

func (*ContractInfo) Hname

func (i *ContractInfo) Hname() isc.Hname

func (*ContractInfo) Processor

func (i *ContractInfo) Processor(init Handler, eps ...ProcessorEntryPoint) *ContractProcessor

Processor creates a ContractProcessor with the provided handlers

type ContractProcessor

type ContractProcessor struct {
	Contract *ContractInfo
	Handlers map[isc.Hname]ProcessorEntryPoint
}

func (*ContractProcessor) GetDescription

func (p *ContractProcessor) GetDescription() string

func (*ContractProcessor) GetEntryPoint

func (p *ContractProcessor) GetEntryPoint(code isc.Hname) (isc.VMProcessorEntryPoint, bool)

func (*ContractProcessor) GetStateReadOnly

func (p *ContractProcessor) GetStateReadOnly(chainState kv.KVStoreReader) kv.KVStoreReader

type EntryPointHandler

type EntryPointHandler struct {
	Info    *EntryPointInfo
	Handler Handler
}

func (*EntryPointHandler) Call

func (h *EntryPointHandler) Call(ctx interface{}) dict.Dict

func (*EntryPointHandler) Hname

func (h *EntryPointHandler) Hname() isc.Hname

func (*EntryPointHandler) IsView

func (h *EntryPointHandler) IsView() bool

func (*EntryPointHandler) Name

func (h *EntryPointHandler) Name() string

type EntryPointInfo

type EntryPointInfo struct{ Name string }

EntryPointInfo holds basic information about a full entry point

func Func

func Func(name string) EntryPointInfo

Func declares a full entry point

func (*EntryPointInfo) Hname

func (ep *EntryPointInfo) Hname() isc.Hname

func (*EntryPointInfo) WithHandler

func (ep *EntryPointInfo) WithHandler(fn Handler) *EntryPointHandler

WithHandler specifies the handler function for the entry point

type Handler

type Handler func(ctx isc.Sandbox) dict.Dict

type ProcessorEntryPoint

type ProcessorEntryPoint interface {
	isc.VMProcessorEntryPoint
	Name() string
	Hname() isc.Hname
}

type StateBaseline

type StateBaseline interface {
	Set()
	IsValid() bool
	MustValidate()
}

type ViewEntryPointHandler

type ViewEntryPointHandler struct {
	Info    *ViewEntryPointInfo
	Handler ViewHandler
}

func (*ViewEntryPointHandler) Call

func (h *ViewEntryPointHandler) Call(ctx interface{}) dict.Dict

func (*ViewEntryPointHandler) Hname

func (h *ViewEntryPointHandler) Hname() isc.Hname

func (*ViewEntryPointHandler) IsView

func (h *ViewEntryPointHandler) IsView() bool

func (*ViewEntryPointHandler) Name

func (h *ViewEntryPointHandler) Name() string

type ViewEntryPointInfo

type ViewEntryPointInfo struct {
	Name string
}

ViewEntryPointInfo holds basic information about a view entry point

func ViewFunc

func ViewFunc(name string) ViewEntryPointInfo

ViewFunc declares a view entry point

func (*ViewEntryPointInfo) Hname

func (ep *ViewEntryPointInfo) Hname() isc.Hname

func (*ViewEntryPointInfo) WithHandler

func (ep *ViewEntryPointInfo) WithHandler(fn ViewHandler) *ViewEntryPointHandler

WithHandler specifies the handler function for the entry point

type ViewHandler

type ViewHandler func(ctx isc.SandboxView) dict.Dict