kernel

Documentation

Index

• Constants
• Variables
• type AmperKernel
  • func NewKernel(vmm *wasm.VMManager) (*AmperKernel, error)
  • func (xk *AmperKernel) GetName() string
  • func (xk *AmperKernel) NewContext(ctxCfg *contract.ContextConfig) (contract.Context, error)
• type ChainRegister
• type DeployMethod
  • func (dm *DeployMethod) Invoke(ctx *KContext, args map[string][]byte) ([]byte, error)
• type GetMethod
  • func (gm *GetMethod) Invoke(ctx *KContext, args map[string][]byte) ([]byte, error)
• type KContext
  • func (kc *KContext) AddResourceUsed(delta contract.Limits)
  • func (kc *KContext) AddXFeeUsed(delta int64)
  • func (kc *KContext) Invoke(methodName string, args map[string][]byte) ([]byte, error)
  • func (kc *KContext) Release() error
  • func (kc *KContext) ResourceUsed() contract.Limits
• type Kernel
  • func (k *Kernel) CreateBlockChain(name string, data []byte) error
  • func (k *Kernel) Finalize(blockid []byte) error
  • func (k *Kernel) GetCryptoType(data []byte) (string, error)
  • func (k *Kernel) GetKVEngineType(data []byte) (string, error)
  • func (k *Kernel) GetVATWhiteList() map[string]bool
  • func (k *Kernel) GetVerifiableAutogenTx(blockHeight int64, maxCount int, timestamp int64) ([]*pb.Transaction, error)
  • func (k *Kernel) Init(path string, log log.Logger, register ChainRegister, bcName string)
  • func (k *Kernel) ReadOutput(desc *contract.TxDesc) (contract.ContractOutputInterface, error)
  • func (k *Kernel) RemoveBlockChainData(name string) error
  • func (k *Kernel) Rollback(desc *contract.TxDesc) error
  • func (k *Kernel) Run(desc *contract.TxDesc) error
  • func (k *Kernel) SetContext(context *contract.TxContext) error
  • func (k *Kernel) SetMinNewChainAmount(amount string)
  • func (k *Kernel) SetNewChainWhiteList(whiteList map[string]bool)
  • func (k *Kernel) Stop()
• type Method
• type NewAccountMethod
  • func (na *NewAccountMethod) Invoke(ctx *KContext, args map[string][]byte) ([]byte, error)
• type SetAccountACLMethod
  • func (saa *SetAccountACLMethod) Invoke(ctx *KContext, args map[string][]byte) ([]byte, error)
• type SetMethod
  • func (sm *SetMethod) Invoke(ctx *KContext, args map[string][]byte) ([]byte, error)
• type SetMethodACLMethod
  • func (sma *SetMethodACLMethod) Invoke(ctx *KContext, args map[string][]byte) ([]byte, error)

Constants

const ModuleName = "xkernel"

ModuleName moudle name

Variables

var (
	// ErrBlockChainExist is returned when create an existed block chain
	ErrBlockChainExist = errors.New("BlockChain Exist")
	// ErrCreateBlockChain is returned when create block chain error
	ErrCreateBlockChain = errors.New("Create BlockChain error")
	// ErrMethodNotImplemented is returned when calling a nonexisted kernel method
	ErrMethodNotImplemented = errors.New("Method not implemented")
	// ErrNoEnoughUTXO is returned when has no enough money to create new chain
	ErrNoEnoughUTXO = errors.New("No enough money to create new chain")
	// ErrAddrNotInWhiteList is returned when address not in whitelist
	ErrAddrNotInWhiteList = errors.New("Address not in white list")
	// ErrPermissionDenied is returned when has no permission to call contract
	ErrPermissionDenied = errors.New("Permission denied to call this contract")
	// ErrInvalidChainName is returned when chain name is invalid
	ErrInvalidChainName = errors.New("Invalid Chain name")
)

Types

type AmperKernel

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

AmperKernel define kernel contract method type

func NewKernel

func NewKernel(vmm *wasm.VMManager) (*AmperKernel, error)

NewKernel new an instance of AmperKernel, initialized with kernel contract method

func (*AmperKernel) GetName

func (xk *AmperKernel) GetName() string

GetName get moudle name

func (*AmperKernel) NewContext

func (xk *AmperKernel) NewContext(ctxCfg *contract.ContextConfig) (contract.Context, error)

NewContext new a context, initialized with KernelContext

type ChainRegister

type ChainRegister interface {
	RegisterBlockChain(name string) error
	UnloadBlockChain(name string) error
}

ChainRegister register blockchains

type DeployMethod

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

DeployMethod define Deploy type

func (*DeployMethod) Invoke

func (dm *DeployMethod) Invoke(ctx *KContext, args map[string][]byte) ([]byte, error)

Invoke Deploy contract method implementation

type GetMethod

type GetMethod struct {
}

GetMethod define Get type

