cardinal

Nov 12, 2024

Changes in this version

type WorldOption

+ func WithHashCacheSize(sizeKB uint) WorldOption

Oct 23, 2024

Changes in this version

type WorldOption

+ func WithMessageExpiration(seconds int) WorldOption

Aug 20, 2024

Changes in this version

+ func RegisterTask[T Task](w *World) error

+ type Task interface

+ Handle func(WorldContext) error

+ type TaskPlugin struct

+ func (*TaskPlugin) Register(w *World) error

type WorldContext

+ ScheduleTickTask func(uint64, Task) error

+ ScheduleTimeTask func(time.Duration, Task) error

Jul 26, 2024

Changes in this version

type QueryManager

+ HandleQuery func(group string, name string, bz []byte) ([]byte, error)

+ HandleQueryEVM func(group string, name string, abiRequest []byte) ([]byte, error)

type WorldContext

+ Rand func() *rand.Rand

type WorldOption

+ func WithMockJobQueue() WorldOption

Jun 4, 2024

Changes in this version

+ type TestFixture struct

+ BaseURL string

+ DoneTickCh chan uint64

+ Redis *miniredis.Miniredis

+ StartTickCh chan time.Time

+ World *World

+ func NewTestFixture(t testing.TB, redis *miniredis.Miniredis, opts ...WorldOption) *TestFixture

+ func (t *TestFixture) AddTransaction(txID types.MessageID, tx any, sigs ...*sign.Transaction) types.TxHash

+ func (t *TestFixture) CreatePersona(personaTag, signerAddr string)

+ func (t *TestFixture) DoTick()

+ func (t *TestFixture) Get(path string) *http.Response

+ func (t *TestFixture) Post(path string, payload any) *http.Response

+ func (t *TestFixture) StartWorld()

type WorldConfig

+ TelemetryProfilerEnabled bool

+ TelemetryTraceEnabled bool

May 22, 2024

Changes in this version

+ const PersonaStatusAssigned

+ const PersonaStatusAvailable

+ const PersonaStatusUnknown

+ var DefaultQueryGroup = "game"

+ var ErrEVMTypeNotSet = errors.New("EVM type is not set")

+ func GetTransactionReceiptsForTick(wCtx WorldContext, tick uint64) ([]receipt.Receipt, error)

+ func InternalHandleQuery(wCtx WorldContext, query query, a any) (any, error)

+ type AndSearch struct

+ func (andSearch *AndSearch) Collect(wCtx WorldContext) ([]types.EntityID, error)

+ func (andSearch *AndSearch) Count(wCtx WorldContext) (int, error)

+ func (andSearch *AndSearch) Each(wCtx WorldContext, callback CallbackFn) error

+ func (andSearch *AndSearch) First(wCtx WorldContext) (types.EntityID, error)

+ func (andSearch *AndSearch) MustFirst(wCtx WorldContext) types.EntityID

+ type CallbackFn func(types.EntityID) bool

+ type EntitySearch interface

+ Where func(componentFilter FilterFn) EntitySearch

+ type FilterFn func(wCtx WorldContext, id types.EntityID) (bool, error)

+ func AndFilter(fns ...FilterFn) FilterFn

+ func ComponentFilter[T types.Component](f func(comp T) bool) FilterFn

+ func OrFilter(fns ...FilterFn) FilterFn

+ type MessageManager interface

+ GetMessageByFullName func(fullName string) (types.Message, bool)

+ GetMessageByID func(id types.MessageID) types.Message

+ GetMessageByType func(mType reflect.Type) (types.Message, bool)

+ GetRegisteredMessages func() []types.Message

+ RegisterMessage func(msgType types.Message, msgReflectType reflect.Type) error

+ type MessageOption func(mt *MessageType[In, Out])

+ func WithCustomMessageGroup[In, Out any](group string) MessageOption[In, Out]

+ func WithMsgEVMSupport[In, Out any]() MessageOption[In, Out]

+ type MessageType struct

+ func NewMessageType[In, Out any](name string, opts ...MessageOption[In, Out]) *MessageType[In, Out]

+ func (t *MessageType[In, Out]) ABIEncode(v any) ([]byte, error)

