Skip to content

Go abstraction package for implementing MOI Logic Runtimes

License

Apache-2.0, MIT licenses found

Licenses found

Apache-2.0
LICENSE-APACHE
MIT
LICENSE-MIT
Notifications You must be signed in to change notification settings

sarvalabs/go-moi-engineio

Repository files navigation

banner

go version license go docs latest tag

ci status issue count pulls count

EngineIO

go-moi-engineio is the official blueprint package for implementing Logic Execution Runtimes that are compatible with the MOI Protocol. It describes a set of interfaces that are required to for logic execution.

It generally lacks any concrete implementations except for minor map types or enums. The exception to this is the Logic Manifest handling capabilities such as ReadManifestFile and NewManifest. In order for engineio to successfully decode the manifest elements in the file, the runtime needs to registered with the package with the RegisterRuntime function.

The Engine, EngineRuntime interface along with other I/O interfaces such as CallEncoder, CallResult, ErrorResult are typically only implemented by execution runtimes such as go-pisa (Official PISA VM Implementation)

Driver interfaces such as Logic, IxnDriver, CtxDriver, EnvDriver and CryptoDriver are implemented on MOI Protocol implementation such as go-moi (Official MOI Implementation). It also implements identifier types like LogicID and IxnType.

The DependencyDriver interface is usually left to the runtime of choice to implement or import from a supporting package based on its specific rules of element relationship management. One such available implementation is the depgraph package which prevents non-circular dependencies.

Install

Install the latest release using the following command

go get -u github.com/sarvalabs/go-moi-engineio

Contributing

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as below, without any additional terms or conditions.

License

© 2023 Sarva Labs Inc. & MOI Protocol Developers.

This project is licensed under either of

at your option.

The SPDX license identifier for this project is MIT OR Apache-2.0.