From 243276e61a7f729710802f2cbe41ddf20e4222f4 Mon Sep 17 00:00:00 2001 From: Alejandro Cabeza Romero Date: Mon, 26 Jan 2026 19:44:49 +0100 Subject: [PATCH] wip --- .gitignore | 1 + CMakeLists.txt | 95 ++++++++++++++++++++++-------------------------- flake.nix | 97 +++++++++++++++++--------------------------------- justfile | 14 +++----- 4 files changed, 80 insertions(+), 127 deletions(-) diff --git a/.gitignore b/.gitignore index 154b8a9..4f1645a 100644 --- a/.gitignore +++ b/.gitignore @@ -10,6 +10,7 @@ cmake_install.cmake cmake-build-debug .cache/ build/ +target/ # Artifacts liblogos-blockchain-module.so diff --git a/CMakeLists.txt b/CMakeLists.txt index 19c2ec3..583ef02 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -4,14 +4,13 @@ project(logos-blockchain-module LANGUAGES CXX) set(CMAKE_CXX_STANDARD 20) set(CMAKE_CXX_STANDARD_REQUIRED ON) -option(COPY_PLUGIN_TO_SOURCE_DIR "Copy built plugin to repo root (dev convenience)" ON) -option(LOGOS_BUILD_DEPS_BY_DEFAULT "Always stage+build Rust deps when building the plugin" OFF) +option(LOGOS_BUILD_DEPS_BY_DEFAULT "Always build Rust deps when building the plugin" OFF) -set(LOGOS_CPP_SDK_ROOT "" CACHE PATH "Path to logos-cpp-sdk root") -set(LOGOS_BLOCKCHAIN_ROOT "" CACHE PATH "Path to logos-blockchain source root") +set(LOGOS_CORE_ROOT "$ENV{LOGOS_CORE_ROOT}" CACHE PATH "Path to logos-core root") +set(LOGOS_BLOCKCHAIN_ROOT "$ENV{LOGOS_BLOCKCHAIN_ROOT}" CACHE PATH "Path to logos-blockchain source root") -if(LOGOS_CPP_SDK_ROOT STREQUAL "") - message(FATAL_ERROR "LOGOS_CPP_SDK_ROOT not set. Pass -DLOGOS_CPP_SDK_ROOT=/path/to/logos-cpp-sdk") +if(LOGOS_CORE_ROOT STREQUAL "") + message(FATAL_ERROR "LOGOS_CORE_ROOT not set. Pass -DLOGOS_CORE_ROOT=/path/to/logos-core") endif() if(LOGOS_BLOCKCHAIN_ROOT STREQUAL "") message(FATAL_ERROR "LOGOS_BLOCKCHAIN_ROOT not set. Pass -DLOGOS_BLOCKCHAIN_ROOT=/path/to/logos-blockchain") @@ -22,24 +21,25 @@ set(CMAKE_AUTOMOC ON) set(CMAKE_AUTOUIC ON) set(CMAKE_AUTORCC ON) -# ---- writable stage (Nix store is read-only) ---- -set(LOGOS_BLOCKCHAIN_WORKDIR "${CMAKE_BINARY_DIR}/logos_blockchain_src") -set(LOGOS_BLOCKCHAIN_STAGE_STAMP "${LOGOS_BLOCKCHAIN_WORKDIR}/.staged") +# ---- Directory Structure ---- +set(WORKSPACE_ROOT "${CMAKE_BINARY_DIR}/workspace") +set(INTERNAL_STAGE "${WORKSPACE_ROOT}/stage") +set(FINAL_TARGET "${CMAKE_SOURCE_DIR}/target") -add_custom_command( - OUTPUT "${LOGOS_BLOCKCHAIN_STAGE_STAMP}" - COMMAND ${CMAKE_COMMAND} -E make_directory "${LOGOS_BLOCKCHAIN_WORKDIR}" - COMMAND ${CMAKE_COMMAND} -E copy_directory "${LOGOS_BLOCKCHAIN_ROOT}" "${LOGOS_BLOCKCHAIN_WORKDIR}" - COMMAND ${CMAKE_COMMAND} -E touch "${LOGOS_BLOCKCHAIN_STAGE_STAMP}" - VERBATIM -) -add_custom_target(logos_blockchain_stage DEPENDS "${LOGOS_BLOCKCHAIN_STAGE_STAMP}") +# Ensure directories exist +file(MAKE_DIRECTORY "${INTERNAL_STAGE}/include" "${INTERNAL_STAGE}/lib" "${FINAL_TARGET}") -# ---- build + stage c-bindings (Rust) ---- -set(LOGOS_INSTALL_DIR "${CMAKE_BINARY_DIR}/logos_stage") -file(MAKE_DIRECTORY "${LOGOS_INSTALL_DIR}/include" "${LOGOS_INSTALL_DIR}/lib") +# ---- Internal Staging for C++ SDK (Symlinks) ---- +set(SDK_STAGED_LIB "${INTERNAL_STAGE}/lib/liblogos_sdk.a") +if(NOT EXISTS "${SDK_STAGED_LIB}") + file(CREATE_LINK "${LOGOS_CORE_ROOT}/lib/liblogos_sdk.a" "${SDK_STAGED_LIB}" SYMBOLIC) + file(CREATE_LINK "${LOGOS_CORE_ROOT}/include/core" "${INTERNAL_STAGE}/include/core" SYMBOLIC) + file(CREATE_LINK "${LOGOS_CORE_ROOT}/include/cpp" "${INTERNAL_STAGE}/include/cpp" SYMBOLIC) +endif() -set(CARGO_TARGET_DIR "${CMAKE_BINARY_DIR}/cargo-target") +# ---- Rust Blockchain Build (Zero-Copy) ---- +find_program(CARGO_EXECUTABLE cargo REQUIRED) +set(CARGO_TARGET_DIR "${WORKSPACE_ROOT}/logos-blockchain/target") if(APPLE) set(LOGOS_BLOCKCHAIN_EXT ".dylib") @@ -49,12 +49,12 @@ else() set(LOGOS_BLOCKCHAIN_EXT ".so") endif() -set(LOGOS_BLOCKCHAIN_C_SOURCE_DYLIB_NAME "liblib_logos_blockchain${LOGOS_BLOCKCHAIN_EXT}" CACHE STRING "Filename produced by cargo") -set(LOGOS_BLOCKCHAIN_C_STAGED_DYLIB_NAME "lib_logos_blockchain${LOGOS_BLOCKCHAIN_EXT}" CACHE STRING "Filename staged next to plugin") -set(LOGOS_BLOCKCHAIN_C_HEADER_NAME "lib_logos_blockchain.h" CACHE STRING "Header in c-bindings crate root") +set(LOGOS_BLOCKCHAIN_C_SOURCE_DYLIB_NAME "liblib_logos_blockchain${LOGOS_BLOCKCHAIN_EXT}") +set(LOGOS_BLOCKCHAIN_C_STAGED_DYLIB_NAME "lib_logos_blockchain${LOGOS_BLOCKCHAIN_EXT}") +set(LOGOS_BLOCKCHAIN_C_HEADER_NAME "lib_logos_blockchain.h") -set(LOGOS_BLOCKCHAIN_STAGED_DYLIB "${LOGOS_INSTALL_DIR}/lib/${LOGOS_BLOCKCHAIN_C_STAGED_DYLIB_NAME}") -set(LOGOS_BLOCKCHAIN_STAGED_HEADER "${LOGOS_INSTALL_DIR}/include/${LOGOS_BLOCKCHAIN_C_HEADER_NAME}") +set(LOGOS_BLOCKCHAIN_STAGED_DYLIB "${INTERNAL_STAGE}/lib/${LOGOS_BLOCKCHAIN_C_STAGED_DYLIB_NAME}") +set(LOGOS_BLOCKCHAIN_STAGED_HEADER "${INTERNAL_STAGE}/include/${LOGOS_BLOCKCHAIN_C_HEADER_NAME}") set(PATCHELF_COMMANDS "") if(UNIX AND NOT APPLE AND NOT WIN32) @@ -70,20 +70,18 @@ add_custom_command( COMMAND ${CMAKE_COMMAND} -E env CARGO_TERM_COLOR=always CARGO_TARGET_DIR=${CARGO_TARGET_DIR} - cargo build --release --package logos-blockchain-c + cargo build --release --package logos-blockchain-c --manifest-path "${LOGOS_BLOCKCHAIN_ROOT}/Cargo.toml" COMMAND ${CMAKE_COMMAND} -E copy "${CARGO_TARGET_DIR}/release/${LOGOS_BLOCKCHAIN_C_SOURCE_DYLIB_NAME}" "${LOGOS_BLOCKCHAIN_STAGED_DYLIB}" ${PATCHELF_COMMANDS} - DEPENDS "${LOGOS_BLOCKCHAIN_STAGE_STAMP}" - WORKING_DIRECTORY "${LOGOS_BLOCKCHAIN_WORKDIR}" VERBATIM ) add_custom_command( OUTPUT "${LOGOS_BLOCKCHAIN_STAGED_HEADER}" COMMAND ${CMAKE_COMMAND} -E copy_if_different - "${LOGOS_BLOCKCHAIN_WORKDIR}/c-bindings/${LOGOS_BLOCKCHAIN_C_HEADER_NAME}" + "${LOGOS_BLOCKCHAIN_ROOT}/c-bindings/${LOGOS_BLOCKCHAIN_C_HEADER_NAME}" "${LOGOS_BLOCKCHAIN_STAGED_HEADER}" DEPENDS "${LOGOS_BLOCKCHAIN_STAGED_DYLIB}" VERBATIM @@ -94,37 +92,34 @@ add_custom_target(logos_cargo_build DEPENDS "${LOGOS_BLOCKCHAIN_STAGED_DYLIB}" " add_library(logos_blockchain_c SHARED IMPORTED GLOBAL) set_target_properties(logos_blockchain_c PROPERTIES IMPORTED_LOCATION "${LOGOS_BLOCKCHAIN_STAGED_DYLIB}" - INTERFACE_INCLUDE_DIRECTORIES "${LOGOS_INSTALL_DIR}/include" + INTERFACE_INCLUDE_DIRECTORIES "${INTERNAL_STAGE}/include" ) add_dependencies(logos_blockchain_c logos_cargo_build) -# ---- logos-cpp-sdk ---- +# ---- C++ SDK Target (using staged symlinks) ---- add_library(logos_cpp_sdk INTERFACE) target_include_directories(logos_cpp_sdk INTERFACE - "${LOGOS_CPP_SDK_ROOT}/include/core" - "${LOGOS_CPP_SDK_ROOT}/include/cpp" - "${LOGOS_CPP_SDK_ROOT}/include" + "${INTERNAL_STAGE}/include" ) add_library(logos_core STATIC IMPORTED) set_target_properties(logos_core PROPERTIES - IMPORTED_LOCATION "${LOGOS_CPP_SDK_ROOT}/lib/liblogos_sdk.a" + IMPORTED_LOCATION "${SDK_STAGED_LIB}" ) -# ---- plugin ---- -set(MODULE_ID "liblogos-blockchain-module") -set(PLUGIN_TARGET "${MODULE_ID}") +# ---- Plugin ---- +set(PLUGIN_TARGET "liblogos-blockchain-module") qt_add_plugin(${PLUGIN_TARGET} CLASS_NAME LogosBlockchainModule) -# Keep the filename expected by the viewer/tooling (if you still want it this way) set_target_properties(${PLUGIN_TARGET} PROPERTIES OUTPUT_NAME "logos-blockchain-module" + LIBRARY_OUTPUT_DIRECTORY "${FINAL_TARGET}" ) target_sources(${PLUGIN_TARGET} PRIVATE - "${CMAKE_CURRENT_SOURCE_DIR}/library.cpp" - "${CMAKE_CURRENT_SOURCE_DIR}/metadata.json" + "library.cpp" + "metadata.json" ) target_link_libraries(${PLUGIN_TARGET} PRIVATE @@ -137,31 +132,25 @@ target_link_libraries(${PLUGIN_TARGET} PRIVATE target_compile_definitions(${PLUGIN_TARGET} PRIVATE USING_QT) if(LOGOS_BUILD_DEPS_BY_DEFAULT) - add_dependencies(${PLUGIN_TARGET} logos_blockchain_stage logos_cargo_build) + add_dependencies(${PLUGIN_TARGET} logos_cargo_build) endif() +# RPATH so the plugin finds the Rust .so in the same folder if(APPLE) set_target_properties(${PLUGIN_TARGET} PROPERTIES BUILD_RPATH "@loader_path" INSTALL_RPATH "@loader_path") elseif(UNIX) set_target_properties(${PLUGIN_TARGET} PROPERTIES BUILD_RPATH "$ORIGIN" INSTALL_RPATH "$ORIGIN") endif() +# Copy Rust library to final target folder next to the plugin add_custom_command(TARGET ${PLUGIN_TARGET} POST_BUILD COMMAND ${CMAKE_COMMAND} -E copy_if_different "${LOGOS_BLOCKCHAIN_STAGED_DYLIB}" - "$/${LOGOS_BLOCKCHAIN_C_STAGED_DYLIB_NAME}" + "${FINAL_TARGET}/${LOGOS_BLOCKCHAIN_C_STAGED_DYLIB_NAME}" VERBATIM ) -if(COPY_PLUGIN_TO_SOURCE_DIR) - add_custom_command(TARGET ${PLUGIN_TARGET} POST_BUILD - COMMAND ${CMAKE_COMMAND} -E copy_if_different - "$" - "${CMAKE_SOURCE_DIR}/$" - VERBATIM - ) -endif() - +# ---- Installation ---- install(TARGETS ${PLUGIN_TARGET} LIBRARY DESTINATION lib ARCHIVE DESTINATION lib diff --git a/flake.nix b/flake.nix index 6459ece..628aad6 100644 --- a/flake.nix +++ b/flake.nix @@ -4,7 +4,7 @@ inputs = { nixpkgs.follows = "logos-liblogos/nixpkgs"; logos-liblogos.url = "github:logos-co/logos-liblogos"; - logos-cpp-sdk.url = "github:logos-co/logos-cpp-sdk"; + logos-core.url = "github:logos-co/logos-cpp-sdk"; logos-blockchain = { url = "github:logos-blockchain/logos-blockchain"; @@ -18,107 +18,74 @@ forAllSystems = f: nixpkgs.lib.genAttrs systems (system: let pkgs = import nixpkgs { inherit system; }; - qt = pkgs.qt6; llvmPkgs = pkgs.llvmPackages; - logosSdk = inputs.logos-cpp-sdk.packages.${system}.default; - logosBlockchainSrc = inputs.logos-blockchain; - in - f { inherit pkgs qt llvmPkgs logosSdk logosBlockchainSrc; }); - in - { - packages = forAllSystems ({ pkgs, qt, llvmPkgs, logosSdk, logosBlockchainSrc }: - { - default = pkgs.stdenv.mkDerivation { - pname = "logos-blockchain-module"; - version = "dev"; - src = ./.; + logosCore = inputs.logos-core.packages.${system}.default; + logosBlockchain = inputs.logos-blockchain; + + env = { + LOGOS_CORE_ROOT = "${logosCore}"; + LOGOS_BLOCKCHAIN_ROOT = "${logosBlockchain}"; + LIBCLANG_PATH = "${llvmPkgs.libclang.lib}/lib"; + CLANG_PATH = "${llvmPkgs.clang}/bin/clang"; + }; + + args = { + inherit (env) LOGOS_CORE_ROOT LOGOS_BLOCKCHAIN_ROOT LIBCLANG_PATH CLANG_PATH; nativeBuildInputs = [ pkgs.cmake pkgs.ninja pkgs.pkg-config - qt.wrapQtAppsHook pkgs.patchelf ]; buildInputs = [ - qt.qtbase - qt.qttools - + pkgs.qt6.qtbase + pkgs.qt6.qttools pkgs.rustc pkgs.cargo pkgs.git - llvmPkgs.clang llvmPkgs.llvm llvmPkgs.libclang ] ++ pkgs.lib.optionals pkgs.stdenv.isDarwin [ pkgs.libiconv ]; + }; + in + f { inherit pkgs args; }); + in + { + packages = forAllSystems ({ pkgs, args }: + { + default = pkgs.stdenv.mkDerivation (args // { + pname = "logos-blockchain-module"; + version = "dev"; + src = ./.; - LOGOS_CPP_SDK_ROOT = "${logosSdk}"; - LOGOS_BLOCKCHAIN_ROOT = "${logosBlockchainSrc}"; - - LIBCLANG_PATH = "${llvmPkgs.libclang.lib}/lib"; - CLANG_PATH = "${llvmPkgs.clang}/bin/clang"; + nativeBuildInputs = args.nativeBuildInputs ++ [ pkgs.qt6.wrapQtAppsHook ]; CARGO_HOME = "${"$"}TMPDIR/cargo-home"; - cmakeFlags = [ - "-DUNTITLED_USE_QT=ON" - "-DLOGOS_CPP_SDK_ROOT=${logosSdk}" - "-DLOGOS_BLOCKCHAIN_ROOT=${logosBlockchainSrc}" - "-DCOPY_PLUGIN_TO_SOURCE_DIR=OFF" - ]; - preConfigure = '' mkdir -p $CARGO_HOME ''; - }; + }); } ); - devShells = forAllSystems ({ pkgs, qt, llvmPkgs, logosSdk, logosBlockchainSrc }: + devShells = forAllSystems ({ pkgs, args }: { - default = pkgs.mkShell { - nativeBuildInputs = [ - pkgs.cmake - pkgs.ninja - pkgs.pkg-config - pkgs.patchelf - ]; - - buildInputs = [ - qt.qtbase - qt.qttools - - pkgs.rustc - pkgs.cargo - pkgs.git - - llvmPkgs.clang - llvmPkgs.llvm - llvmPkgs.libclang - ]; - - LOGOS_CPP_SDK_ROOT = "${logosSdk}"; - LOGOS_BLOCKCHAIN_ROOT = "${logosBlockchainSrc}"; - - LIBCLANG_PATH = "${llvmPkgs.libclang.lib}/lib"; - CLANG_PATH = "${llvmPkgs.clang}/bin/clang"; - + default = pkgs.mkShell (args // { shellHook = '' echo "Logos Blockchain Module dev environment" - echo "LOGOS_CPP_SDK_ROOT: $LOGOS_CPP_SDK_ROOT" + echo "LOGOS_CORE_ROOT: $LOGOS_CORE_ROOT" echo "LOGOS_BLOCKCHAIN_ROOT: $LOGOS_BLOCKCHAIN_ROOT" - echo "LIBCLANG_PATH: $LIBCLANG_PATH" - echo "CLANG_PATH: $CLANG_PATH" echo "" echo "Build with:" - echo " just clean" echo " just build" ''; - }; + }); } ); }; diff --git a/justfile b/justfile index 8c8494f..5845a50 100644 --- a/justfile +++ b/justfile @@ -1,34 +1,30 @@ default: build configure: - test -n "${LOGOS_CPP_SDK_ROOT}" || (echo "LOGOS_CPP_SDK_ROOT not set" && exit 1) - test -n "${LOGOS_BLOCKCHAIN_ROOT}" || (echo "LOGOS_BLOCKCHAIN_ROOT not set" && exit 1) cmake -S . -B build -G Ninja \ - -DLOGOS_CPP_SDK_ROOT="${LOGOS_CPP_SDK_ROOT}" \ - -DLOGOS_BLOCKCHAIN_ROOT="${LOGOS_BLOCKCHAIN_ROOT}" \ + ${LOGOS_CORE_ROOT:+-DLOGOS_CORE_ROOT="$LOGOS_CORE_ROOT"} \ + ${LOGOS_BLOCKCHAIN_ROOT:+-DLOGOS_BLOCKCHAIN_ROOT="$LOGOS_BLOCKCHAIN_ROOT"} \ -DCOPY_PLUGIN_TO_SOURCE_DIR=ON build: cmake --build build --parallel --target liblogos-blockchain-module update: clean-full - cmake --build build --parallel --target logos_blockchain_stage cmake --build build --parallel --target logos_cargo_build just build clean: - rm -f build/liblogos-blockchain-module.so - rm -f liblogos-blockchain-module.so + rm -rf build + rm -rf target rm -f liblogos-blockchain-module.log rm -rf logos_blockchain_db/ clean-full: clean - rm -rf build rebuild: clean configure build run: - RUST_BACKTRACE=full RUST_LOG=trace ../logos-module-viewer/result/bin/logos-module-viewer --module liblogos-blockchain-module.so > liblogos-blockchain-module.log 2>&1 + RUST_BACKTRACE=full RUST_LOG=trace ../logos-module-viewer/result/bin/logos-module-viewer --module target/liblogos-blockchain-module.so > liblogos-blockchain-module.log 2>&1 nix: nix develop .#