+ func (t *MessageType[In, Out]) AddError(wCtx WorldContext, hash types.TxHash, err error)

+ func (t *MessageType[In, Out]) Decode(bytes []byte) (any, error)

+ func (t *MessageType[In, Out]) DecodeEVMBytes(bz []byte) (any, error)

+ func (t *MessageType[In, Out]) Each(wCtx WorldContext, fn func(TxData[In]) (Out, error))

+ func (t *MessageType[In, Out]) Encode(a any) ([]byte, error)

+ func (t *MessageType[In, Out]) FullName() string

+ func (t *MessageType[In, Out]) GetInFieldInformation() map[string]any

+ func (t *MessageType[In, Out]) GetReceipt(wCtx WorldContext, hash types.TxHash) (v Out, errs []error, ok bool)

+ func (t *MessageType[In, Out]) Group() string

+ func (t *MessageType[In, Out]) ID() types.MessageID

+ func (t *MessageType[In, Out]) In(wCtx WorldContext) []TxData[In]

+ func (t *MessageType[In, Out]) IsEVMCompatible() bool

+ func (t *MessageType[In, Out]) Name() string

+ func (t *MessageType[In, Out]) SetID(id types.MessageID) error

+ func (t *MessageType[In, Out]) SetResult(wCtx WorldContext, hash types.TxHash, result Out)

+ type NotSearch struct

+ func (notSearch *NotSearch) Collect(wCtx WorldContext) ([]types.EntityID, error)

+ func (notSearch *NotSearch) Count(wCtx WorldContext) (int, error)

+ func (notSearch *NotSearch) Each(wCtx WorldContext, callback CallbackFn) error

+ func (notSearch *NotSearch) First(wCtx WorldContext) (types.EntityID, error)

+ func (notSearch *NotSearch) MustFirst(wCtx WorldContext) types.EntityID

+ type OrSearch struct

+ func (orSearch *OrSearch) Collect(wCtx WorldContext) ([]types.EntityID, error)

+ func (orSearch *OrSearch) Count(wCtx WorldContext) (int, error)

+ func (orSearch *OrSearch) Each(wCtx WorldContext, callback CallbackFn) error

+ func (orSearch *OrSearch) First(wCtx WorldContext) (types.EntityID, error)

+ func (orSearch *OrSearch) MustFirst(wCtx WorldContext) types.EntityID

+ type PersonaSignerQueryRequest struct

+ PersonaTag string

+ Tick uint64

+ type PersonaSignerQueryResponse struct

+ SignerAddress string

+ Status string

+ func PersonaSignerQuery(wCtx WorldContext, req *PersonaSignerQueryRequest) (*PersonaSignerQueryResponse, error)

+ type QueryManager interface

+ BuildQueryFields func() []types.FieldDetail

+ GetQuery func(group string, name string) (query, error)

+ GetRegisteredQueries func() []query

+ RegisterQuery func(queryInput query) error

+ type QueryOption func(qt *queryType[Request, Reply])

+ func WithCustomQueryGroup[Request, Reply any](group string) QueryOption[Request, Reply]

+ func WithQueryEVMSupport[Request, Reply any]() QueryOption[Request, Reply]

type Search

+ func (s *Search) Collect(wCtx WorldContext) ([]types.EntityID, error)

+ func (s *Search) Count(wCtx WorldContext) (ret int, err error)

+ func (s *Search) Each(wCtx WorldContext, callback CallbackFn) (err error)

+ func (s *Search) Entity(componentFilter filter.ComponentFilter) EntitySearch

+ func (s *Search) First(wCtx WorldContext) (id types.EntityID, err error)

+ func (s *Search) MustFirst(wCtx WorldContext) types.EntityID

+ func (s *Search) Where(componentFilter FilterFn) EntitySearch

+ type Searchable interface

+ Collect func(wCtx WorldContext) ([]types.EntityID, error)

+ Count func(wCtx WorldContext) (int, error)

+ Each func(wCtx WorldContext, callback CallbackFn) error

+ First func(wCtx WorldContext) (types.EntityID, error)

+ MustFirst func(wCtx WorldContext) types.EntityID

+ func And(searches ...Searchable) Searchable

+ func Not(search Searchable) Searchable

