Skip to main content

Crate mfm_docs

Crate mfm_docs 

Source
Expand description

§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

PackageRoledocs.rsWorkspace Path
mfm-machineState-machine runtime, execution plans, events, and recovery contracts.https://docs.rs/mfm-machinecrates/machine
mfm-machine-deriveProc-macro helpers for machine types.https://docs.rs/mfm-machine-derivecrates/machine-derive
mfm-machine-test-supportContract tests and test observability helpers.https://docs.rs/mfm-machine-test-supportcrates/machine-test-support
mfm-sdkRun launch, resume, and registry helpers.https://docs.rs/mfm-sdkcrates/sdk

§Core Primitives

PackageRoledocs.rsWorkspace Path
mfm-evm-coreEVM ABI, encoding, hex, and transaction support types.https://docs.rs/mfm-evm-corecrates/evm-core
mfm_coreSecurity-sensitive keystore, config, and primitives.pendingcrates/core

§Shared States

PackageRoledocs.rsWorkspace Path
mfm-evm-runtimeShared EVM read and write runtime states.pendingcrates/evm-runtime
mfm-state-aave-v3Shared Aave V3 deploy and configure states.pendingcrates/states/aave-v3
mfm-state-commonCross-domain reusable execution states.pendingcrates/states/common
mfm-state-keystoreShared keystore administration and transaction states.pendingcrates/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.

PackageRoleWorkspace Path
mfm-op-aave-v3-origin-adaptAave origin adaptation planner.crates/ops/aave-v3-origin-adapt-op
mfm-op-evm-deploy-configure-validateEVM deploy/configure/validate planner.crates/ops/evm-deploy-configure-validate-op
mfm-op-evm-readEVM read planner.crates/ops/evm-read-op
mfm-op-evm-writeEVM write planner.crates/ops/evm-write-op
mfm-op-keystore-adminKeystore admin planner.crates/ops/keystore-admin-op
mfm-op-keystore-shimKeystore compatibility shim types shared with state crates.crates/ops/keystore-op
mfm-op-keystore-txKeystore transaction planner.crates/ops/keystore-tx-op
mfm-op-nix-appNix app execution planner.crates/ops/nix-app-op
mfm-op-portfolio-trackerPortfolio tracking planner.crates/ops/portfolio-tracker-op
mfm-op-proofProof-generation planner.crates/ops/proof-op

§Storages

PackageRoleWorkspace Path
mfm-artifact-store-fsFilesystem artifact store.crates/storages/artifact-store-fs
mfm-artifact-store-s3S3-backed artifact store.crates/storages/artifact-store-s3
mfm-artifact-store-secretSecret-wrapping artifact store.crates/storages/artifact-store-secret
mfm-event-store-memIn-memory event store.crates/storages/event-store-mem
mfm-event-store-postgresPostgreSQL event store.crates/storages/event-store-postgres
mfm-indexerProjection/indexing support.crates/storages/indexer

§Collectors

PackageRoledocs.rsWorkspace Path
mfm-collectors-evmEVM collector traits and payloads.https://docs.rs/mfm-collectors-evmcrates/collectors/evm
mfm-collectors-evm-jsonrpc-httpHTTP JSON-RPC collector implementation for EVM.pendingcrates/collectors/evm-jsonrpc-http
mfm-collectors-execCommand-execution collector interfaces.pendingcrates/collectors/exec
mfm-collectors-nixNix evaluation collector interfaces.pendingcrates/collectors/nix
mfm-collectors-nix-execNix execution collector implementation.pendingcrates/collectors/nix-exec

§Transports

PackageRoleWorkspace Path
mfm-transports-local-evmLocal EVM signing and transaction transport.crates/transports/local-evm
mfm-transports-local-fsLocal filesystem transport helpers.crates/transports/local-fs
mfm-transports-local-keystoreLocal keystore-backed transport helpers.crates/transports/local-keystore
mfm-transports-proofProof transport helpers.crates/transports/proof

§Binaries And Tooling

PackageRoleWorkspace Path
mfmCLI package and mfm_cli binary.bin/cli
mfm-appApp-level registry and observability glue.crates/app
mfm-architecture-verifyArchitecture contract verifier.crates/tools/architecture-verify
mfm-integration-testsWorkspace integration-test crate.tests/integration
mfm-rest-apiREST 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.