react-native-nitro-ark 0.0.29 → 0.0.31

package/src/index.tsx

@@ -2,8 +2,8 @@ import { NitroModules } from 'react-native-nitro-modules';
 import type {
   NitroArk,
   BarkCreateOpts,
-  BarkBalance,
-  BarkRefreshOpts,
+  BarkConfigOpts,
+  BarkArkInfo,
   BarkSendManyOutput,
 } from './NitroArk.nitro';
 
@@ -51,15 +51,71 @@ export function isWalletLoaded(): Promise<boolean> {
   return NitroArkHybridObject.isWalletLoaded();
 }
 
+/**
+ * Persists wallet configuration.
+ * @param opts The configuration options to persist.
+ * @returns A promise that resolves on success or rejects on error.
+ */
+export function persistConfig(opts: BarkConfigOpts): Promise<void> {
+  return NitroArkHybridObject.persistConfig(opts);
+}
+
+/**
+ * Runs wallet maintenance tasks.
+ * @returns A promise that resolves on success.
+ */
+export function maintenance(): Promise<void> {
+  return NitroArkHybridObject.maintenance();
+}
+
+/**
+ * Synchronizes the wallet with the blockchain.
+ * @returns A promise that resolves on success.
+ */
+export function sync(): Promise<void> {
+  return NitroArkHybridObject.sync();
+}
+
+/**
+ * Synchronizes the Ark-specific parts of the wallet.
+ * @returns A promise that resolves on success.
+ */
+export function syncArk(): Promise<void> {
+  return NitroArkHybridObject.syncArk();
+}
+
+/**
+ * Synchronizes the rounds of the wallet.
+ * @returns A promise that resolves on success.
+ */
+export function syncRounds(): Promise<void> {
+  return NitroArkHybridObject.syncRounds();
+}
+
 // --- Wallet Info ---
 
 /**
- * Gets the onchain and offchain balances for the loaded wallet.
- * @param no_sync If true, skips synchronization with the blockchain. Defaults to false.
- * @returns A promise resolving to the BarkBalance object.
+ * Gets the Ark-specific information.
+ * @returns A promise resolving to the BarkArkInfo object.
  */