+ func Or(searches ...Searchable) Searchable

+ type SystemManager interface

+ GetCurrentSystem func() string

+ GetRegisteredSystems func() []string

+ type TxData struct

+ Hash types.TxHash

+ Msg In

+ Tx *sign.Transaction

type World

+ func (w *World) EvaluateCQL(cqlString string) ([]types.EntityStateElement, error)

+ func (w *World) GetDebugState() ([]types.EntityStateElement, error)

+ func (w *World) HandleQuery(group string, name string, bz []byte) ([]byte, error)

+ func (w *World) ReceiptHistorySize() uint64

type WorldContext

+ CurrentTick func() uint64

+ EmitEvent func(map[string]any) error

+ EmitStringEvent func(string) error

+ Logger func() *zerolog.Logger

+ Namespace func() string

+ Timestamp func() uint64

Apr 23, 2024

Changes in this version

+ const DefaultBaseShardSequencerAddress

+ const DefaultCardinalLogLevel

+ const DefaultCardinalNamespace

type WorldConfig

+ BaseShardRouterKey string

+ CardinalLogPretty bool

+ CardinalRollupEnabled bool

+ TelemetryEnabled bool

+ TelemetryStatsdAddress string

+ TelemetryTraceAddress string

Apr 16, 2024

Changes in this version

+ var NewLegacySearch = search.NewLegacySearch

+ func FilterFunction[T types.Component](f func(comp T) bool) func(ctx engine.Context, id types.EntityID) (bool, error)

+ type Search = search.Search

type World

+ func (w *World) GetReadOnlyCtx() engine.Context

Apr 16, 2024

Changes in this version

+ const DefaultHistoricalTicksToStore

+ const DefaultLogLevel

+ const DefaultNamespace

+ const DefaultRedisAddress

+ const DefaultRunMode

+ const DefaultStatsdAddress

+ const RedisDialTimeOut

+ const RunModeDev

+ const RunModeProd

+ var ErrComponentAlreadyOnEntity = iterators.ErrComponentAlreadyOnEntity

+ var ErrComponentNotOnEntity = iterators.ErrComponentNotOnEntity

+ var ErrEntitiesCreatedBeforeReady = errors.New("entities should not be created before world is ready")

+ var ErrEntityDoesNotExist = iterators.ErrEntityDoesNotExist

+ var ErrEntityMustHaveAtLeastOneComponent = iterators.ErrEntityMustHaveAtLeastOneComponent

+ var ErrEntityMutationOnReadOnly = errors.New("cannot modify state with read only context")

+ var NewSearch = search.NewSearch

+ var NonFatalError = []error

+ func AddComponentTo[T types.Component](wCtx engine.Context, id types.EntityID) (err error)

+ func AuthorizePersonaAddressSystem(wCtx engine.Context) error

+ func Create(wCtx engine.Context, components ...types.Component) (_ types.EntityID, err error)

+ func CreateMany(wCtx engine.Context, num int, components ...types.Component) (entityIDs []types.EntityID, err error)

+ func CreatePersonaSystem(wCtx engine.Context) error

+ func EachMessage[In any, Out any](wCtx engine.Context, fn func(message.TxData[In]) (Out, error)) error

+ func GetComponent[T types.Component](wCtx engine.Context, id types.EntityID) (comp *T, err error)

+ func MustRegisterComponent[T types.Component](w *World)

+ func NewReadOnlyWorldContext(world *World) engine.Context

+ func NewWorldContext(world *World) engine.Context

+ func RegisterComponent[T types.Component](w *World) error

+ func RegisterInitSystems(w *World, sys ...system.System) error

+ func RegisterMessage[In any, Out any](world *World, name string, opts ...message.MessageOption[In, Out]) error

+ func RegisterQuery[Request any, Reply any](w *World, name string, ...) (err error)

+ func RegisterSystems(w *World, sys ...system.System) error

+ func Remove(wCtx engine.Context, id types.EntityID) (err error)

+ func RemoveComponentFrom[T types.Component](wCtx engine.Context, id types.EntityID) (err error)

+ func SetComponent[T types.Component](wCtx engine.Context, id types.EntityID, component *T) (err error)

