From 5d58fcb3fd40cb01276818139bb9ab0f22a928b1 Mon Sep 17 00:00:00 2001 From: Alejandro Cabeza Romero Date: Fri, 17 Apr 2026 15:42:52 +0200 Subject: [PATCH] Handle OperationStatus returns from free_* and subscribe; rename identifiers to snake_case; reorganise cpp sections --- src/i_logos_blockchain_module.h | 24 ++-- src/logos_blockchain_module.cpp | 223 +++++++++++++++++--------------- src/logos_blockchain_module.h | 38 +++--- 3 files changed, 152 insertions(+), 133 deletions(-) diff --git a/src/i_logos_blockchain_module.h b/src/i_logos_blockchain_module.h index ec56789..a9467d4 100644 --- a/src/i_logos_blockchain_module.h +++ b/src/i_logos_blockchain_module.h @@ -9,7 +9,7 @@ public: virtual ~ILogosBlockchainModule() = default; // Logos Core - virtual void initLogos(LogosAPI* logosAPIInstance) = 0; + virtual void initLogos(LogosAPI* logos_api_instance) = 0; // ---- Node ---- @@ -20,28 +20,28 @@ public: virtual int stop() = 0; // Wallet - virtual QString wallet_get_balance(const QString& addressHex) = 0; + virtual QString wallet_get_balance(const QString& address_hex) = 0; virtual QString wallet_transfer_funds( - const QString& changePublicKey, - const QStringList& senderAddresses, - const QString& recipientAddress, + const QString& change_public_key, + const QStringList& sender_addresses, + const QString& recipient_address, const QString& amount, - const QString& optionalTipHex + const QString& optional_tip_hex ) = 0; virtual QStringList wallet_get_known_addresses() = 0; // Blend virtual QString blend_join_as_core_node( - const QString& providerIdHex, - const QString& zkIdHex, - const QString& lockedNoteIdHex, + const QString& provider_id_hex, + const QString& zk_id_hex, + const QString& locked_note_id_hex, const QStringList& locators ) = 0; // Storage - virtual QString get_block(const QString& headerIdHex) = 0; - virtual QString get_blocks(quint64 fromSlot, quint64 toSlot) = 0; - virtual QString get_transaction(const QString& txHashHex) = 0; + virtual QString get_block(const QString& header_id_hex) = 0; + virtual QString get_blocks(quint64 from_slot, quint64 to_slot) = 0; + virtual QString get_transaction(const QString& tx_hash_hex) = 0; // Cryptarchia virtual QString get_cryptarchia_info() = 0; diff --git a/src/logos_blockchain_module.cpp b/src/logos_blockchain_module.cpp index 7ec94b2..1912f36 100644 --- a/src/logos_blockchain_module.cpp +++ b/src/logos_blockchain_module.cpp @@ -11,18 +11,18 @@ LogosBlockchainModule* LogosBlockchainModule::s_instance = nullptr; namespace { // Use the C API type Hash (from logos_blockchain.h) to define address/hash byte size. - constexpr int kAddressBytes = static_cast(sizeof(Hash)); - constexpr int kAddressHexLen = kAddressBytes * 2; + constexpr int ADDRESS_BYTES = sizeof(Hash); + constexpr int ADDRESS_HEX_LEN = ADDRESS_BYTES * 2; - // Parses kAddressHexLen hex chars (optional 0x prefix) to kAddressBytes. Returns empty QByteArray on error. - QByteArray parseAddressHex(const QString& addressHex) { - QString hex = addressHex.trimmed(); + // Parses ADDRESS_HEX_LEN hex chars (optional 0x prefix) to ADDRESS_BYTES. Returns empty QByteArray on error. + QByteArray parse_address_hex(const QString& address_hex) { + QString hex = address_hex.trimmed(); if (hex.startsWith(QStringLiteral("0x"), Qt::CaseInsensitive)) hex = hex.mid(2); - if (hex.length() != kAddressHexLen) + if (hex.length() != ADDRESS_HEX_LEN) return {}; QByteArray bytes = QByteArray::fromHex(hex.toUtf8()); - if (bytes.size() != kAddressBytes) + if (bytes.size() != ADDRESS_BYTES) return {}; return bytes; } @@ -151,12 +151,12 @@ namespace { }; } // namespace -void LogosBlockchainModule::onNewBlockCallback(const char* block) { +void LogosBlockchainModule::on_new_block_callback(const char* block) { if (s_instance) { qInfo() << "Received new block: " << block; QVariantList data; data.append(QString::fromUtf8(block)); - s_instance->emitEvent("newBlock", data); + s_instance->emit_event("newBlock", data); // SAFETY: // We are getting an owned pointer here which is freed after this callback is called, so there is not need to // free the resrouce here as we are copying the data! @@ -184,8 +184,8 @@ QString LogosBlockchainModule::version() const { return "1.0.0"; } -void LogosBlockchainModule::initLogos(LogosAPI* logosAPIInstance) { - logosAPI = logosAPIInstance; +void LogosBlockchainModule::initLogos(LogosAPI* logos_api_instance) { + logosAPI = logos_api_instance; if (logosAPI) { client = logosAPI->getClient("liblogos_blockchain_module"); if (!client) { @@ -265,7 +265,11 @@ int LogosBlockchainModule::start(const QString& config_path, const QString& depl } s_instance = this; - subscribe_to_new_blocks(node, onNewBlockCallback); + const OperationStatus subscribe_status = subscribe_to_new_blocks(node, on_new_block_callback); + if (!is_ok(&subscribe_status)) { + qCritical() << "Failed to subscribe to new blocks. Error:" << subscribe_status; + return 4; + } return 0; } @@ -291,14 +295,14 @@ int LogosBlockchainModule::stop() { // Wallet -QString LogosBlockchainModule::wallet_get_balance(const QString& addressHex) { - qDebug() << "wallet_get_balance: addressHex=" << addressHex; +QString LogosBlockchainModule::wallet_get_balance(const QString& address_hex) { + qDebug() << "wallet_get_balance: address_hex=" << address_hex; if (!node) { return QStringLiteral("Error: The node is not running."); } - const QByteArray bytes = parseAddressHex(addressHex); - if (bytes.isEmpty() || bytes.size() != kAddressBytes) { + const QByteArray bytes = parse_address_hex(address_hex); + if (bytes.isEmpty() || bytes.size() != ADDRESS_BYTES) { return QStringLiteral("Error: Address must be 64 hex characters (32 bytes)."); } @@ -311,80 +315,80 @@ QString LogosBlockchainModule::wallet_get_balance(const QString& addressHex) { } QString LogosBlockchainModule::wallet_transfer_funds( - const QString& changePublicKey, - const QStringList& senderAddresses, - const QString& recipientAddress, + const QString& change_public_key, + const QStringList& sender_addresses, + const QString& recipient_address, const QString& amount, - const QString& optionalTipHex + const QString& optional_tip_hex ) { if (!node) { return QStringLiteral("Error: The node is not running."); } bool ok = false; - const quint64 amountVal = amount.trimmed().toULongLong(&ok); + const quint64 amount_val = amount.trimmed().toULongLong(&ok); if (!ok) { return QStringLiteral("Error: Invalid amount (positive integer required)."); } - const QByteArray changeBytes = parseAddressHex(changePublicKey); - if (changeBytes.isEmpty() || changeBytes.size() != kAddressBytes) { - return QStringLiteral("Error: Invalid changePublicKey (64 hex characters required)."); + const QByteArray change_bytes = parse_address_hex(change_public_key); + if (change_bytes.isEmpty() || change_bytes.size() != ADDRESS_BYTES) { + return QStringLiteral("Error: Invalid change_public_key (64 hex characters required)."); } - const QByteArray recipientBytes = parseAddressHex(recipientAddress); - if (recipientBytes.isEmpty() || recipientBytes.size() != kAddressBytes) { - return QStringLiteral("Error: Invalid recipientAddress (64 hex characters required)."); + const QByteArray recipient_bytes = parse_address_hex(recipient_address); + if (recipient_bytes.isEmpty() || recipient_bytes.size() != ADDRESS_BYTES) { + return QStringLiteral("Error: Invalid recipient_address (64 hex characters required)."); } - if (senderAddresses.isEmpty()) { + if (sender_addresses.isEmpty()) { return QStringLiteral("Error: At least one sender address required."); } - QVector fundingBytes; - for (const QString& hex : senderAddresses) { - QByteArray b = parseAddressHex(hex); - if (b.isEmpty() || b.size() != kAddressBytes) { + QVector funding_bytes; + for (const QString& hex : sender_addresses) { + QByteArray b = parse_address_hex(hex); + if (b.isEmpty() || b.size() != ADDRESS_BYTES) { return QStringLiteral("Error: Invalid sender address (64 hex characters required)."); } - fundingBytes.append(b); + funding_bytes.append(b); } - QVector fundingPtrs; - for (const QByteArray& b : fundingBytes) - fundingPtrs.append(reinterpret_cast(b.constData())); + QVector funding_ptrs; + for (const QByteArray& b : funding_bytes) + funding_ptrs.append(reinterpret_cast(b.constData())); - QByteArray tipBytes; // NOLINT: Needs to be outside of scope for lifetime + QByteArray tip_bytes; // NOLINT: Needs to be outside of scope for lifetime const HeaderId* optional_tip = nullptr; - if (!optionalTipHex.isEmpty()) { - tipBytes = parseAddressHex(optionalTipHex); - if (tipBytes.isEmpty() || tipBytes.size() != kAddressBytes) { + if (!optional_tip_hex.isEmpty()) { + tip_bytes = parse_address_hex(optional_tip_hex); + if (tip_bytes.isEmpty() || tip_bytes.size() != ADDRESS_BYTES) { return QStringLiteral("Error: Invalid optional tip (64 hex characters or empty)."); } - optional_tip = reinterpret_cast(tipBytes.constData()); + optional_tip = reinterpret_cast(tip_bytes.constData()); } TransferFundsArguments args{}; args.optional_tip = optional_tip; - args.change_public_key = reinterpret_cast(changeBytes.constData()); - args.funding_public_keys = fundingPtrs.constData(); - args.funding_public_keys_len = static_cast(fundingPtrs.size()); - args.recipient_public_key = reinterpret_cast(recipientBytes.constData()); - args.amount = amountVal; + args.change_public_key = reinterpret_cast(change_bytes.constData()); + args.funding_public_keys = funding_ptrs.constData(); + args.funding_public_keys_len = static_cast(funding_ptrs.size()); + args.recipient_public_key = reinterpret_cast(recipient_bytes.constData()); + args.amount = amount_val; auto [value, error] = transfer_funds(node, &args); if (!is_ok(&error)) { return QStringLiteral("Error: Failed to transfer funds: ") + QString::number(error); } // value is Hash (32 bytes); convert to hex string - const QByteArray hashBytes(reinterpret_cast(&value), kAddressBytes); - return QString::fromUtf8(hashBytes.toHex()); + const QByteArray hash_bytes(reinterpret_cast(&value), ADDRESS_BYTES); + return QString::fromUtf8(hash_bytes.toHex()); } QString LogosBlockchainModule::wallet_transfer_funds( - const QString& changePublicKey, - const QString& senderAddress, - const QString& recipientAddress, + const QString& change_public_key, + const QString& sender_address, + const QString& recipient_address, const QString& amount, - const QString& optionalTipHex + const QString& optional_tip_hex ) { - return wallet_transfer_funds(changePublicKey, QStringList{senderAddress}, recipientAddress, amount, optionalTipHex); + return wallet_transfer_funds(change_public_key, QStringList{sender_address}, recipient_address, amount, optional_tip_hex); } QStringList LogosBlockchainModule::wallet_get_known_addresses() { @@ -398,15 +402,18 @@ QStringList LogosBlockchainModule::wallet_get_known_addresses() { qCritical() << "Failed to get known addresses. Error:" << error; return out; } - // Each address is kAddressBytes (32) byte + // Each address is ADDRESS_BYTES (32) bytes for (size_t i = 0; i < value.len; ++i) { const uint8_t* ptr = value.addresses[i]; // NOLINT: Move definition to if-statement if (ptr) { - QByteArray addr(reinterpret_cast(ptr), kAddressBytes); + QByteArray addr(reinterpret_cast(ptr), ADDRESS_BYTES); out.append(QString::fromUtf8(addr.toHex())); } } - free_known_addresses(value); + const OperationStatus free_status = free_known_addresses(value); + if (!is_ok(&free_status)) { + qWarning() << "Failed to free known addresses. Error:" << free_status; + } qDebug() << "blockchain lib: known addresses, count=" << out.size() << "sample:" << (out.isEmpty() ? QLatin1String("(none)") : out.constFirst()); return out; @@ -415,69 +422,69 @@ QStringList LogosBlockchainModule::wallet_get_known_addresses() { // Blend QString LogosBlockchainModule::blend_join_as_core_node( - const QString& providerIdHex, - const QString& zkIdHex, - const QString& lockedNoteIdHex, + const QString& provider_id_hex, + const QString& zk_id_hex, + const QString& locked_note_id_hex, const QStringList& locators ) { if (!node) { return QStringLiteral("Error: The node is not running."); } - const QByteArray providerIdBytes = parseAddressHex(providerIdHex); - if (providerIdBytes.isEmpty() || providerIdBytes.size() != kAddressBytes) { - return QStringLiteral("Error: Invalid providerId (64 hex characters required)."); + const QByteArray provider_id_bytes = parse_address_hex(provider_id_hex); + if (provider_id_bytes.isEmpty() || provider_id_bytes.size() != ADDRESS_BYTES) { + return QStringLiteral("Error: Invalid provider_id_hex (64 hex characters required)."); } - const QByteArray zkIdBytes = parseAddressHex(zkIdHex); - if (zkIdBytes.isEmpty() || zkIdBytes.size() != kAddressBytes) { - return QStringLiteral("Error: Invalid zkId (64 hex characters required)."); + const QByteArray zk_id_bytes = parse_address_hex(zk_id_hex); + if (zk_id_bytes.isEmpty() || zk_id_bytes.size() != ADDRESS_BYTES) { + return QStringLiteral("Error: Invalid zk_id_hex (64 hex characters required)."); } - const QByteArray lockedNoteIdBytes = parseAddressHex(lockedNoteIdHex); - if (lockedNoteIdBytes.isEmpty() || lockedNoteIdBytes.size() != kAddressBytes) { - return QStringLiteral("Error: Invalid lockedNoteId (64 hex characters required)."); + const QByteArray locked_note_id_bytes = parse_address_hex(locked_note_id_hex); + if (locked_note_id_bytes.isEmpty() || locked_note_id_bytes.size() != ADDRESS_BYTES) { + return QStringLiteral("Error: Invalid locked_note_id_hex (64 hex characters required)."); } // QString is UTF-16, but the FFI requires UTF-8. - // locatorsData owns the converted buffers, while locatorsPtrs holds raw pointers into them for the FFI call. + // locators_data owns the converted buffers, while locators_ptrs holds raw pointers into them for the FFI call. // Using reserve() prevents reallocation, keeping the constData() pointers stable. - std::vector locatorsData; - std::vector locatorsPtrs; - locatorsData.reserve(locators.size()); - locatorsPtrs.reserve(locators.size()); + std::vector locators_data; + std::vector locators_ptrs; + locators_data.reserve(locators.size()); + locators_ptrs.reserve(locators.size()); for (const QString& locator : locators) { - locatorsData.push_back(locator.toUtf8()); - locatorsPtrs.push_back(locatorsData.back().constData()); + locators_data.push_back(locator.toUtf8()); + locators_ptrs.push_back(locators_data.back().constData()); } auto [value, error] = ::blend_join_as_core_node( node, - reinterpret_cast(providerIdBytes.constData()), - reinterpret_cast(zkIdBytes.constData()), - reinterpret_cast(lockedNoteIdBytes.constData()), - locatorsPtrs.data(), - locatorsPtrs.size() + reinterpret_cast(provider_id_bytes.constData()), + reinterpret_cast(zk_id_bytes.constData()), + reinterpret_cast(locked_note_id_bytes.constData()), + locators_ptrs.data(), + locators_ptrs.size() ); if (!is_ok(&error)) { - qCritical() << "Failed to join as core node. Error:" << error; return QStringLiteral("Error: Failed to join as core node: ") + QString::number(error); } - const QByteArray declarationIdBytes(reinterpret_cast(&value), sizeof(value)); - qInfo() << "Successfully joined as core node. DeclarationId:" << declarationIdBytes.toHex(); - return QString::fromUtf8(declarationIdBytes.toHex()); + const QByteArray declaration_id_bytes(reinterpret_cast(&value), sizeof(value)); + const QString declaration_id = QString::fromUtf8(declaration_id_bytes.toHex()); + qInfo() << "Successfully joined as core node. DeclarationId:" << declaration_id; + return declaration_id; } // Storage -QString LogosBlockchainModule::get_block(const QString& headerIdHex) { +QString LogosBlockchainModule::get_block(const QString& header_id_hex) { if (!node) { return QStringLiteral("Error: The node is not running."); } - const QByteArray bytes = parseAddressHex(headerIdHex); - if (bytes.isEmpty() || bytes.size() != kAddressBytes) { + const QByteArray bytes = parse_address_hex(header_id_hex); + if (bytes.isEmpty() || bytes.size() != ADDRESS_BYTES) { return QStringLiteral("Error: Header ID must be 64 hex characters (32 bytes)."); } @@ -488,33 +495,39 @@ QString LogosBlockchainModule::get_block(const QString& headerIdHex) { } const QString result = QString::fromUtf8(value); - free_cstring(value); + const OperationStatus free_status = free_cstring(value); + if (!is_ok(&free_status)) { + qWarning() << "Failed to free block string. Error:" << free_status; + } return result; } -QString LogosBlockchainModule::get_blocks(const quint64 fromSlot, const quint64 toSlot) { +QString LogosBlockchainModule::get_blocks(const quint64 from_slot, const quint64 to_slot) { if (!node) { return QStringLiteral("Error: The node is not running."); } - auto [value, error] = ::get_blocks(node, fromSlot, toSlot); + auto [value, error] = ::get_blocks(node, from_slot, to_slot); if (!is_ok(&error)) { qWarning() << "Failed to get blocks. Error:" << error; return QStringLiteral("Error: Failed to get blocks: ") + QString::number(error); } const QString result = QString::fromUtf8(value); - free_cstring(value); + const OperationStatus free_status = free_cstring(value); + if (!is_ok(&free_status)) { + qWarning() << "Failed to free blocks string. Error:" << free_status; + } return result; } -QString LogosBlockchainModule::get_transaction(const QString& txHashHex) { +QString LogosBlockchainModule::get_transaction(const QString& tx_hash_hex) { if (!node) { return QStringLiteral("Error: The node is not running."); } - const QByteArray bytes = parseAddressHex(txHashHex); - if (bytes.isEmpty() || bytes.size() != kAddressBytes) { + const QByteArray bytes = parse_address_hex(tx_hash_hex); + if (bytes.isEmpty() || bytes.size() != ADDRESS_BYTES) { return QStringLiteral("Error: Transaction hash must be 64 hex characters (32 bytes)."); } @@ -525,7 +538,10 @@ QString LogosBlockchainModule::get_transaction(const QString& txHashHex) { } const QString result = QString::fromUtf8(value); - free_cstring(value); + const OperationStatus free_status = free_cstring(value); + if (!is_ok(&free_status)) { + qWarning() << "Failed to free transaction string. Error:" << free_status; + } return result; } @@ -544,26 +560,29 @@ QString LogosBlockchainModule::get_cryptarchia_info() { QJsonObject obj; obj[QStringLiteral("lib")] = - QString::fromUtf8(QByteArray(reinterpret_cast(value->lib), kAddressBytes).toHex()); + QString::fromUtf8(QByteArray(reinterpret_cast(value->lib), ADDRESS_BYTES).toHex()); obj[QStringLiteral("tip")] = - QString::fromUtf8(QByteArray(reinterpret_cast(value->tip), kAddressBytes).toHex()); + QString::fromUtf8(QByteArray(reinterpret_cast(value->tip), ADDRESS_BYTES).toHex()); obj[QStringLiteral("slot")] = static_cast(value->slot); obj[QStringLiteral("height")] = static_cast(value->height); obj[QStringLiteral("mode")] = (value->mode == State::Online) ? QStringLiteral("Online") : QStringLiteral("Bootstrapping"); - free_cryptarchia_info(value); + const OperationStatus free_status = free_cryptarchia_info(value); + if (!is_ok(&free_status)) { + qWarning() << "Failed to free cryptarchia info. Error:" << free_status; + } return QJsonDocument(obj).toJson(QJsonDocument::Compact); } -void LogosBlockchainModule::emitEvent(const QString& eventName, const QVariantList& data) { +void LogosBlockchainModule::emit_event(const QString& event_name, const QVariantList& data) { if (!logosAPI) { - qWarning() << "LogosBlockchainModule: LogosAPI not available, cannot emit" << eventName; + qWarning() << "LogosBlockchainModule: LogosAPI not available, cannot emit" << event_name; return; } if (!client) { - qWarning() << "LogosBlockchainModule: Failed to get liblogos_blockchain_module client for event" << eventName; + qWarning() << "LogosBlockchainModule: Failed to get liblogos_blockchain_module client for event" << event_name; return; } - client->onEventResponse(this, eventName, data); + client->onEventResponse(this, event_name, data); } diff --git a/src/logos_blockchain_module.h b/src/logos_blockchain_module.h index 71f7038..131e500 100644 --- a/src/logos_blockchain_module.h +++ b/src/logos_blockchain_module.h @@ -34,41 +34,41 @@ public: Q_INVOKABLE int stop() override; // Wallet - Q_INVOKABLE QString wallet_get_balance(const QString& addressHex) override; + Q_INVOKABLE QString wallet_get_balance(const QString& address_hex) override; Q_INVOKABLE QString wallet_transfer_funds( - const QString& changePublicKey, - const QStringList& senderAddresses, - const QString& recipientAddress, + const QString& change_public_key, + const QStringList& sender_addresses, + const QString& recipient_address, const QString& amount, - const QString& optionalTipHex + const QString& optional_tip_hex ) override; Q_INVOKABLE QString wallet_transfer_funds( - const QString& changePublicKey, - const QString& senderAddress, - const QString& recipientAddress, + const QString& change_public_key, + const QString& sender_address, + const QString& recipient_address, const QString& amount, - const QString& optionalTipHex + const QString& optional_tip_hex ); Q_INVOKABLE QStringList wallet_get_known_addresses() override; // Blend Q_INVOKABLE QString blend_join_as_core_node( - const QString& providerIdHex, - const QString& zkIdHex, - const QString& lockedNoteIdHex, + const QString& provider_id_hex, + const QString& zk_id_hex, + const QString& locked_note_id_hex, const QStringList& locators ) override; - // Storage - Q_INVOKABLE QString get_block(const QString& headerIdHex) override; - Q_INVOKABLE QString get_blocks(quint64 fromSlot, quint64 toSlot) override; - Q_INVOKABLE QString get_transaction(const QString& txHashHex) override; + // Explorer + Q_INVOKABLE QString get_block(const QString& header_id_hex) override; + Q_INVOKABLE QString get_blocks(quint64 from_slot, quint64 to_slot) override; + Q_INVOKABLE QString get_transaction(const QString& tx_hash_hex) override; // Cryptarchia Q_INVOKABLE QString get_cryptarchia_info() override; signals: - void eventResponse(const QString& eventName, const QVariantList& data); + void eventResponse(const QString& event_name, const QVariantList& data); private: LogosBlockchainNode* node = nullptr; @@ -78,8 +78,8 @@ private: static LogosBlockchainModule* s_instance; // C-compatible callback function - static void onNewBlockCallback(const char* block); + static void on_new_block_callback(const char* block); // Helper method for emitting events - void emitEvent(const QString& eventName, const QVariantList& data); + void emit_event(const QString& event_name, const QVariantList& data); };