mirror of
https://github.com/logos-blockchain/lez-programs.git
synced 2026-08-25 14:11:09 +00:00
r4bbit
dac442435a
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)
219 lines
10 KiB
Nix
219 lines
10 KiB
Nix
{
|
|
description = "LEZ programs — AMM client FFI";
|
|
|
|
inputs = {
|
|
nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
|
|
flake-utils.url = "github:numtide/flake-utils";
|
|
crane.url = "github:ipetkov/crane";
|
|
rust-overlay = {
|
|
url = "github:oxalica/rust-overlay";
|
|
inputs.nixpkgs.follows = "nixpkgs";
|
|
};
|
|
|
|
# The AMM QML UI module (apps/amm) is built from this same flake so it can
|
|
# reference the amm_ffi crate package via `self` — no filesystem
|
|
# path or git-remote reference to this repo is needed (see apps/amm/flake.nix
|
|
# history: a `git+file://` URL pointing at a local checkout is
|
|
# machine-specific and not portable).
|
|
logos-module-builder.url = "github:logos-co/logos-module-builder";
|
|
|
|
# Core wallet module (the LEZ wallet FFI Qt plugin). The input name must
|
|
# match the metadata.json `dependencies` entry so the builder can resolve it
|
|
# as a module dependency.
|
|
#
|
|
# Fork of logos-blockchain/logos-execution-zone-module @ d70225ced with the
|
|
# QtRO serialization fix: send_generic_public_transaction's `instruction` uses
|
|
# a byte-string IPC type so the args survive the cross-process boundary (at
|
|
# d70225ced the API already takes program_id_hex instead of program_elf/deps).
|
|
# See docs/amm-swap-qtro-serialization-bug.md.
|
|
logos_execution_zone = {
|
|
url = "github:gravityblast/logos-execution-zone-module?ref=fix/generic-tx-instruction-bstr";
|
|
|
|
# Override the module's pinned LEZ monorepo (logos-execution-zone) to the
|
|
# SAME rev the target sequencer runs (415964d7): the wallet client and the
|
|
# sequencer must agree on the JSON-RPC API, or tx submission fails at
|
|
# runtime with `MethodNotFound`. 415964d7's wallet_ffi takes a program id
|
|
# for send_generic_public_transaction, matching the d70225ced module.
|
|
inputs.logos-execution-zone.url =
|
|
"github:logos-blockchain/logos-execution-zone?rev=415964d7f9043a1bfe28da8d0e8b3a6f64abb258";
|
|
};
|
|
};
|
|
|
|
outputs =
|
|
inputs@{ self, nixpkgs, flake-utils, crane, rust-overlay, logos-module-builder, logos_execution_zone, ... }:
|
|
let
|
|
crateOutputs = flake-utils.lib.eachDefaultSystem (
|
|
system:
|
|
let
|
|
pkgs = import nixpkgs {
|
|
inherit system;
|
|
overlays = [ rust-overlay.overlays.default ];
|
|
};
|
|
# Honor the repo's pinned toolchain (rust-toolchain.toml -> 1.94.0).
|
|
rustToolchain = pkgs.rust-bin.fromRustupToolchainFile ./rust-toolchain.toml;
|
|
craneLib = (crane.mkLib pkgs).overrideToolchain rustToolchain;
|
|
|
|
# Whole workspace: crane needs Cargo.lock + all path deps (amm_core,
|
|
# twap_oracle_core, token_core, ...) to resolve `-p amm_ffi`.
|
|
src = ./.;
|
|
|
|
commonArgs = {
|
|
inherit src;
|
|
strictDeps = true;
|
|
pname = "amm_ffi";
|
|
version = "0.1.0";
|
|
# CRITICAL: scope to ONLY this crate. The workspace also contains
|
|
# `amm/methods` etc. whose build.rs compiles the risc0 guest (which
|
|
# WOULD invoke Metal on darwin). `-p amm_ffi` never builds
|
|
# those crates or their build scripts.
|
|
cargoExtraArgs = "-p amm_ffi";
|
|
doCheck = false;
|
|
# NOTE: cbindgen is used here as a Cargo *build-dependency*
|
|
# (invoked from build.rs via its Rust library API), not as the
|
|
# standalone CLI package — so no nativeBuildInputs entry is
|
|
# needed; crane builds it as part of the normal cargo graph.
|
|
};
|
|
|
|
cargoArtifacts = craneLib.buildDepsOnly commonArgs;
|
|
|
|
# The single AMM host FFI crate (modules/amm/ffi): swap + new-position
|
|
# operations behind one JSON C ABI. Its header is cbindgen-generated
|
|
# into include/amm_ffi.h at build time.
|
|
ammFfi = craneLib.buildPackage (
|
|
commonArgs
|
|
// {
|
|
inherit cargoArtifacts;
|
|
postInstall =
|
|
''
|
|
mkdir -p $out/include
|
|
cp modules/amm/ffi/include/amm_ffi.h $out/include/
|
|
''
|
|
+ pkgs.lib.optionalString pkgs.stdenv.isDarwin ''
|
|
# Set the dylib's install-name to its ABSOLUTE store path (NOT
|
|
# @rpath): the logos module builder links this lib into the plugin
|
|
# but never stages it into the plugin's runtime rpath, so an
|
|
# @rpath id fails to dlopen at launch. An absolute /nix/store id
|
|
# is recorded in the plugin's LC_LOAD_DYLIB, kept in the closure
|
|
# by Nix, and resolved directly at runtime — no rpath needed.
|
|
if [ -f $out/lib/libamm_ffi.dylib ]; then
|
|
install_name_tool -id "$out/lib/libamm_ffi.dylib" $out/lib/libamm_ffi.dylib
|
|
fi
|
|
'';
|
|
}
|
|
);
|
|
in
|
|
{
|
|
packages.default = ammFfi;
|
|
packages.amm_ffi = ammFfi;
|
|
}
|
|
);
|
|
|
|
# The AMM QML UI module (apps/amm). It links no amm_ffi library of its
|
|
# own — the AMM logic lives in the amm_module core module, which the UI
|
|
# depends on (declared in apps/amm/metadata.json, reached via
|
|
# modules().amm_module in the backend) alongside the logos_execution_zone
|
|
# wallet module.
|
|
appOutputs = logos-module-builder.lib.mkLogosQmlModule {
|
|
src = ./apps/amm;
|
|
configFile = ./apps/amm/metadata.json;
|
|
# amm_module isn't a flake input — it's built from this same flake below
|
|
# (ammModuleOutputs) — so inject it into flakeInputs under its dependency
|
|
# name so the builder's dependency resolver finds it (reads its .lidl to
|
|
# generate the modules().amm_module wrapper). The wallet module stays a
|
|
# direct dep too, so both the UI and amm_module resolve the one shared
|
|
# wallet instance.
|
|
flakeInputs = inputs // { amm_module = ammModuleOutputs; };
|
|
# The UI links no external lib of its own — the AMM brain (amm_ffi) is
|
|
# linked by amm_module, which the UI reaches via modules().amm_module.
|
|
externalLibInputs = { };
|
|
# The AMM UI links the shared C++ wallet access lib and bundles the
|
|
# Logos.Wallet QML module (apps/shared/wallet). apps/amm/flake.nix wires
|
|
# these via its `shared_wallet` input; when built from this root flake
|
|
# the source lives in-tree, so point CMake straight at it and stage the
|
|
# built QML module the same way. Keep in sync with apps/amm/flake.nix.
|
|
preConfigure = ''
|
|
cmakeFlagsArray+=("-DLOGOS_WALLET_SOURCE_DIR=${./apps/shared/wallet}")
|
|
'';
|
|
postInstall = ''
|
|
test -f ${./apps/amm/qml}/Logos/Wallet/qmldir
|
|
|
|
walletQmlDir="shared-wallet/qml/Logos/Wallet"
|
|
if [ ! -d "$walletQmlDir" ]; then
|
|
echo "Built Logos.Wallet QML module not found"
|
|
exit 1
|
|
fi
|
|
walletQmlInstallDir="$out/lib/Logos/Wallet"
|
|
mkdir -p "$walletQmlInstallDir"
|
|
cp -r "$walletQmlDir/." "$walletQmlInstallDir/"
|
|
test -f "$walletQmlInstallDir/qmldir"
|
|
'';
|
|
};
|
|
|
|
# Expose the AMM QML UI as a NAMED app/package (`amm-ui`) rather than
|
|
# `<sys>.default` — the repo is expected to grow more UIs over time,
|
|
# each runnable via `nix run .#<name>`. `appOutputs.apps.<sys>.default`
|
|
# and `appOutputs.packages.<sys>.default` (the UI launcher and its
|
|
# bundle, respectively) are renamed to `amm-ui`; no `default` survives
|
|
# for either attribute set.
|
|
appApps = appOutputs.apps or { };
|
|
appPkgs = appOutputs.packages or { };
|
|
|
|
# AMM core module (modules/amm): the AMM business logic as a headless
|
|
# `core` Logos module. It links the amm_ffi crate (the transport-
|
|
# independent AMM brain, resolved via `self`) and depends on the
|
|
# logos_execution_zone wallet module (declared in modules/amm/metadata.json,
|
|
# reached via modules().logos_execution_zone in the impl). Exposed as the
|
|
# `amm-module` package; no UI/app output.
|
|
ammModuleOutputs = logos-module-builder.lib.mkLogosModule {
|
|
src = ./modules/amm;
|
|
configFile = ./modules/amm/metadata.json;
|
|
flakeInputs = inputs;
|
|
externalLibInputs = {
|
|
amm_ffi = { input = self; packages.default = "amm_ffi"; };
|
|
};
|
|
};
|
|
ammModulePkgs = ammModuleOutputs.packages or { };
|
|
|
|
# Wrap the app launcher to export DYLD_FALLBACK_LIBRARY_PATH pointing at the
|
|
# amm_ffi lib. The logos module builder links the plugin against
|
|
# @rpath/libamm_ffi.dylib but does NOT stage that dylib into the
|
|
# plugin-dir it loads at runtime, so dlopen fails with "Failed to load UI
|
|
# plugin". Adding the crate's store lib dir to DYLD's fallback search path
|
|
# lets the loader find it (the store path stays in the closure).
|
|
wrapWithDyld = system: app:
|
|
let
|
|
pkgs = import nixpkgs { inherit system; overlays = [ rust-overlay.overlays.default ]; };
|
|
ammFfi = crateOutputs.packages.${system}.amm_ffi;
|
|
in
|
|
app // {
|
|
program = "${pkgs.writeShellScript "run-amm-ui" ''
|
|
export DYLD_FALLBACK_LIBRARY_PATH="${ammFfi}/lib''${DYLD_FALLBACK_LIBRARY_PATH:+:$DYLD_FALLBACK_LIBRARY_PATH}"
|
|
exec ${app.program} "$@"
|
|
''}";
|
|
};
|
|
|
|
renamedApps = builtins.mapAttrs (
|
|
system: attrs:
|
|
(builtins.removeAttrs attrs [ "default" ]) // (if attrs ? default then { amm-ui = wrapWithDyld system attrs.default; } else { })
|
|
) appApps;
|
|
|
|
mergedPackages = builtins.mapAttrs (
|
|
system: cratePkgs:
|
|
let
|
|
appSysPkgs = appPkgs.${system} or { };
|
|
ammModSysPkgs = ammModulePkgs.${system} or { };
|
|
in
|
|
(builtins.removeAttrs cratePkgs [ "default" ])
|
|
// (builtins.removeAttrs appSysPkgs [ "default" ])
|
|
// (if appSysPkgs ? default then { amm-ui = appSysPkgs.default; } else { })
|
|
// (builtins.removeAttrs ammModSysPkgs [ "default" ])
|
|
// (if ammModSysPkgs ? default then { amm-module = ammModSysPkgs.default; } else { })
|
|
) crateOutputs.packages;
|
|
in
|
|
(builtins.removeAttrs appOutputs [ "apps" "packages" ])
|
|
// {
|
|
apps = renamedApps;
|
|
packages = mergedPackages;
|
|
};
|
|
}
|