Add Ogmios submit mode to tx-generator#6609
Open
palas wants to merge 11 commits into
Open
Conversation
Strenghten and polish rough edges of implementation: * `runScript` now returns `Maybe AsyncBenchmarkControl` instead of fabricating a no-op control: submit modes that never start the benchmark machinery (LocalSocket, Ogmios) yield Nothing, and a failing run no longer dies with the misleading "AsyncBenchmarkControl uninitialized" error that masked the real one. noopBenchmarkControl is gone; both call sites in Command.hs only ever consumed fst, so they are unaffected. * WebSocket failures (DNS, refused connection, handshake rejection, mid-stream drops, close frames) are caught around WS.runClient and converted into TxGenError instead of escaping as raw exceptions past the error machinery and logging shutdown. * `parseOgmiosUrl` validates the scheme (plain `ws://` only; `wss://` was silently degrading to a plaintext connection), parses the port via readMaybe with a 1-65535 range check instead of a partial read (`ws://host:/` no longer crashes), and rejects empty hosts. * Submission responses are subject to a 90s timeout (generous, since the node may hold submissions back under mempool pressure) and their JSON-RPC id is verified against the request id; a mismatched or null id is treated as a protocol fault and aborts the run with the offending response described. * json_highlevel configs that set ogmiosUrl without debugMode: true are rejected at compile time with an explanatory error: Ogmios mode ignores tps/targetNodes and produces no benchmark metrics, so a config asking for a real benchmark must fail fast rather than run unpaced and unmeasured. Low-level json scripts are unaffected, and compileOptions fails before any node interaction. * Polish: parseOgmiosUrl/parseOgmiosResponse/OgmiosResult exported to make them unit-testable, `fromMaybe Null` instead of `maybe Null id`, unused `RankNTypes` pragma dropped, haddock module header added, import list put in stylish-haskell order.
* Document the limitation on the implementation of the support
of Ogmios as a target that limits the throughput to one request
in flight per round trip (Ogmios supports pipelining by JSON-RPC id,
but we are not supporting it for now.
* Document that only submission goes through Ogmios:
protocol-parameter and era queries as well as protocol startup still
require the local node socket and config file.
* Route per-transaction rejections through the benchmark tracer instead
of putStrLn, so they reach the trace stream like every other
submission event instead of interleaving arbitrarily with it. The
failure detail payload reported by Ogmios ('error.data'), which
carries the actual ledger failure and was previously discarded, is
included in the message along with the error code.
* Add `ogmiosUrl` to the README's connection-settings table plus a
'Submitting through Ogmios' section, add a changelog entry for the
feature (including the clean-exit behavior change for scripts that
never start the benchmark machinery), and bump the package version
to 2.17.
* Capture the tx-generator exit code with an if/else instead of a bare $? after the subshell: under 'set -e' a failure used to abort the script on the spot, so the log tails and the exit-code report - the part that matters exactly when the run fails - were dead code. (Note the 'if ! (...); then TX_EXIT=$?' form would not work either: the negation resets $? to 0.) * Actually fail on functional failure: if no new UTxOs appear at the benchmark address the script now exits 1 instead of falling through and reporting success. The confirmation window is doubled to 120s - in practice inclusion took ~50s, which the previous 60s window only just covered. * Derive the benchmark address from the hardcoded "BenchmarkingDone" signing key (cf. keyBenchmarkDone in Compiler.hs) at run time instead of hardcoding the bech32 - if the key or the derivation ever changes, the test follows instead of silently counting a stale address. * Default the ogmios flake ref to the repository's master branch instead of a personal work-in-progress branch that will rot away; a different ref can still be passed as the first argument. * Use 'find -perm -u+x' in the cabal fallback - the previous '+111' is BSD-only syntax that GNU find rejects; '-u+x' works in both. * Document that debugMode is mandatory alongside ogmiosUrl, silence the SC2329 false positive for the trap-only cleanup function on the CI-pinned shellcheck, and check for required host commands (nix, jq, nc) up front.
A rejected transaction used to be counted and traced but otherwise ignored: the run carried on and exited 0 even if every submission was rejected, so a script could mistake a completely failed run for a successful one. Now a rejection makes the run fail, with the strategy depending on the shape of the stream being submitted. Streams of chained setup transactions (genesis import, splitting) abort at the first rejection - everything after it spends outputs that will never exist, so carrying on would only produce a cascade of confusing follow-up rejections. The benchmarking phase's NtoM stream consists of mutually independent transactions, so it is submitted to the end and the action fails afterwards when the tally shows rejections. Either way the process exits non-zero, making exit codes trustworthy in scripts. The strategy is picked in submitInEra from the generator: NtoM (looked up through Take/Cycle/Sequence wrappers) submits to the end, everything else aborts at the first rejection.
Three issues kept the script from resolving and launching ogmios:
1. Submodules. Resolving ogmios as `github:IntersectMBO/ogmios/<ref>`
downloads a GitHub tarball, which omits the hjsonpointer, hjsonschema
and wai-routes git submodules that ogmios' cabal.project depends on.
haskell.nix then fails plan-to-nix with "modules/hjsonpointer does
not contain any .cabal file". This is platform-independent (it fails
on x86_64 too). Use the `git+https://…?submodules=1` fetcher, which
actually pulls the submodules. Note that `github:…?submodules=1` is
silently ignored and the flake's own `self.submodules = true` does
not rescue the tarball path either.
2. Default ref. The cardano-node tools are derived from a cardano-node
input of the ogmios flake, which only the testnet-tx-gen-tests branch
declares; ogmios master has no such input, so the old default
produced 'github:null/null/null' and a 404. Default to the branch
that actually provides it. Also guard the lookup so a missing input
fails with a clear message instead of a cryptic fetch error.
3. Binary path. The ogmios line captured the nix output *directory* and
ran it directly ("Is a directory"); the cardano-* lines already
append /bin/<name>. Append /bin/ogmios to match.
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.
Description
Adds an Ogmios submit mode to
tx-generator: point it at an Ogmios WebSocket endpoint and every transaction is submitted there as JSON-RPC 2.0submitTransactioncalls, instead of via the local socket / Node-to-Node protocols.It is a functional submission transport, not a benchmarking one — useful for exercising a node through Ogmios end-to-end, not for measuring throughput.
What it adds
ogmiosUrlconfig key (e.g.ws://127.0.0.1:1337) in the high-level JSON config. When set, every phase — genesis import, UTxO splitting, and the benchmark phase — submits through Ogmios.websockets+network-urideps).test-ogmios.sh: an integration test that spins upcardano-testnet+ Ogmios and submits through it.debugMode: true, or low-level scripts with noBenchmarkphase) used to crash at shutdown with "AsyncBenchmarkControl absent". They now exit cleanly —runScriptreturnsMaybe AsyncBenchmarkControlinstead of fabricating a no-op control.Implementation nuances
debugMode: true. Ogmios mode ignorestps/targetNodesand produces no benchmark metrics, so the compiler rejectsogmiosUrlwithoutdebugMode: trueat compile time (fail fast, before any node interaction). Low-leveljsonscripts are unaffected.id) is deliberately not used yet; it is noted in the module docs as a potential next step.Testing
test-ogmios.shis a self-contained integration test (nix-resolved Ogmios +cardano-testnet). It is not wired into CI (it needs nix). The URL and response parsers (parseOgmiosUrl,parseOgmiosResponse) are exported to keep them unit-testable.Checklist
See Running tests for more details
CHANGELOG.mdfor affected package.cabalfiles are updatedhlint. See.github/workflows/check-hlint.ymlto get thehlintversionstylish-haskell. See.github/workflows/stylish-haskell.ymlto get thestylish-haskellversionghc-9.6andghc-9.12