+ func UpdateComponent[T types.Component](wCtx engine.Context, id types.EntityID, fn func(*T) *T) (err error)

+ type EVMTxReceipt struct

+ ABIResult []byte

+ EVMTxHash string

+ Errs []error

+ type Namespace string

+ func (n Namespace) String() string

+ func (n Namespace) Validate(mode RunMode) error

+ type Option func(*World)

+ type Plugin interface

+ Register func(world *World) error

+ type RunMode string

+ type System = system.System

+ type TickResults struct

+ Events [][]byte

+ Receipts []receipt.Receipt

+ Tick uint64

+ func NewTickResults(initialTick uint64) *TickResults

+ func (tr *TickResults) AddEvent(event any) error

+ func (tr *TickResults) AddStringEvent(e string) error

+ func (tr *TickResults) Clear()

+ func (tr *TickResults) SetReceipts(newReceipts []receipt.Receipt)

+ func (tr *TickResults) SetTick(tick uint64)

+ type World struct

+ func NewWorld(opts ...WorldOption) (*World, error)

+ func (w *World) AddEVMTransaction(id types.MessageID, v any, sig *sign.Transaction, evmTxHash string) (tick uint64, txHash types.TxHash)

+ func (w *World) AddTransaction(id types.MessageID, v any, sig *sign.Transaction) (tick uint64, txHash types.TxHash)

+ func (w *World) ConsumeEVMMsgResult(evmTxHash string) ([]byte, []error, string, bool)

+ func (w *World) CurrentTick() uint64

+ func (w *World) GameStateManager() gamestate.Manager

+ func (w *World) GetComponentByName(name string) (types.ComponentMetadata, error)

+ func (w *World) GetEVMMsgReceipt(evmTxHash string) (EVMTxReceipt, bool)

+ func (w *World) GetMessageByFullName(name string) (types.Message, bool)

+ func (w *World) GetMessageByID(id types.MessageID) (types.Message, bool)

+ func (w *World) GetQueryByName(name string) (engine.Query, error)

+ func (w *World) GetRegisteredComponents() []types.ComponentMetadata

+ func (w *World) GetRegisteredMessages() []types.Message

+ func (w *World) GetRegisteredQueries() []engine.Query

+ func (w *World) GetRegisteredSystemNames() []string

+ func (w *World) GetSignerComponentForPersona(personaTag string) (*component.SignerComponent, error)

+ func (w *World) GetSignerForPersonaTag(personaTag string, tick uint64) (addr string, err error)

+ func (w *World) GetTransactionReceiptsForTick(tick uint64) ([]receipt.Receipt, error)

+ func (w *World) HandleEVMQuery(name string, abiRequest []byte) ([]byte, error)

+ func (w *World) IsGameRunning() bool

+ func (w *World) Namespace() string

+ func (w *World) RecoverFromChain(ctx context.Context) error

+ func (w *World) RegisterPlugin(plugin Plugin)

+ func (w *World) Search(filter filter.ComponentFilter) *search.Search

+ func (w *World) Shutdown() error

+ func (w *World) StartGame() error

+ func (w *World) StoreReader() gamestate.Reader

+ func (w *World) UseNonce(signerAddress string, nonce uint64) error

+ func (w *World) WaitForNextTick() (success bool)

+ type WorldConfig struct

+ BaseShardSequencerAddress string

+ CardinalLogLevel string

+ CardinalMode RunMode

+ CardinalNamespace string

+ RedisAddress string

+ RedisPassword string

+ RouterKey string

+ StatsdAddress string

+ TraceAddress string

+ func (w *WorldConfig) Validate() error

+ type WorldContext = engine.Context

+ type WorldOption struct

+ func WithCustomLogger(logger zerolog.Logger) WorldOption

+ func WithCustomRouter(rtr router.Router) WorldOption

+ func WithDisableSignatureVerification() WorldOption

+ func WithMockRedis() WorldOption

+ func WithPort(port string) WorldOption

+ func WithPrettyLog() WorldOption

+ func WithReceiptHistorySize(size int) WorldOption

+ func WithStoreManager(s gamestate.Manager) WorldOption

+ func WithTickChannel(ch <-chan time.Time) WorldOption

+ func WithTickDoneChannel(ch chan<- uint64) WorldOption