vmerror.go

package isc

import (
	"encoding/json"
	"errors"
	"fmt"
	"hash/crc32"
	"math"

	"github.com/iotaledger/hive.go/serializer/v2/marshalutil"
	"github.com/iotaledger/wasp/packages/hashing"
)

const VMErrorMessageLimit = math.MaxUint16

// VMCoreErrorContractID defines that all errors with a MaxUint32 contract id will be considered as core errors.
const VMCoreErrorContractID = math.MaxUint32

type VMErrorCode struct {
	ContractID Hname
	ID         uint16
}

func NewVMErrorCode(contractID Hname, id uint16) VMErrorCode {
	return VMErrorCode{ContractID: contractID, ID: id}
}

func NewCoreVMErrorCode(id uint16) VMErrorCode {
	return VMErrorCode{ContractID: VMCoreErrorContractID, ID: id}
}

func (c VMErrorCode) String() string {
	if c.ContractID == VMCoreErrorContractID {
		return fmt.Sprintf("%04x", c.ID)
	}
	return fmt.Sprintf("%s:%04x", c.ContractID, c.ID)
}

func (c VMErrorCode) Bytes() []byte {
	mu := marshalutil.New()
	c.Serialize(mu)
	return mu.Bytes()
}

func (c VMErrorCode) Serialize(mu *marshalutil.MarshalUtil) {
	mu.Write(c.ContractID).
		WriteUint16(c.ID)
}

func VMErrorCodeFromBytes(b []byte) (code VMErrorCode, err error) {
	return VMErrorCodeFromMarshalUtil(marshalutil.New(b))
}

func VMErrorCodeFromMarshalUtil(mu *marshalutil.MarshalUtil) (code VMErrorCode, err error) {
	if code.ContractID, err = HnameFromMarshalUtil(mu); err != nil {
		return
	}
	if code.ID, err = mu.ReadUint16(); err != nil {
		return
	}
	return
}

// VMErrorBase is the common interface of UnresolvedVMError and VMError
type VMErrorBase interface {
	error
	Code() VMErrorCode
}

type VMErrorTemplate struct {
	code          VMErrorCode
	messageFormat string
}

var _ VMErrorBase = &VMErrorTemplate{}

func NewVMErrorTemplate(code VMErrorCode, messageFormat string) *VMErrorTemplate {
	return &VMErrorTemplate{code: code, messageFormat: messageFormat}
}

// VMErrorTemplate implements error just in case someone panics with
// VMErrorTemplate by mistake, so that we don't crash the VM because of that.
func (e *VMErrorTemplate) Error() string {
	// calling Sprintf so that it marks missing parameters as errors
	return fmt.Sprintf(e.messageFormat)
}

func (e *VMErrorTemplate) Code() VMErrorCode {
	return e.code
}

func (e *VMErrorTemplate) MessageFormat() string {
	return e.messageFormat
}

func (e *VMErrorTemplate) Create(params ...interface{}) *VMError {
	return &VMError{
		template: e,
		params:   params,
	}
}

func (e *VMErrorTemplate) Serialize(mu *marshalutil.MarshalUtil) {
	e.code.Serialize(mu)

	messageFormatBytes := []byte(e.MessageFormat())
	mu.WriteUint16(uint16(len(messageFormatBytes))).
		WriteBytes(messageFormatBytes)
}

func (e *VMErrorTemplate) Bytes() []byte {
	mu := marshalutil.New()
	e.Serialize(mu)
	return mu.Bytes()
}

func VMErrorTemplateFromMarshalUtil(mu *marshalutil.MarshalUtil) (*VMErrorTemplate, error) {
	var err error
	e := &VMErrorTemplate{}

	if e.code, err = VMErrorCodeFromMarshalUtil(mu); err != nil {
		return nil, err
	}

	var messageLength uint16
	if messageLength, err = mu.ReadUint16(); err != nil {
		return nil, err
	}
	messageInBytes, err := mu.ReadBytes(int(messageLength))
	if err != nil {
		return nil, err
	}
	e.messageFormat = string(messageInBytes)
	return e, nil
}

type UnresolvedVMError struct {
	ErrorCode VMErrorCode   `json:"code"`
	Params    []interface{} `json:"params"`
	Hash      uint32        `json:"hash"`
}

var _ VMErrorBase = &UnresolvedVMError{}

func (e *UnresolvedVMError) Error() string {
	return fmt.Sprintf("UnresolvedVMError(code: %s, hash: %x)", e.ErrorCode, e.Hash)
}

