react-native-nitro-ark 0.0.94 → 0.0.95

package/nitrogen/generated/shared/c++/BarkNotificationEvent.hpp

@@ -0,0 +1,90 @@
+///
+/// BarkNotificationEvent.hpp
+/// This file was generated by nitrogen. DO NOT MODIFY THIS FILE.
+/// https://github.com/mrousavy/nitro
+/// Copyright © Marc Rousavy @ Margelo
+///
+
+#pragma once
+
+#if __has_include(<NitroModules/JSIConverter.hpp>)
+#include <NitroModules/JSIConverter.hpp>
+#else
+#error NitroModules cannot be found! Are you sure you installed NitroModules properly?
+#endif
+#if __has_include(<NitroModules/NitroDefines.hpp>)
+#include <NitroModules/NitroDefines.hpp>
+#else
+#error NitroModules cannot be found! Are you sure you installed NitroModules properly?
+#endif
+#if __has_include(<NitroModules/JSIHelpers.hpp>)
+#include <NitroModules/JSIHelpers.hpp>
+#else
+#error NitroModules cannot be found! Are you sure you installed NitroModules properly?
+#endif
+#if __has_include(<NitroModules/PropNameIDCache.hpp>)
+#include <NitroModules/PropNameIDCache.hpp>
+#else
+#error NitroModules cannot be found! Are you sure you installed NitroModules properly?
+#endif
+
+// Forward declaration of `BarkMovement` to properly resolve imports.
+namespace margelo::nitro::nitroark { struct BarkMovement; }
+
+#include <string>
+#include "BarkMovement.hpp"
+#include <optional>
+
+namespace margelo::nitro::nitroark {
+
+  /**
+   * A struct which can be represented as a JavaScript object (BarkNotificationEvent).
+   */
+  struct BarkNotificationEvent final {
+  public:
+    std::string kind     SWIFT_PRIVATE;
+    std::optional<BarkMovement> movement     SWIFT_PRIVATE;
+
+  public:
+    BarkNotificationEvent() = default;
+    explicit BarkNotificationEvent(std::string kind, std::optional<BarkMovement> movement): kind(kind), movement(movement) {}
+
+  public:
+    friend bool operator==(const BarkNotificationEvent& lhs, const BarkNotificationEvent& rhs) = default;
+  };
+
+} // namespace margelo::nitro::nitroark
+
+namespace margelo::nitro {
+
+  // C++ BarkNotificationEvent <> JS BarkNotificationEvent (object)
+  template <>
+  struct JSIConverter<margelo::nitro::nitroark::BarkNotificationEvent> final {
+    static inline margelo::nitro::nitroark::BarkNotificationEvent fromJSI(jsi::Runtime& runtime, const jsi::Value& arg) {
+      jsi::Object obj = arg.asObject(runtime);
+      return margelo::nitro::nitroark::BarkNotificationEvent(
+        JSIConverter<std::string>::fromJSI(runtime, obj.getProperty(runtime, PropNameIDCache::get(runtime, "kind"))),
+        JSIConverter<std::optional<margelo::nitro::nitroark::BarkMovement>>::fromJSI(runtime, obj.getProperty(runtime, PropNameIDCache::get(runtime, "movement")))
+      );
+    }
+    static inline jsi::Value toJSI(jsi::Runtime& runtime, const margelo::nitro::nitroark::BarkNotificationEvent& arg) {
+      jsi::Object obj(runtime);
+      obj.setProperty(runtime, PropNameIDCache::get(runtime, "kind"), JSIConverter<std::string>::toJSI(runtime, arg.kind));
+      obj.setProperty(runtime, PropNameIDCache::get(runtime, "movement"), JSIConverter<std::optional<margelo::nitro::nitroark::BarkMovement>>::toJSI(runtime, arg.movement));
+      return obj;
+    }
+    static inline bool canConvert(jsi::Runtime& runtime, const jsi::Value& value) {
+      if (!value.isObject()) {
+        return false;
+      }
+      jsi::Object obj = value.getObject(runtime);
+      if (!nitro::isPlainObject(runtime, obj)) {
+        return false;
+      }
+      if (!JSIConverter<std::string>::canConvert(runtime, obj.getProperty(runtime, PropNameIDCache::get(runtime, "kind")))) return false;
+      if (!JSIConverter<std::optional<margelo::nitro::nitroark::BarkMovement>>::canConvert(runtime, obj.getProperty(runtime, PropNameIDCache::get(runtime, "movement")))) return false;
+      return true;
+    }
+  };
+
+} // namespace margelo::nitro

