mirror of
https://github.com/logos-blockchain/lez-explorer-ui.git
synced 2026-07-30 11:23:25 +00:00
65 lines
3.0 KiB
Markdown
65 lines
3.0 KiB
Markdown
# LEZ Explorer UI
|
|
|
|
A QML block explorer for the **Logos Execution Zone** (LEZ), packaged as a `logos-module-builder` **`ui_qml`** module (universal authoring model). The QML view runs process-isolated in a `ui-host`, backed by a small C++ backend that reads from the [`lez_indexer_module`](https://github.com/logos-blockchain/lez-indexer-module) **in-process over the Logos protocol** (Qt Remote Objects) — no WebSocket, no external RPC socket.
|
|
|
|
## Features
|
|
|
|
- Browse recent blocks with a live tip poll (new heads appear automatically)
|
|
- Block details: hash, previous hash, timestamp, Bedrock status, signature, transactions
|
|
- Navigate to the previous block via a clickable hash link
|
|
- Transaction details (Public, Privacy-Preserving, Program Deployment)
|
|
- Account details with recent transaction history
|
|
- Search by block id, block hash, transaction hash, or account id
|
|
- Browser-style back/forward navigation
|
|
- "Load more" pagination for older blocks
|
|
- Styled with the shared `Logos.Theme` / `Logos.Controls` design system
|
|
|
|
## Architecture
|
|
|
|
- `src/lez_explorer_ui.rep` — the QtRO view contract (PROPs / SLOTs / SIGNALs).
|
|
- `src/lez_explorer_ui_backend.{h,cpp}` — the only hand-written C++: derives the
|
|
generated `LezExplorerUiSimpleSource` + `LogosUiPluginContext`, calls the
|
|
indexer with typed `modules().lez_indexer_module.*`, converts its compact JSON
|
|
into QVariant for the view, and polls the chain tip for live updates.
|
|
- `src/qml/` — the view (`Main.qml`, `pages/`, `components/`, `icons/`).
|
|
|
|
The `*Plugin` / `*Interface` glue is generated by the builder from the `.rep` + `metadata.json` (`interface: "universal"`).
|
|
|
|
## Building with Nix
|
|
|
|
```sh
|
|
git add -A # nix only sees git-tracked files
|
|
nix build # runs repc + compiles → result/lib/lez_explorer_ui_plugin.{so,dylib}
|
|
nix run . # preview in logos-standalone-app (spawns the ui-host)
|
|
nix build .#lgx # bundle as a .lgx for logos-basecamp
|
|
```
|
|
|
|
Running against live data needs the indexer reachable; enter its `indexer_config.json` path in the explorer's config field (leave blank if the indexer is already running). Load the explorer and indexer `.lgx` bundles together in logos-basecamp for the full experience.
|
|
|
|
## Testing
|
|
|
|
`tests/ui-tests.mjs` holds UI smoke tests (auto-detected by `mkLogosQmlModule`): they launch the view, wait for it to come up, and check the home page renders. They don't require a running indexer — with none ingesting, the backend stays in its "Connecting" empty state, which is expected.
|
|
|
|
```sh
|
|
git add -A # nix only sees tracked files
|
|
nix build .#integration-test -L # build + run the tests (logs streamed with -L)
|
|
```
|
|
|
|
> [!TIP]
|
|
>
|
|
> To iterate interactively against a local, un-pushed indexer branch, add the override used during development:
|
|
>
|
|
> ```sh
|
|
> nix build .#integration-test -L \
|
|
> --override-input lez_indexer_module path:../lez-indexer-module
|
|
> ```
|
|
|
|
## License
|
|
|
|
Licensed under either of
|
|
|
|
- Apache License, Version 2.0 ([LICENSE-APACHE-v2](LICENSE-APACHE-v2))
|
|
- MIT License ([LICENSE-MIT](LICENSE-MIT))
|
|
|
|
at your option.
|