func (*GetMethod) Invoke

func (gm *GetMethod) Invoke(ctx *KContext, args map[string][]byte) ([]byte, error)

Invoke Get method implementation

type KContext

type KContext struct {
	ResourceLimit contract.Limits
	ModelCache    *xmodel.XMCache
	Initiator     string
	AuthRequire   []string
	ContextConfig *contract.ContextConfig
	// contains filtered or unexported fields
}

KContext define kernel contract context type

func (*KContext) AddResourceUsed

func (kc *KContext) AddResourceUsed(delta contract.Limits)

func (*KContext) AddXFeeUsed

func (kc *KContext) AddXFeeUsed(delta int64)

AddGasUsed set gas used when invoking kernel contract method

func (*KContext) Invoke

func (kc *KContext) Invoke(methodName string, args map[string][]byte) ([]byte, error)

Invoke entrance for kernel contract method invoke

func (*KContext) Release

func (kc *KContext) Release() error

Release release context

func (*KContext) ResourceUsed

func (kc *KContext) ResourceUsed() contract.Limits

type Kernel

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

Kernel is the kernel contract

func (*Kernel) CreateBlockChain

func (k *Kernel) CreateBlockChain(name string, data []byte) error

CreateBlockChain create a new block chain from amper.json

func (*Kernel) Finalize

func (k *Kernel) Finalize(blockid []byte) error

Finalize implements ContractInterface

func (*Kernel) GetCryptoType

func (k *Kernel) GetCryptoType(data []byte) (string, error)

GetCryptoType get crypto type from amper.json

func (*Kernel) GetKVEngineType

func (k *Kernel) GetKVEngineType(data []byte) (string, error)

GetKVEngineType get kv engine type from amper.json

func (*Kernel) GetVATWhiteList

func (k *Kernel) GetVATWhiteList() map[string]bool

GetVATWhiteList 实现VAT接口

func (*Kernel) GetVerifiableAutogenTx

func (k *Kernel) GetVerifiableAutogenTx(blockHeight int64, maxCount int, timestamp int64) ([]*pb.Transaction, error)

GetVerifiableAutogenTx 实现VAT接口

func (*Kernel) Init

func (k *Kernel) Init(path string, log log.Logger, register ChainRegister, bcName string)

Init initialize kernel contract

func (*Kernel) ReadOutput

func (k *Kernel) ReadOutput(desc *contract.TxDesc) (contract.ContractOutputInterface, error)

ReadOutput implements ContractInterface

func (*Kernel) RemoveBlockChainData

func (k *Kernel) RemoveBlockChainData(name string) error

RemoveBlockChainData remove all the data associate to the named blockchain

func (*Kernel) Rollback

func (k *Kernel) Rollback(desc *contract.TxDesc) error

Rollback implements ContractInterface

func (*Kernel) Run

func (k *Kernel) Run(desc *contract.TxDesc) error

Run implements ContractInterface

func (*Kernel) SetContext

func (k *Kernel) SetContext(context *contract.TxContext) error

SetContext implements ContractInterface

func (*Kernel) SetMinNewChainAmount

func (k *Kernel) SetMinNewChainAmount(amount string)

SetMinNewChainAmount set the minimum amount of token to create a block chain

func (*Kernel) SetNewChainWhiteList

func (k *Kernel) SetNewChainWhiteList(whiteList map[string]bool)

SetNewChainWhiteList set the whitelit of address who can create new block chain

func (*Kernel) Stop

func (k *Kernel) Stop()

Stop implements ContractInterface

type Method

type Method interface {
	Invoke(ctx *KContext, args map[string][]byte) ([]byte, error)
}

Method define method interface needed

type NewAccountMethod

type NewAccountMethod struct {
}

NewAccountMethod define NewAccountMethod type

func (*NewAccountMethod) Invoke

func (na *NewAccountMethod) Invoke(ctx *KContext, args map[string][]byte) ([]byte, error)

Invoke NewAccount method implementation

type SetAccountACLMethod

type SetAccountACLMethod struct {
}

SetAccountACLMethod define SetAccountACLMethod type

func (*SetAccountACLMethod) Invoke

func (saa *SetAccountACLMethod) Invoke(ctx *KContext, args map[string][]byte) ([]byte, error)

Invoke SetAccountACL method implementation

type SetMethod

type SetMethod struct {
}

SetMethod define Set type

func (*SetMethod) Invoke

func (sm *SetMethod) Invoke(ctx *KContext, args map[string][]byte) ([]byte, error)

Invoke Set method implementation

type SetMethodACLMethod

type SetMethodACLMethod struct {
}

SetMethodACLMethod define SetMethodACLMethod type

func (*SetMethodACLMethod) Invoke

func (sma *SetMethodACLMethod) Invoke(ctx *KContext, args map[string][]byte) ([]byte, error)

Invoke SetMethodACL method implementation