package/nitrogen/generated/shared/c++/HybridBarkNotificationSubscriptionSpec.cpp

@@ -0,0 +1,22 @@
+///
+/// HybridBarkNotificationSubscriptionSpec.cpp
+/// This file was generated by nitrogen. DO NOT MODIFY THIS FILE.
+/// https://github.com/mrousavy/nitro
+/// Copyright © Marc Rousavy @ Margelo
+///
+
+#include "HybridBarkNotificationSubscriptionSpec.hpp"
+
+namespace margelo::nitro::nitroark {
+
+  void HybridBarkNotificationSubscriptionSpec::loadHybridMethods() {
+    // load base methods/properties
+    HybridObject::loadHybridMethods();
+    // load custom methods/properties
+    registerHybrids(this, [](Prototype& prototype) {
+      prototype.registerHybridMethod("stop", &HybridBarkNotificationSubscriptionSpec::stop);
+      prototype.registerHybridMethod("isActive", &HybridBarkNotificationSubscriptionSpec::isActive);
+    });
+  }
+
+} // namespace margelo::nitro::nitroark

package/nitrogen/generated/shared/c++/HybridBarkNotificationSubscriptionSpec.hpp

@@ -0,0 +1,63 @@
+///
+/// HybridBarkNotificationSubscriptionSpec.hpp
+/// This file was generated by nitrogen. DO NOT MODIFY THIS FILE.
+/// https://github.com/mrousavy/nitro
+/// Copyright © Marc Rousavy @ Margelo
+///
+
+#pragma once
+
+#if __has_include(<NitroModules/HybridObject.hpp>)
+#include <NitroModules/HybridObject.hpp>
+#else
+#error NitroModules cannot be found! Are you sure you installed NitroModules properly?
+#endif
+
+
+
+
+
+namespace margelo::nitro::nitroark {
+
+  using namespace margelo::nitro;
+
+  /**
+   * An abstract base class for `BarkNotificationSubscription`
+   * Inherit this class to create instances of `HybridBarkNotificationSubscriptionSpec` in C++.
+   * You must explicitly call `HybridObject`'s constructor yourself, because it is virtual.
+   * @example
+   * ```cpp
+   * class HybridBarkNotificationSubscription: public HybridBarkNotificationSubscriptionSpec {
+   * public:
+   *   HybridBarkNotificationSubscription(...): HybridObject(TAG) { ... }
+   *   // ...
+   * };
+   * ```
+   */
+  class HybridBarkNotificationSubscriptionSpec: public virtual HybridObject {
+    public:
+      // Constructor
+      explicit HybridBarkNotificationSubscriptionSpec(): HybridObject(TAG) { }
+
+      // Destructor
+      ~HybridBarkNotificationSubscriptionSpec() override = default;
+
+    public:
+      // Properties
+      
+
+    public:
+      // Methods
+      virtual void stop() = 0;
+      virtual bool isActive() = 0;
+
+    protected:
+      // Hybrid Setup
+      void loadHybridMethods() override;
+
+    protected:
+      // Tag for logging
+      static constexpr auto TAG = "BarkNotificationSubscription";
+  };
+
+} // namespace margelo::nitro::nitroark

package/nitrogen/generated/shared/c++/HybridNitroArkSpec.cpp

