types

type ArchetypeID int

type Component interface {
	// Name returns the name of the component.
	Name() string
}

type ComponentID int

type ComponentMetadata interface {
	// SetID sets the ArchetypeID of this component. It must only be set once
	SetID(ComponentID) error
	// ArchetypeID returns the ArchetypeID of the component.
	ID() ComponentID
	// New returns the marshaled bytes of the default value for the component struct.
	New() ([]byte, error)
	Encode(any) ([]byte, error)
	Decode([]byte) (Component, error)
	GetSchema() []byte
	ValidateAgainstSchema(targetSchema []byte) error

	Component
}

type DebugStateElement struct {
	ID         EntityID                   `json:"id"`
	Components map[string]json.RawMessage `json:"components" swaggertype:"object"`
}

type EntityID uint64

type EntityStateElement struct {
	ID   EntityID          `json:"id"`
	Data []json.RawMessage `json:"data" swaggertype:"object"`
}

type FieldDetail struct {
	Name   string         `json:"name"`   // name of the message or query
	Fields map[string]any `json:"fields"` // variable name and type
	URL    string         `json:"url,omitempty"`
}

type Message interface {
	SetID(MessageID) error
	Name() string
	// Group returns the group of the message.
	Group() string
	// FullName returns the fully qualified name of the message. It is formed by <group_name>.<message_name>.
	// example: persona.create-persona
	FullName() string
	ID() MessageID
	Encode(any) ([]byte, error)
	Decode([]byte) (any, error)
	// DecodeEVMBytes decodes ABI encoded bytes into the message's input type.
	DecodeEVMBytes([]byte) (any, error)
	// ABIEncode encodes the given type in ABI encoding, given that the input is the message type's input or output
	// type.
	ABIEncode(any) ([]byte, error)
	// IsEVMCompatible reports if this message can be sent from the EVM.
	IsEVMCompatible() bool

	// GetInFieldInformation returns a map of the fields of the message's "In" type and it's field types.
	GetInFieldInformation() map[string]any
}

type MessageID int

type TxHash string