docs: document the component default backend + wasmtime requirements#184
Merged
Conversation
The component engine is now the default (#183), so the wasmtime *Python package* ships as a dependency and the default backend needs no extra setup. The wasmtime *CLI* is only required for the legacy JSON-RPC backend (RUSTFAVA_RUSTLEDGER_BACKEND=jsonrpc) — including the ImportError fallback — which was previously documented as an unconditional requirement. - README: reframe the wasmtime note as the JSON-RPC opt-out requirement; PyPI install no longer lists wasmtime as a manual prerequisite. - deployment.md: add a "Backends" section covering the env var, the default, and the CLI requirement for the fallback. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Follow-up to the backend flip (#183): the docs still listed the
wasmtimeCLI as an unconditional requirement, but post-flip the default backend runs the component via thewasmtimePython package (a dependency, installed automatically) and needs no separate install.Changes
RUSTFAVA_RUSTLEDGER_BACKEND=jsonrpcbackend (and theImportErrorfallback); the default works out of the box. PyPI row no longer lists wasmtime as a manual prerequisite.component), the opt-out (jsonrpc), and that the fallback requires the wasmtime CLI.Captures the rough edge noted while reviewing the wasmtime dependency story: a fresh
pip installgets wasmtime-py (component works) but not the CLI, so thejsonrpcopt-out needs the CLI installed separately.