Crate homestar_runtime
source ·Expand description
homestar-runtime is a determistic Wasm runtime and effectful workflow/job system intended to be embedded inside or run alongside IPFS or another content-addressable store.
You can find a more complete description here.
§Related crates/packages:
§Getting Started
For getting started with Homestar in general, please check out our README and Quickstart guide.
§Feature flags
default
: Enables the default set of features.dev
: Enables a dev-friendly, lighter set of features for development.ansi-logs
: Enables ANSI color codes in logs.console
: Enables tokio console debugging.ipfs
: Enables IPFS-related integration and settings.monitoring
: Enables node monitoring-related features and dependencies.profile
: Enables profiling-related features and dependencies.test-utils
: Enables utilities for unit testing and benchmarking.wasmtime-default
: Enables the default set of features for the embedded Wasmtime runtime.websocket-notify
: Enables websocket notifications.
§Examples
Check out our examples directory to explore some Homestar scenarios and see the system in action.
Re-exports§
pub use db::Db;
pub use runner::NodeInfo;
pub use runner::Runner;
pub use workflow::WORKFLOW_TAG;
Modules§
- Wrapper around crossbeam::channel and flume to provide common interfaces for sync/async (un)bounded and non-tokio oneshot channels.
- CLI commands/arguments.
- Daemonize the Homestar runtime.
- (Default) sqlite database integration and setup.
- General Runner interface for working across multiple workers and executing workflows.
- test_utils
test-utils
Test utilities.
Structs§
- Builder for
Database
. - DHT settings.
- Info on where and what the Key file is
- File-logger interface.
- Health status of the server and database connection.
- Builder for
Ipfs
. - libp2p settings.
- Logger interface.
- mDNS settings.
- Builder for
Metrics
. - Builder for
Monitoring
. - Builder for
Network
. - Builder for
Node
. - A parsed representation of the prometheus metrics data
- Pubsub settings.
- Seed material for RNG generated keys
- Receipt for Invocation, including it’s own Cid and a Cid for an Instruction.
- A Receipt that is sent out for websocket notifications.
- Rendezvous settings.
- Builder for
Rpc
. - Application settings.
- Builder for
Settings
. - Builder for
Webserver
.
Enums§
- Supported key types of homestar
- Network notification type.
- Configure how the Network keypair is generated or using an existing one
Constants§
- Receipt header tag, for sharing over libp2p.
- General version key for receipts.