feat: use logos-delivery-module journey

[igor-sirotin]

Closes #145

[fryorcraken]

• returned values are not checked
• no version of delivery module is provided (so doc would break with a breaking change).

[fryorcraken]

Critical issue:

1. docs only reference to master HEAD
2. the "released" module in basecamp is not tagged in github
3. API is different between master HEAD and what was released in basecamp (LogosResult vs Bool return value)

[danisharora099]

Hi team, are there any updates on the docs? I'm considering a pre-dogfooding but since this PR is in progress, I can hold off until there is an update on docs here and perhaps do a dogfooding instead.
@igor-sirotin

[igor-sirotin]

Hi team, are there any updates on the docs? I'm considering a pre-dogfooding but since this PR is in progress, I can hold off until there is an update on docs here and perhaps do a dogfooding instead.

Hey @danisharora099! Thanks for looking into it.

I was busy with some stuff and also waiting for some fixes to land into delivery module.
Let me update the doc and dogfood it myself, should be ready in a few days then. I'll ping you

[igor-sirotin]

@danisharora099 @fryorcraken

1. I've updated the doc
2. I've implemented https://github.com/logos-co/logos-delivery-demo according to the doc. Works.

Issues to be resolved

• Running multiple instances (Support external override of all listening ports via environment variables logos-delivery-module#18) — the simplest workaround with portsShift is mentioned in this docpacket. Proper fix is still on the way.
• Payload should be QByteArray, not base64-encoded QString logos-delivery-module#27
• Inconsistent timestamp format across events: messageReceived uses ns-since-epoch, all other events use local ISO-8601 logos-delivery-module#26

I think the docpacket is good to go as is anyway, workarounds are mentioned. As soon as fixes are ready, I'll update the doc. So I'm opening the PR for review now.

[danisharora099]

I'm currently dogfooding this doc. Share updates soon

[jzaki]

Do we need to store api as suggested here, or safe to not?

[danisharora099]

Non-blocking review — used this journey end-to-end while wiring logos-delivery-module v0.1.1 into logos-co/eth-lez-atomic-swaps. Got us from zero to a working downstream module + UI pair on bin-macos-app Basecamp. Feedback below is tracked as separate issues so this PR doesn't need to carry it.

Things that worked straight off the doc:

• Step 2 config flow (getAvailableConfigs → pick default → createNode / start / stop) — no surprises.
• Step 3 events 1–3 (messageReceived, connectionStateChanged, subscribe(contentTopic)) — copy-paste into swap_delivery_adapter.cpp worked first try.
• messageSent / messagePropagated / messageError fired with the documented payload shape on every send path we exercised.

Doc-side follow-ups, consolidated into #270:

• A5 — late-subscriber drain pattern for topic-per-session content topics.
• A7 — subscribe / unsubscribe idempotency contract.
• B3 — macOS XDG_RUNTIME_DIR 104-byte sun_path budget; bites any <repo>/.basecamp/<name>/run layout under /Users/<user>/Developer/….
• B4 — --user-dir for multi-instance testing; prefer over LOGOS_DATA_DIR because the latter appends Dev in non-portable builds.
• C1 — named-module qmldir over relative import "."; the relative form silently produces undefined singleton bindings in bin-macos-app.
• C2 — src = ./. in flake.nix only sees git-tracked files; newly created qmldir / generated resources have to be git add-ed or they silently omit from the LGX.
• C3 — rebuild → reinstall LGX into every --user-dir → restart Basecamp; source rebuild alone isn't enough.

API-side, separate from this PR:

• logos-co/logos-delivery-module#36 — first-class peer count / structured getStatus(). Today we parse the Prometheus text from getNodeInfo("Metrics").
• logos-co/logos-delivery-module#34 — getSubscriptions() or subscribeIfNot(). Today consumers mirror subscription state in-process.
• logos-co/logos-delivery-module#35 — document the subscribe / unsubscribe idempotency contract. Small Doxygen note; also covered doc-side in #270.
• logos-co/logos-delivery-module#37 — publish binary-cache substitutes for zerokit-*, liblogosdelivery-dev, logos-delivery_module-module-lib* on Logos Cachix. Currently 404 for aarch64-darwin + x86_64-linux + x86_64-darwin, so new contributors take the cold-build hit.

Packaging / host side, separate repos:

• logos-co/logos-basecamp#190 — module-proxy logs every Q_INVOKABLE arg verbatim at INFO; needs opt-in redaction.
• logos-co/logos-package-manager#12 + logos-co/logos-basecamp#191 — LGPM_PORTABLE_BUILD variant mismatch. lgpm install rejects the <host> variant bin-macos-app actually loads, and bin-macos-app silently drops the <host>-dev variant lgpm install actually writes. No log line on the silent drop.

Fine to merge as-is.