func (e *UnresolvedVMError) Code() VMErrorCode {
	return e.ErrorCode
}

func (e *UnresolvedVMError) deserializeParams(mu *marshalutil.MarshalUtil) error {
	var err error
	var paramLength uint16
	var params []byte

	if paramLength, err = mu.ReadUint16(); err != nil {
		return err
	}

	if params, err = mu.ReadBytes(int(paramLength)); err != nil {
		return err
	}

	return json.Unmarshal(params, &e.Params)
}

func (e *UnresolvedVMError) serializeParams(mu *marshalutil.MarshalUtil) {
	bytes, err := json.Marshal(e.Params)
	if err != nil {
		panic(err)
	}

	mu.WriteUint16(uint16(len(bytes)))
	mu.WriteBytes(bytes)
}

func (e *UnresolvedVMError) Bytes() []byte {
	mu := marshalutil.New()
	e.ErrorCode.Serialize(mu)
	mu.WriteUint32(e.Hash)
	e.serializeParams(mu)
	return mu.Bytes()
}

func (e *UnresolvedVMError) AsGoError() error {
	// this is necessary because *UnresolvedVMError(nil) != error(nil)
	if e == nil {
		return nil
	}
	return e
}

type VMError struct {
	template *VMErrorTemplate
	params   []interface{}
}

var _ VMErrorBase = &VMError{}

func (e *VMError) Code() VMErrorCode {
	return e.template.code
}

func (e *VMError) MessageFormat() string {
	return e.template.messageFormat
}

func (e *VMError) Params() []interface{} {
	return e.params
}

func (e *VMError) Error() string {
	if e == nil {
		return ""
	}
	return fmt.Sprintf(e.MessageFormat(), e.params...)
}

func (e *VMError) Hash() uint32 {
	if e.MessageFormat() == "" {
		return 0
	}

	hash := crc32.Checksum([]byte(e.Error()), crc32.IEEETable)
	return hash
}

func (e *VMError) serializeParams(mu *marshalutil.MarshalUtil) {
	bytes, err := json.Marshal(e.params)
	if err != nil {
		panic(err)
	}

	mu.WriteUint16(uint16(len(bytes)))
	mu.WriteBytes(bytes)
}

func (e *VMError) Bytes() []byte {
	mu := marshalutil.New()
	e.template.code.Serialize(mu)
	mu.WriteUint32(e.Hash())
	e.serializeParams(mu)
	return mu.Bytes()
}

func (e *VMError) AsGoError() error {
	// this is necessary because *UnresolvedVMError(nil) != error(nil)
	if e == nil {
		return nil
	}
	return e
}

func (e *VMError) AsUnresolvedError() *UnresolvedVMError {
	return &UnresolvedVMError{
		ErrorCode: e.template.code,
		Params:    e.params,
		Hash:      e.Hash(),
	}
}

func (e *VMError) AsTemplate() *VMErrorTemplate {
	return e.template
}

func UnresolvedVMErrorFromMarshalUtil(mu *marshalutil.MarshalUtil) (*UnresolvedVMError, error) {
	var err error
	unresolvedError := &UnresolvedVMError{}
	if unresolvedError.ErrorCode, err = VMErrorCodeFromMarshalUtil(mu); err != nil {
		return nil, err
	}
	if unresolvedError.Hash, err = mu.ReadUint32(); err != nil {
		return nil, err
	}
	if err := unresolvedError.deserializeParams(mu); err != nil {
		return nil, err
	}
	return unresolvedError, nil
}

func GetErrorIDFromMessageFormat(messageFormat string) uint16 {
	messageFormatHash := hashing.HashStrings(messageFormat).Bytes()
	mu := marshalutil.New(messageFormatHash)

	errorID, err := mu.ReadUint16()
	if err != nil {
		panic(err)
	}

	return errorID
}

// VMErrorIs returns true if the error includes a VMErrorCode in its chain that matches the given code
func VMErrorIs(err error, expected VMErrorBase) bool {
	var vmError VMErrorBase
	if errors.As(err, &vmError) {
		return vmError.Code() == expected.Code()
	}
	return false
}

// VMErrorMustBe panics unless the error includes a VMErrorCode in its chain that matches the given code
func VMErrorMustBe(err error, expected VMErrorBase) {
	if !VMErrorIs(err, expected) {
		panic(fmt.Sprintf("%v does not match %v", err, expected))
	}
}