@@ -32,8 +32,8 @@ namespace margelo::nitro::nitroark {
       prototype.registerHybridMethod("getArkInfo", &HybridNitroArkSpec::getArkInfo);
       prototype.registerHybridMethod("offchainBalance", &HybridNitroArkSpec::offchainBalance);
       prototype.registerHybridMethod("deriveStoreNextKeypair", &HybridNitroArkSpec::deriveStoreNextKeypair);
-      prototype.registerHybridMethod("peakKeyPair", &HybridNitroArkSpec::peakKeyPair);
-      prototype.registerHybridMethod("peakAddress", &HybridNitroArkSpec::peakAddress);
+      prototype.registerHybridMethod("peekKeyPair", &HybridNitroArkSpec::peekKeyPair);
+      prototype.registerHybridMethod("peekAddress", &HybridNitroArkSpec::peekAddress);
       prototype.registerHybridMethod("newAddress", &HybridNitroArkSpec::newAddress);
       prototype.registerHybridMethod("signMessage", &HybridNitroArkSpec::signMessage);
       prototype.registerHybridMethod("signMesssageWithMnemonic", &HybridNitroArkSpec::signMesssageWithMnemonic);
@@ -41,6 +41,9 @@ namespace margelo::nitro::nitroark {
       prototype.registerHybridMethod("verifyMessage", &HybridNitroArkSpec::verifyMessage);
       prototype.registerHybridMethod("mailboxKeypair", &HybridNitroArkSpec::mailboxKeypair);
       prototype.registerHybridMethod("mailboxAuthorization", &HybridNitroArkSpec::mailboxAuthorization);
+      prototype.registerHybridMethod("subscribeNotifications", &HybridNitroArkSpec::subscribeNotifications);
+      prototype.registerHybridMethod("subscribeArkoorAddressMovements", &HybridNitroArkSpec::subscribeArkoorAddressMovements);
+      prototype.registerHybridMethod("subscribeLightningPaymentMovements", &HybridNitroArkSpec::subscribeLightningPaymentMovements);
       prototype.registerHybridMethod("history", &HybridNitroArkSpec::history);
       prototype.registerHybridMethod("vtxos", &HybridNitroArkSpec::vtxos);
       prototype.registerHybridMethod("getFirstExpiringVtxoBlockheight", &HybridNitroArkSpec::getFirstExpiringVtxoBlockheight);

package/nitrogen/generated/shared/c++/HybridNitroArkSpec.hpp

@@ -25,6 +25,10 @@ namespace margelo::nitro::nitroark { struct KeyPairResult; }
 namespace margelo::nitro::nitroark { struct NewAddressResult; }
 // Forward declaration of `MailboxAuthorizationResult` to properly resolve imports.
 namespace margelo::nitro::nitroark { struct MailboxAuthorizationResult; }
+// Forward declaration of `HybridBarkNotificationSubscriptionSpec` to properly resolve imports.
+namespace margelo::nitro::nitroark { class HybridBarkNotificationSubscriptionSpec; }
+// Forward declaration of `BarkNotificationEvent` to properly resolve imports.
+namespace margelo::nitro::nitroark { struct BarkNotificationEvent; }
 // Forward declaration of `BarkMovement` to properly resolve imports.
 namespace margelo::nitro::nitroark { struct BarkMovement; }
 // Forward declaration of `BarkVtxo` to properly resolve imports.
@@ -54,6 +58,10 @@ namespace margelo::nitro::nitroark { struct LightningReceive; }
 #include "KeyPairResult.hpp"
 #include "NewAddressResult.hpp"
 #include "MailboxAuthorizationResult.hpp"
+#include <memory>
+#include "HybridBarkNotificationSubscriptionSpec.hpp"
+#include "BarkNotificationEvent.hpp"
+#include <functional>
 #include "BarkMovement.hpp"
 #include <vector>
 #include "BarkVtxo.hpp"
@@ -118,8 +126,8 @@ namespace margelo::nitro::nitroark {
       virtual std::shared_ptr<Promise<BarkArkInfo>> getArkInfo() = 0;
       virtual std::shared_ptr<Promise<OffchainBalanceResult>> offchainBalance() = 0;
       virtual std::shared_ptr<Promise<KeyPairResult>> deriveStoreNextKeypair() = 0;
-      virtual std::shared_ptr<Promise<KeyPairResult>> peakKeyPair(double index) = 0;
-      virtual std::shared_ptr<Promise<NewAddressResult>> peakAddress(double index) = 0;
+      virtual std::shared_ptr<Promise<KeyPairResult>> peekKeyPair(double index) = 0;
+      virtual std::shared_ptr<Promise<NewAddressResult>> peekAddress(double index) = 0;
       virtual std::shared_ptr<Promise<NewAddressResult>> newAddress() = 0;
       virtual std::shared_ptr<Promise<std::string>> signMessage(const std::string& message, double index) = 0;
       virtual std::shared_ptr<Promise<std::string>> signMesssageWithMnemonic(const std::string& message, const std::string& mnemonic, const std::string& network, double index) = 0;
@@ -127,6 +135,9 @@ namespace margelo::nitro::nitroark {
       virtual std::shared_ptr<Promise<bool>> verifyMessage(const std::string& message, const std::string& signature, const std::string& publicKey) = 0;
       virtual std::shared_ptr<Promise<KeyPairResult>> mailboxKeypair() = 0;
       virtual std::shared_ptr<Promise<MailboxAuthorizationResult>> mailboxAuthorization(double authorizationExpiry) = 0;
+      virtual std::shared_ptr<HybridBarkNotificationSubscriptionSpec> subscribeNotifications(const std::function<void(const BarkNotificationEvent& /* event */)>& onEvent) = 0;
+      virtual std::shared_ptr<HybridBarkNotificationSubscriptionSpec> subscribeArkoorAddressMovements(const std::string& address, const std::function<void(const BarkNotificationEvent& /* event */)>& onEvent) = 0;
+      virtual std::shared_ptr<HybridBarkNotificationSubscriptionSpec> subscribeLightningPaymentMovements(const std::string& paymentHash, const std::function<void(const BarkNotificationEvent& /* event */)>& onEvent) = 0;
       virtual std::shared_ptr<Promise<std::vector<BarkMovement>>> history() = 0;
       virtual std::shared_ptr<Promise<std::vector<BarkVtxo>>> vtxos() = 0;
       virtual std::shared_ptr<Promise<std::optional<double>>> getFirstExpiringVtxoBlockheight() = 0;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-native-nitro-ark",
-  "version": "0.0.94",
+  "version": "0.0.95",
   "description": "Pure C++ Nitro Modules for Ark client",
   "source": "./src/index.tsx",
   "main": "./lib/module/index.js",

package/src/NitroArk.nitro.ts

@@ -164,6 +164,17 @@ export interface BarkMovement {
   completed_at?: string;
 }
 
+export interface BarkNotificationEvent {
+  kind: string; // 'movementCreated' | 'movementUpdated' | 'channelLagging'
+  movement?: BarkMovement;
+}
+
+export interface BarkNotificationSubscription
+  extends HybridObject<{ ios: 'c++'; android: 'c++' }> {
+  stop(): void;
+  isActive(): boolean;
+}
+
 // --- Nitro Module Interface ---
 
 export interface NitroArk extends HybridObject<{ ios: 'c++'; android: 'c++' }> {
@@ -188,8 +199,8 @@ export interface NitroArk extends HybridObject<{ ios: 'c++'; android: 'c++' }> {
   getArkInfo(): Promise<BarkArkInfo>;
   offchainBalance(): Promise<OffchainBalanceResult>;
   deriveStoreNextKeypair(): Promise<KeyPairResult>;
-  peakKeyPair(index: number): Promise<KeyPairResult>;
-  peakAddress(index: number): Promise<NewAddressResult>;
+  peekKeyPair(index: number): Promise<KeyPairResult>;
+  peekAddress(index: number): Promise<NewAddressResult>;
   newAddress(): Promise<NewAddressResult>;
   signMessage(message: string, index: number): Promise<string>;
   signMesssageWithMnemonic(
@@ -212,6 +223,17 @@ export interface NitroArk extends HybridObject<{ ios: 'c++'; android: 'c++' }> {
   mailboxAuthorization(
     authorizationExpiry: number
   ): Promise<MailboxAuthorizationResult>;
+  subscribeNotifications(
+    onEvent: (event: BarkNotificationEvent) => void
+  ): BarkNotificationSubscription;
+  subscribeArkoorAddressMovements(
+    address: string,
+    onEvent: (event: BarkNotificationEvent) => void
+  ): BarkNotificationSubscription;
+  subscribeLightningPaymentMovements(
+    paymentHash: string,
+    onEvent: (event: BarkNotificationEvent) => void
+  ): BarkNotificationSubscription;
   history(): Promise<BarkMovement[]>;
   vtxos(): Promise<BarkVtxo[]>;
   getFirstExpiringVtxoBlockheight(): Promise<number | undefined>;

package/src/index.tsx

@@ -14,6 +14,8 @@ import type {
   KeyPairResult,
   MailboxAuthorizationResult,
   LightningReceive,
+  BarkNotificationEvent as NitroBarkNotificationEvent,
+  BarkNotificationSubscription,
   BarkMovement as NitroBarkMovement,
   BarkMovementDestination as NitroBarkMovementDestination,
   BoardResult,
@@ -48,6 +50,19 @@ export type BarkMovement = NitroBarkMovement & {
   received_on: BarkMovementDestination[];
 };
 
+export type BarkNotificationKind =
+  | 'movementCreated'
+  | 'movementUpdated'
+  | 'channelLagging';
+
+export type BarkNotificationEvent = Omit<
+  NitroBarkNotificationEvent,
+  'kind' | 'movement'
+> & {
+  kind: BarkNotificationKind;
+  movement?: BarkMovement;
+};
+
 // Create the hybrid object instance
 export const NitroArkHybridObject =
   NitroModules.createHybridObject<NitroArk>('NitroArk');
@@ -216,12 +231,12 @@ export function deriveStoreNextKeypair(): Promise<KeyPairResult> {
 }
 
 /**
- * Gets the wallet's VTXO public key (hex string).
+ * Peeks the wallet's VTXO public key (hex string).
  * @param index Index of the VTXO pubkey to retrieve.
  * @returns A promise resolving to the KeyPairResult object.
  */
-export function peakKeyPair(index: number): Promise<KeyPairResult> {
-  return NitroArkHybridObject.peakKeyPair(index);
+export function peekKeyPair(index: number): Promise<KeyPairResult> {
+  return NitroArkHybridObject.peekKeyPair(index);
 }
 
 /**
@@ -229,8 +244,8 @@ export function peakKeyPair(index: number): Promise<KeyPairResult> {
  * @param index Index of the address to preview.
  * @returns A promise resolving to the NewAddressResult object.
  */
-export function peakAddress(index: number): Promise<NewAddressResult> {
-  return NitroArkHybridObject.peakAddress(index);
+export function peekAddress(index: number): Promise<NewAddressResult> {
+  return NitroArkHybridObject.peekAddress(index);
 }
 
 /**
@@ -329,6 +344,51 @@ export function mailboxAuthorization(
   ) as Promise<MailboxAuthorizationResult>;
 }
 
+/**
+ * Subscribes to all Bark wallet notifications.
+ * @param onEvent Callback invoked whenever a notification is emitted.
+ * @returns A subscription handle that can be stopped.
+ */
+export function subscribeNotifications(
+  onEvent: (event: BarkNotificationEvent) => void
+): BarkNotificationSubscription {
+  return NitroArkHybridObject.subscribeNotifications(
+    onEvent as (event: NitroBarkNotificationEvent) => void
+  );
+}
+
+/**
+ * Subscribes to notifications related to a specific Arkoor address.
+ * @param address Arkoor address to filter by.
+ * @param onEvent Callback invoked whenever a matching notification is emitted.
+ * @returns A subscription handle that can be stopped.
+ */
+export function subscribeArkoorAddressMovements(
+  address: string,
+  onEvent: (event: BarkNotificationEvent) => void
+): BarkNotificationSubscription {
+  return NitroArkHybridObject.subscribeArkoorAddressMovements(
+    address,
+    onEvent as (event: NitroBarkNotificationEvent) => void
+  );
+}
+
+/**
+ * Subscribes to notifications related to a specific Lightning payment hash.
+ * @param paymentHash Lightning payment hash to filter by.
+ * @param onEvent Callback invoked whenever a matching notification is emitted.
+ * @returns A subscription handle that can be stopped.
+ */
+export function subscribeLightningPaymentMovements(
+  paymentHash: string,
+  onEvent: (event: BarkNotificationEvent) => void
+): BarkNotificationSubscription {
+  return NitroArkHybridObject.subscribeLightningPaymentMovements(
+    paymentHash,
+    onEvent as (event: NitroBarkNotificationEvent) => void
+  );
+}
+
 /**
  * Gets a paginated list of wallet history (balance changes).
  * @returns A promise resolving to an array of BarkMovement objects.