mirror of
https://github.com/logos-blockchain/lez-programs.git
synced 2026-08-25 14:11:09 +00:00
r4bbit
f5ff9b829f
After the amm_module refactor, this crate is linked only by the module (the
UI delegates to modules().amm_module and links nothing), so its home under
apps/amm/ and the name "client" were both misnomers: it's the AMM business
logic the module wraps, reached across an FFI boundary — the same relationship
logos_execution_zone has with wallet_ffi. Co-locate it with the module that
owns it and name it for that role.
The FFI surface is unchanged — the exported functions are already amm_* (not
amm_client_*) — so only the crate, directory, generated header, dylib, and
package names move. The module's call sites are untouched; it just includes the
renamed header.
- apps/amm/client → modules/amm/ffi (git-tracked rename; history preserved)
- crate amm_client → amm_ffi: package name, include/amm_ffi.h, libamm_ffi.dylib,
AMM_FFI_H guard, build.rs output path, tests/public_api.rs import
- workspace member path + Cargo.lock
- flake.nix: pname, -p, header-copy path, dylib install_name, packages.amm_ffi,
ammModuleOutputs externalLibInputs, DYLD wrapper
- modules/amm: metadata external_libraries, CMakeLists EXTERNAL_LIBS, impl
#include + comments, README, flake note
- apps/amm/flake.nix: drop the now-dead amm_client external-lib input (the UI
links no external lib of its own)
Resulting layout:
modules/amm/
src/ # C++ module (amm_module_impl.{h,cpp})
ffi/ # Rust crate amm_ffi (Cargo.toml, src/, include/amm_ffi.h)
53 lines
2.6 KiB
Markdown
53 lines
2.6 KiB
Markdown
# AMM UI Validation
|
|
|
|
Validation for the New Position flow covers the shipped Rust client, QML
|
|
syntax, and the complete module build.
|
|
|
|
## Commands
|
|
|
|
Run from the repository root:
|
|
|
|
```bash
|
|
cargo +1.94.0 test -p amm_ffi
|
|
cargo +1.94.0 clippy -p amm_ffi --all-targets -- -D warnings
|
|
logos_qml=$(nix build github:logos-co/logos-design-system/6176f0d7a5dfeb64a7f0f98e7ca2bf71a4804772 --no-link --print-out-paths)
|
|
amm_qml=$(nix build ./apps/amm#packages.x86_64-linux.default --no-link --print-out-paths)
|
|
qt_qml=$(nix-store --query --requisites "$amm_qml" | rg -m1 -- '-qtdeclarative-[0-9]')
|
|
qt_svg=$(nix-store --query --requisites "$amm_qml" | rg -m1 -- '-qtsvg-[0-9]')
|
|
export QT_QPA_PLATFORM=offscreen QT_QUICK_BACKEND=software QT_PLUGIN_PATH="$qt_svg/lib/qt-6/plugins"
|
|
amm_import="$amm_qml/lib/qml"
|
|
test -f "$amm_import/Logos/Wallet/qmldir"
|
|
"$qt_qml/bin/qmltestrunner" -import "$qt_qml/lib/qt-6/qml" -import "$logos_qml/lib" -import "$amm_import" -input apps/shared/wallet/tests/qml
|
|
"$qt_qml/bin/qmltestrunner" -import "$qt_qml/lib/qt-6/qml" -import "$logos_qml/lib" -import "$amm_import" -input apps/amm/tests/qml
|
|
"$qt_qml/bin/qmllint" -I "$qt_qml/lib/qt-6/qml" -I "$logos_qml/lib" -I "$amm_qml/lib" -I "$amm_import" apps/amm/qml/pages/LiquidityPage.qml apps/amm/qml/components/liquidity/NewPositionForm.qml apps/amm/qml/components/liquidity/LiquidityConfirmationSummary.qml
|
|
```
|
|
|
|
When shared AMM program types or instruction signatures change, also run the
|
|
affected Rust checks:
|
|
|
|
```bash
|
|
RISC0_DEV_MODE=1 cargo +1.94.0 test -p amm_program
|
|
cargo +1.94.0 build -p idl-gen --release
|
|
./target/release/idl-gen programs/amm/methods/guest/src/bin/amm.rs > /tmp/amm-idl.json
|
|
diff artifacts/amm-idl.json /tmp/amm-idl.json
|
|
```
|
|
|
|
Live wallet/sequencer validation uses the configured Network and an External
|
|
Wallet Provider. Open the AMM UI, select two TokenProgram-scoped fungible token
|
|
definitions, preview an active or missing Pool, submit, and verify the returned
|
|
transaction ID is displayed.
|
|
|
|
## Acceptance Checklist
|
|
|
|
- Context exposes Wallet-Scoped Holdings and configured token definitions.
|
|
- Unsupported fee tiers are disabled and explain why.
|
|
- Active pool fee tier is fixed to the stored pool fee.
|
|
- Missing pool flow accepts an editable `X Token A = Y Token B` ratio and
|
|
scales either deposit from the minimum that mints more than
|
|
`MINIMUM_LIQUIDITY`.
|
|
- Active Pool flow keeps the reserve ratio and previews expected LP output.
|
|
- `new_definition` and `add_liquidity` account lists match the committed AMM IDL
|
|
order.
|
|
- Submit re-quotes and surfaces `quote_changed` when the request no longer
|
|
matches the preview hash.
|