mfm-docs 0.1.0

Umbrella docs.rs landing page for the MFM workspace
Documentation
  • Coverage
  • 100%
    1 out of 1 items documented0 out of 0 items with examples
  • Size
  • Source code size: 20.14 kB This is the summed size of all the files inside the crates.io package for this release.
  • Documentation size: 1.04 MB This is the summed size of all files generated by rustdoc for all configured targets
  • Ø build duration
  • this release: 10s Average build duration of successful builds.
  • all releases: 10s Average build duration of successful builds in releases after 2024-10-23.
  • Links
  • willyrgf/mfm
    8 5 2
  • crates.io
  • Dependencies
    • —
  • Versions
  • Owners
  • willyrgf

mfm-docs

Umbrella documentation entry point for the MFM workspace.

docs.rs publishes crates one at a time and does not provide a workspace landing page. This crate fills that gap by acting as the top-level navigation page for the published MFM surface.

Only crates that are already live on docs.rs are linked below. Remaining workspace crates stay listed by path until their publish window completes.

Use this page to jump between crate families:

  • engine and SDK
  • core primitives
  • shared states
  • ops
  • storages
  • collectors
  • transports
  • binaries and tooling

The live runtime inventory still lives in the repository docs:

  • docs/ops-and-states.md
  • docs/architecture.md
  • docs/redesign.md

Engine And SDK

Package Role docs.rs Workspace Path
mfm-machine State-machine runtime, execution plans, events, and recovery contracts. https://docs.rs/mfm-machine crates/machine
mfm-machine-derive Proc-macro helpers for machine types. https://docs.rs/mfm-machine-derive crates/machine-derive
mfm-machine-test-support Contract tests and test observability helpers. https://docs.rs/mfm-machine-test-support crates/machine-test-support
mfm-sdk Run launch, resume, and registry helpers. https://docs.rs/mfm-sdk crates/sdk

Core Primitives

Package Role docs.rs Workspace Path
mfm-evm-core EVM ABI, encoding, hex, and transaction support types. https://docs.rs/mfm-evm-core crates/evm-core
mfm_core Security-sensitive keystore, config, and primitives. pending crates/core

Shared States

Package Role docs.rs Workspace Path
mfm-evm-runtime Shared EVM read and write runtime states. pending crates/evm-runtime
mfm-state-aave-v3 Shared Aave V3 deploy and configure states. pending crates/states/aave-v3
mfm-state-common Cross-domain reusable execution states. pending crates/states/common
mfm-state-keystore Shared keystore administration and transaction states. pending crates/states/keystore

Ops

Ops stay thin and focus on graph composition and config validation. Most are still repo-local today; publish them after the shared-state crates they depend on.

Package Role Workspace Path
mfm-op-aave-v3-origin-adapt Aave origin adaptation planner. crates/ops/aave-v3-origin-adapt-op
mfm-op-evm-deploy-configure-validate EVM deploy/configure/validate planner. crates/ops/evm-deploy-configure-validate-op
mfm-op-evm-read EVM read planner. crates/ops/evm-read-op
mfm-op-evm-write EVM write planner. crates/ops/evm-write-op
mfm-op-keystore-admin Keystore admin planner. crates/ops/keystore-admin-op
mfm-op-keystore-shim Keystore compatibility shim types shared with state crates. crates/ops/keystore-op
mfm-op-keystore-tx Keystore transaction planner. crates/ops/keystore-tx-op
mfm-op-nix-app Nix app execution planner. crates/ops/nix-app-op
mfm-op-portfolio-tracker Portfolio tracking planner. crates/ops/portfolio-tracker-op
mfm-op-proof Proof-generation planner. crates/ops/proof-op

Storages

Package Role Workspace Path
mfm-artifact-store-fs Filesystem artifact store. crates/storages/artifact-store-fs
mfm-artifact-store-s3 S3-backed artifact store. crates/storages/artifact-store-s3
mfm-artifact-store-secret Secret-wrapping artifact store. crates/storages/artifact-store-secret
mfm-event-store-mem In-memory event store. crates/storages/event-store-mem
mfm-event-store-postgres PostgreSQL event store. crates/storages/event-store-postgres
mfm-indexer Projection/indexing support. crates/storages/indexer

Collectors

Package Role docs.rs Workspace Path
mfm-collectors-evm EVM collector traits and payloads. https://docs.rs/mfm-collectors-evm crates/collectors/evm
mfm-collectors-evm-jsonrpc-http HTTP JSON-RPC collector implementation for EVM. pending crates/collectors/evm-jsonrpc-http
mfm-collectors-exec Command-execution collector interfaces. pending crates/collectors/exec
mfm-collectors-nix Nix evaluation collector interfaces. pending crates/collectors/nix
mfm-collectors-nix-exec Nix execution collector implementation. pending crates/collectors/nix-exec

Transports

Package Role Workspace Path
mfm-transports-local-evm Local EVM signing and transaction transport. crates/transports/local-evm
mfm-transports-local-fs Local filesystem transport helpers. crates/transports/local-fs
mfm-transports-local-keystore Local keystore-backed transport helpers. crates/transports/local-keystore
mfm-transports-proof Proof transport helpers. crates/transports/proof

Binaries And Tooling

Package Role Workspace Path
mfm CLI package and mfm_cli binary. bin/cli
mfm-app App-level registry and observability glue. crates/app
mfm-architecture-verify Architecture contract verifier. crates/tools/architecture-verify
mfm-integration-tests Workspace integration-test crate. tests/integration
mfm-rest-api REST API package and mfm_rest_api binary. bin/rest-api

Publishing Notes

  • Publish this crate after the first published docs.rs surface is live, then add links for later crates as they land.
  • Keep this page role-oriented and high-level; detailed inventories belong in the repository docs.
  • The publish order is tracked in crates/docs/publish-wave.json and consumed by nix run .#publish-docs.