-export function getBalance(no_sync: boolean = false): Promise<BarkBalance> {
-  return NitroArkHybridObject.getBalance(no_sync);
+export function getArkInfo(): Promise<BarkArkInfo> {
+  return NitroArkHybridObject.getArkInfo();
+}
+
+/**
+ * Gets the onchain balance for the loaded wallet.
+ * @returns A promise resolving to the onchain balance in satoshis.
+ */
+export function onchainBalance(): Promise<number> {
+  return NitroArkHybridObject.onchainBalance();
+}
+
+/**
+ * Gets the offchain balance for the loaded wallet.
+ * @returns A promise resolving to the offchain balance in satoshis.
+ */
+export function offchainBalance(): Promise<number> {
+  return NitroArkHybridObject.offchainBalance();
 }
 
 /**
@@ -81,7 +137,7 @@ export function getOnchainUtxos(no_sync: boolean = false): Promise<string> {
 
 /**
  * Gets the wallet's VTXO public key (hex string).
- * @param index Optional index of the VTXO pubkey to retrieve.
+ * @param index Index of the VTXO pubkey to retrieve. Use u32::MAX for a new one.
  * @returns A promise resolving to the hex-encoded public key string.
  */
 export function getVtxoPubkey(index?: number): Promise<string> {
@@ -163,83 +219,61 @@ export function claimBolt11Payment(bolt11: string): Promise<void> {
 // --- Ark Operations ---
 
 /**
- * Refreshes VTXOs based on specified criteria for the loaded wallet.
- * @param refreshOpts Options specifying which VTXOs to refresh.
- * @param no_sync If true, skips synchronization with the blockchain. Defaults to false.
+ * Boards a specific amount from the onchain wallet into Ark.
+ * @param amountSat The amount in satoshis to board.
  * @returns A promise resolving to a JSON status string.
  */
-export function refreshVtxos(
-  refreshOpts: BarkRefreshOpts,
-  no_sync: boolean = false
-): Promise<string> {
-  if (!refreshOpts.mode_type) {
-    return Promise.reject(
-      new Error('refreshVtxos requires refreshOpts.mode_type')
-    );
-  }
-  if (
-    refreshOpts.mode_type === 'Specific' &&
-    (!refreshOpts.specific_vtxo_ids ||
-      refreshOpts.specific_vtxo_ids.length === 0)
-  ) {
-    return Promise.reject(
-      new Error(
-        "refreshVtxos with mode_type 'Specific' requires non-empty specific_vtxo_ids array"
-      )
-    );
-  }
-  if (
-    (refreshOpts.mode_type === 'ThresholdBlocks' ||
-      refreshOpts.mode_type === 'ThresholdHours') &&
-    (refreshOpts.threshold_value === undefined ||
-      refreshOpts.threshold_value <= 0)
-  ) {
-    return Promise.reject(
-      new Error(
-        `refreshVtxos with mode_type '${refreshOpts.mode_type}' requires a positive threshold_value`
-      )
-    );
-  }
-  return NitroArkHybridObject.refreshVtxos(refreshOpts, no_sync);
+export function boardAmount(amountSat: number): Promise<string> {
+  return NitroArkHybridObject.boardAmount(amountSat);
 }
 
 /**
- * Boards a specific amount from the onchain wallet into Ark.
- * @param amountSat The amount in satoshis to board.
- * @param no_sync If true, skips synchronization with the onchain wallet. Defaults to false.
+ * Boards all available funds from the onchain wallet into Ark.
  * @returns A promise resolving to a JSON status string.
  */
-export function boardAmount(
-  amountSat: number,
-  no_sync: boolean = false
+export function boardAll(): Promise<string> {
+  return NitroArkHybridObject.boardAll();
+}
+
+/**
+ * Sends an Arkoor payment.
+ * @param destination The destination Arkoor address.
+ * @param amountSat The amount in satoshis to send.
+ * @returns A promise resolving to a result string.
+ */
+export function sendArkoorPayment(
+  destination: string,
+  amountSat: number
 ): Promise<string> {
-  return NitroArkHybridObject.boardAmount(amountSat, no_sync);
+  return NitroArkHybridObject.sendArkoorPayment(destination, amountSat);
 }
 
 /**
- * Boards all available funds from the onchain wallet into Ark.
- * @param no_sync If true, skips synchronization with the onchain wallet. Defaults to false.
- * @returns A promise resolving to a JSON status string.
+ * Sends a Bolt11 payment.
+ * @param destination The Bolt11 invoice.
+ * @param amountSat The amount in satoshis to send. Use 0 for invoice amount.
+ * @returns A promise resolving to a result string.
  */
-export function boardAll(no_sync: boolean = false): Promise<string> {
-  return NitroArkHybridObject.boardAll(no_sync);
+export function sendBolt11Payment(
+  destination: string,
+  amountSat?: number
+): Promise<string> {
+  return NitroArkHybridObject.sendBolt11Payment(destination, amountSat);
 }
 
 /**
- * Sends funds offchain using Ark VTXOs.
- * @param destination Ark address (VTXO pubkey) or onchain Bitcoin address.
+ * Sends a payment to a Lightning Address.
+ * @param addr The Lightning Address.
  * @param amountSat The amount in satoshis to send.
- * @param comment Optional comment.
- * @param no_sync If true, skips synchronization with the wallet. Defaults to false.
- * @returns A promise resolving to a JSON status string.
+ * @param comment An optional comment.
+ * @returns A promise resolving to a result string.
  */
-export function send(
-  destination: string,
-  amountSat: number | null,
-  comment: string | null = null,
-  no_sync: boolean = false
+export function sendLnaddr(
+  addr: string,
+  amountSat: number,
+  comment: string
 ): Promise<string> {
-  return NitroArkHybridObject.send(destination, amountSat, comment, no_sync);
+  return NitroArkHybridObject.sendLnaddr(addr, amountSat, comment);
 }
 
 /**
@@ -260,35 +294,35 @@ export function sendRoundOnchain(
 // --- Offboarding / Exiting ---
 
 /**
- * Offboards specific VTXOs to an optional onchain address.
+ * Offboards specific VTXOs to a destination address.
  * @param vtxoIds Array of VtxoId strings to offboard.
- * @param optionalAddress Optional destination Bitcoin address (null if sending to internal wallet).
+ * @param destinationAddress Destination Bitcoin address (if empty, sends to internal wallet).
  * @param no_sync If true, skips synchronization with the wallet. Defaults to false.
  * @returns A promise resolving to a JSON result string.
  */
 export function offboardSpecific(
   vtxoIds: string[],
-  optionalAddress: string | null = null,
+  destinationAddress: string,
   no_sync: boolean = false
 ): Promise<string> {
   return NitroArkHybridObject.offboardSpecific(
     vtxoIds,
-    optionalAddress,
+    destinationAddress,
     no_sync
   );
 }
 
 /**
- * Offboards all VTXOs to an optional onchain address.
- * @param optionalAddress Optional destination Bitcoin address (null if sending to internal wallet).
+ * Offboards all VTXOs to a destination address.
+ * @param destinationAddress Destination Bitcoin address (if empty, sends to internal wallet).
  * @param no_sync If true, skips synchronization with the wallet. Defaults to false.
  * @returns A promise resolving to a JSON result string.
  */
 export function offboardAll(
-  optionalAddress: string | null = null,
+  destinationAddress: string,
   no_sync: boolean = false
 ): Promise<string> {
-  return NitroArkHybridObject.offboardAll(optionalAddress, no_sync);
+  return NitroArkHybridObject.offboardAll(destinationAddress, no_sync);
 }
 
 /**
@@ -296,7 +330,7 @@ export function offboardAll(
  * @param vtxoIds Array of VtxoId strings to start exiting.
  * @returns A promise resolving to a JSON status string.
  */
-export function exitStartSpecific(vtxoIds: string[]): Promise<string> {
+export function startExitForVtxos(vtxoIds: string[]): Promise<string> {
   return NitroArkHybridObject.exitStartSpecific(vtxoIds);
 }
 
@@ -304,7 +338,7 @@ export function exitStartSpecific(vtxoIds: string[]): Promise<string> {
  * Starts the exit process for all VTXOs in the wallet.
  * @returns A promise resolving to a JSON status string.
  */
-export function exitStartAll(): Promise<string> {
+export function startExitForEntireWallet(): Promise<string> {
   return NitroArkHybridObject.exitStartAll();
 }
 
@@ -318,10 +352,9 @@ export function exitProgressOnce(): Promise<string> {
 
 // --- Re-export types and enums ---
 export type {
+  NitroArk,
   BarkCreateOpts,
   BarkConfigOpts,
-  BarkBalance,
-  BarkRefreshOpts,
-  BarkRefreshModeType,
+  BarkArkInfo,
   BarkSendManyOutput,
 } from './NitroArk.nitro';

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

@@ -1,77 +0,0 @@
-///
-/// BarkBalance.hpp
-/// This file was generated by nitrogen. DO NOT MODIFY THIS FILE.
-/// https://github.com/mrousavy/nitro
-/// Copyright © 2025 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
-
-
-
-
-
-namespace margelo::nitro::nitroark {
-
-  /**
-   * A struct which can be represented as a JavaScript object (BarkBalance).
-   */
-  struct BarkBalance {
-  public:
-    double onchain     SWIFT_PRIVATE;
-    double offchain     SWIFT_PRIVATE;
-    double pending_exit     SWIFT_PRIVATE;
-
-  public:
-    BarkBalance() = default;
-    explicit BarkBalance(double onchain, double offchain, double pending_exit): onchain(onchain), offchain(offchain), pending_exit(pending_exit) {}
-  };
-
-} // namespace margelo::nitro::nitroark
-
-namespace margelo::nitro {
-
-  using namespace margelo::nitro::nitroark;
-
-  // C++ BarkBalance <> JS BarkBalance (object)
-  template <>
-  struct JSIConverter<BarkBalance> final {
-    static inline BarkBalance fromJSI(jsi::Runtime& runtime, const jsi::Value& arg) {
-      jsi::Object obj = arg.asObject(runtime);
-      return BarkBalance(
-        JSIConverter<double>::fromJSI(runtime, obj.getProperty(runtime, "onchain")),
-        JSIConverter<double>::fromJSI(runtime, obj.getProperty(runtime, "offchain")),
-        JSIConverter<double>::fromJSI(runtime, obj.getProperty(runtime, "pending_exit"))
-      );
-    }
-    static inline jsi::Value toJSI(jsi::Runtime& runtime, const BarkBalance& arg) {
-      jsi::Object obj(runtime);
-      obj.setProperty(runtime, "onchain", JSIConverter<double>::toJSI(runtime, arg.onchain));
-      obj.setProperty(runtime, "offchain", JSIConverter<double>::toJSI(runtime, arg.offchain));
-      obj.setProperty(runtime, "pending_exit", JSIConverter<double>::toJSI(runtime, arg.pending_exit));
-      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 (!JSIConverter<double>::canConvert(runtime, obj.getProperty(runtime, "onchain"))) return false;
-      if (!JSIConverter<double>::canConvert(runtime, obj.getProperty(runtime, "offchain"))) return false;
-      if (!JSIConverter<double>::canConvert(runtime, obj.getProperty(runtime, "pending_exit"))) return false;
-      return true;
-    }
-  };
-
-} // namespace margelo::nitro

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

@@ -1,94 +0,0 @@
-///
-/// BarkRefreshModeType.hpp
-/// This file was generated by nitrogen. DO NOT MODIFY THIS FILE.
-/// https://github.com/mrousavy/nitro
-/// Copyright © 2025 Marc Rousavy @ Margelo
-///
-
-#pragma once
-
-#if __has_include(<NitroModules/NitroHash.hpp>)
-#include <NitroModules/NitroHash.hpp>
-#else
-#error NitroModules cannot be found! Are you sure you installed NitroModules properly?
-#endif
-#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
-
-namespace margelo::nitro::nitroark {
-
-  /**
-   * An enum which can be represented as a JavaScript union (BarkRefreshModeType).
-   */
-  enum class BarkRefreshModeType {
-    DEFAULTTHRESHOLD      SWIFT_NAME(defaultthreshold) = 0,
-    THRESHOLDBLOCKS      SWIFT_NAME(thresholdblocks) = 1,
-    THRESHOLDHOURS      SWIFT_NAME(thresholdhours) = 2,
-    COUNTERPARTY      SWIFT_NAME(counterparty) = 3,
-    ALL      SWIFT_NAME(all) = 4,
-    SPECIFIC      SWIFT_NAME(specific) = 5,
-  } CLOSED_ENUM;
-
-} // namespace margelo::nitro::nitroark
-
-namespace margelo::nitro {
-
-  using namespace margelo::nitro::nitroark;
-
-  // C++ BarkRefreshModeType <> JS BarkRefreshModeType (union)
-  template <>
-  struct JSIConverter<BarkRefreshModeType> final {
-    static inline BarkRefreshModeType fromJSI(jsi::Runtime& runtime, const jsi::Value& arg) {
-      std::string unionValue = JSIConverter<std::string>::fromJSI(runtime, arg);
-      switch (hashString(unionValue.c_str(), unionValue.size())) {
-        case hashString("DefaultThreshold"): return BarkRefreshModeType::DEFAULTTHRESHOLD;
-        case hashString("ThresholdBlocks"): return BarkRefreshModeType::THRESHOLDBLOCKS;
-        case hashString("ThresholdHours"): return BarkRefreshModeType::THRESHOLDHOURS;
-        case hashString("Counterparty"): return BarkRefreshModeType::COUNTERPARTY;
-        case hashString("All"): return BarkRefreshModeType::ALL;
-        case hashString("Specific"): return BarkRefreshModeType::SPECIFIC;
-        default: [[unlikely]]
-          throw std::invalid_argument("Cannot convert \"" + unionValue + "\" to enum BarkRefreshModeType - invalid value!");
-      }
-    }
-    static inline jsi::Value toJSI(jsi::Runtime& runtime, BarkRefreshModeType arg) {
-      switch (arg) {
-        case BarkRefreshModeType::DEFAULTTHRESHOLD: return JSIConverter<std::string>::toJSI(runtime, "DefaultThreshold");
-        case BarkRefreshModeType::THRESHOLDBLOCKS: return JSIConverter<std::string>::toJSI(runtime, "ThresholdBlocks");
-        case BarkRefreshModeType::THRESHOLDHOURS: return JSIConverter<std::string>::toJSI(runtime, "ThresholdHours");
-        case BarkRefreshModeType::COUNTERPARTY: return JSIConverter<std::string>::toJSI(runtime, "Counterparty");
-        case BarkRefreshModeType::ALL: return JSIConverter<std::string>::toJSI(runtime, "All");
-        case BarkRefreshModeType::SPECIFIC: return JSIConverter<std::string>::toJSI(runtime, "Specific");
-        default: [[unlikely]]
-          throw std::invalid_argument("Cannot convert BarkRefreshModeType to JS - invalid value: "
-                                    + std::to_string(static_cast<int>(arg)) + "!");
-      }
-    }
-    static inline bool canConvert(jsi::Runtime& runtime, const jsi::Value& value) {
-      if (!value.isString()) {
-        return false;
-      }
-      std::string unionValue = JSIConverter<std::string>::fromJSI(runtime, value);
-      switch (hashString(unionValue.c_str(), unionValue.size())) {
-        case hashString("DefaultThreshold"):
-        case hashString("ThresholdBlocks"):
-        case hashString("ThresholdHours"):
-        case hashString("Counterparty"):
-        case hashString("All"):
-        case hashString("Specific"):
-          return true;
-        default:
-          return false;
-      }
-    }
-  };
-
-} // namespace margelo::nitro

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

@@ -1,81 +0,0 @@
-///
-/// BarkRefreshOpts.hpp
-/// This file was generated by nitrogen. DO NOT MODIFY THIS FILE.
-/// https://github.com/mrousavy/nitro
-/// Copyright © 2025 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
-
-// Forward declaration of `BarkRefreshModeType` to properly resolve imports.
-namespace margelo::nitro::nitroark { enum class BarkRefreshModeType; }
-
-#include "BarkRefreshModeType.hpp"
-#include <optional>
-#include <vector>
-#include <string>
-
-namespace margelo::nitro::nitroark {
-
-  /**
-   * A struct which can be represented as a JavaScript object (BarkRefreshOpts).
-   */
-  struct BarkRefreshOpts {
-  public:
-    BarkRefreshModeType mode_type     SWIFT_PRIVATE;
-    std::optional<double> threshold_value     SWIFT_PRIVATE;
-    std::optional<std::vector<std::string>> specific_vtxo_ids     SWIFT_PRIVATE;
-
-  public:
-    BarkRefreshOpts() = default;
-    explicit BarkRefreshOpts(BarkRefreshModeType mode_type, std::optional<double> threshold_value, std::optional<std::vector<std::string>> specific_vtxo_ids): mode_type(mode_type), threshold_value(threshold_value), specific_vtxo_ids(specific_vtxo_ids) {}
-  };
-
-} // namespace margelo::nitro::nitroark
-
-namespace margelo::nitro {
-
-  using namespace margelo::nitro::nitroark;
-
-  // C++ BarkRefreshOpts <> JS BarkRefreshOpts (object)
-  template <>
-  struct JSIConverter<BarkRefreshOpts> final {
-    static inline BarkRefreshOpts fromJSI(jsi::Runtime& runtime, const jsi::Value& arg) {
-      jsi::Object obj = arg.asObject(runtime);
-      return BarkRefreshOpts(
-        JSIConverter<BarkRefreshModeType>::fromJSI(runtime, obj.getProperty(runtime, "mode_type")),
-        JSIConverter<std::optional<double>>::fromJSI(runtime, obj.getProperty(runtime, "threshold_value")),
-        JSIConverter<std::optional<std::vector<std::string>>>::fromJSI(runtime, obj.getProperty(runtime, "specific_vtxo_ids"))
-      );
-    }
-    static inline jsi::Value toJSI(jsi::Runtime& runtime, const BarkRefreshOpts& arg) {
-      jsi::Object obj(runtime);
-      obj.setProperty(runtime, "mode_type", JSIConverter<BarkRefreshModeType>::toJSI(runtime, arg.mode_type));
-      obj.setProperty(runtime, "threshold_value", JSIConverter<std::optional<double>>::toJSI(runtime, arg.threshold_value));
-      obj.setProperty(runtime, "specific_vtxo_ids", JSIConverter<std::optional<std::vector<std::string>>>::toJSI(runtime, arg.specific_vtxo_ids));
-      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 (!JSIConverter<BarkRefreshModeType>::canConvert(runtime, obj.getProperty(runtime, "mode_type"))) return false;
-      if (!JSIConverter<std::optional<double>>::canConvert(runtime, obj.getProperty(runtime, "threshold_value"))) return false;
-      if (!JSIConverter<std::optional<std::vector<std::string>>>::canConvert(runtime, obj.getProperty(runtime, "specific_vtxo_ids"))) return false;
-      return true;
-    }
-  };
-
-} // namespace margelo::nitro