react-native-nitro-ark 0.0.38 → 0.0.40

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

@@ -0,0 +1,81 @@
+///
+/// OnchainBalanceResult.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 (OnchainBalanceResult).
+   */
+  struct OnchainBalanceResult {
+  public:
+    double immature     SWIFT_PRIVATE;
+    double trusted_pending     SWIFT_PRIVATE;
+    double untrusted_pending     SWIFT_PRIVATE;
+    double confirmed     SWIFT_PRIVATE;
+
+  public:
+    OnchainBalanceResult() = default;
+    explicit OnchainBalanceResult(double immature, double trusted_pending, double untrusted_pending, double confirmed): immature(immature), trusted_pending(trusted_pending), untrusted_pending(untrusted_pending), confirmed(confirmed) {}
+  };
+
+} // namespace margelo::nitro::nitroark
+
+namespace margelo::nitro {
+
+  using namespace margelo::nitro::nitroark;
+
+  // C++ OnchainBalanceResult <> JS OnchainBalanceResult (object)
+  template <>
+  struct JSIConverter<OnchainBalanceResult> final {
+    static inline OnchainBalanceResult fromJSI(jsi::Runtime& runtime, const jsi::Value& arg) {
+      jsi::Object obj = arg.asObject(runtime);
+      return OnchainBalanceResult(
+        JSIConverter<double>::fromJSI(runtime, obj.getProperty(runtime, "immature")),
+        JSIConverter<double>::fromJSI(runtime, obj.getProperty(runtime, "trusted_pending")),
+        JSIConverter<double>::fromJSI(runtime, obj.getProperty(runtime, "untrusted_pending")),
+        JSIConverter<double>::fromJSI(runtime, obj.getProperty(runtime, "confirmed"))
+      );
+    }
+    static inline jsi::Value toJSI(jsi::Runtime& runtime, const OnchainBalanceResult& arg) {
+      jsi::Object obj(runtime);
+      obj.setProperty(runtime, "immature", JSIConverter<double>::toJSI(runtime, arg.immature));
+      obj.setProperty(runtime, "trusted_pending", JSIConverter<double>::toJSI(runtime, arg.trusted_pending));
+      obj.setProperty(runtime, "untrusted_pending", JSIConverter<double>::toJSI(runtime, arg.untrusted_pending));
+      obj.setProperty(runtime, "confirmed", JSIConverter<double>::toJSI(runtime, arg.confirmed));
+      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, "immature"))) return false;
+      if (!JSIConverter<double>::canConvert(runtime, obj.getProperty(runtime, "trusted_pending"))) return false;
+      if (!JSIConverter<double>::canConvert(runtime, obj.getProperty(runtime, "untrusted_pending"))) return false;
+      if (!JSIConverter<double>::canConvert(runtime, obj.getProperty(runtime, "confirmed"))) return false;
+      return true;
+    }
+  };
+
+} // namespace margelo::nitro

package/package.json

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

package/src/NitroArk.nitro.ts

@@ -56,10 +56,10 @@ export interface ArkoorPaymentResult {
   payment_type: PaymentTypes; // 'Arkoor'
 }
 
-export interface Bolt11PaymentResult {
+export interface LightningPaymentResult {
   bolt11_invoice: string;
   preimage: string;
-  payment_type: PaymentTypes; // 'Bolt11'
+  payment_type: PaymentTypes; // 'Lightning'
 }
 
 export interface LnurlPaymentResult {
@@ -76,39 +76,73 @@ export interface OnchainPaymentResult {
   payment_type: PaymentTypes; // 'Onchain'
 }
 
+export interface OffchainBalanceResult {
+  spendable: number; // u64
+  pending_lightning_send: number; // u64
+  pending_exit: number; // u64
+}
+
+export interface OnchainBalanceResult {
+  // All coinbase outputs not yet matured
+  immature: number;
+  // Unconfirmed UTXOs generated by a wallet tx
+  trusted_pending: number;
+  // Unconfirmed UTXOs received from an external wallet
+  untrusted_pending: number;
+  // Confirmed and immediately spendable balance
+  confirmed: number;
+}
+
+export interface NewAddressResult {
+  user_pubkey: string;
+  ark_id: string;
+  address: string;
+}
+
 // --- Nitro Module Interface ---
 
 export interface NitroArk extends HybridObject<{ ios: 'c++'; android: 'c++' }> {
   // --- Management ---
   createMnemonic(): Promise<string>;
   loadWallet(datadir: string, opts: BarkCreateOpts): Promise<void>;
-  closeWallet(): Promise<void>;
   isWalletLoaded(): Promise<boolean>;
+  closeWallet(): Promise<void>;
   persistConfig(opts: BarkConfigOpts): Promise<void>;
   maintenance(): Promise<void>;
   sync(): Promise<void>;
-  syncArk(): Promise<void>;
+  syncExits(): Promise<void>;
   syncRounds(): Promise<void>;
 
   // --- Wallet Info ---
   getArkInfo(): Promise<BarkArkInfo>;
-  onchainBalance(): Promise<number>;
-  offchainBalance(): Promise<number>;
-  getOnchainAddress(): Promise<string>;
-  getOnchainUtxos(no_sync: boolean): Promise<string>; // Returns JSON string
-  getVtxoPubkey(index?: number): Promise<string>;
-  getVtxos(no_sync: boolean): Promise<string>; // Returns JSON string
+  offchainBalance(): Promise<OffchainBalanceResult>;
+  deriveStoreNextKeypair(): Promise<string>;
+  peakKeyPair(index: number): Promise<string>;
+  newAddress(): Promise<NewAddressResult>;
+  getVtxos(): Promise<BarkVtxo[]>; // Returns JSON string
 
   // --- Onchain Operations ---
-  sendOnchain(
+  onchainBalance(): Promise<OnchainBalanceResult>;
+  onchainSync(): Promise<void>;
+  onchainListUnspent(): Promise<string>; // Returns JSON string
+  onchainUtxos(): Promise<string>; // Returns JSON string
+  onchainAddress(): Promise<string>; // Returns address string
+  onchainSend(
     destination: string,
-    amountSat: number
-  ): Promise<OnchainPaymentResult>; // Returns txid
-  drainOnchain(destination: string, no_sync: boolean): Promise<string>; // Returns txid
-  sendManyOnchain(
+    amountSat: number,
+    feeRate?: number // Optional fee rate in sat/vB
+  ): Promise<OnchainPaymentResult>; // Returns txid and details
+  // Note: feeRate is optional, if not provided, default fee rate will be used
+  onchainDrain(
+    destination: string,
+    feeRate?: number // Optional fee rate in sat/vB
+  ): Promise<string>; // Returns txid
+  // Note: feeRate is optional, if not provided, default fee rate will be used
+  onchainSendMany(
     outputs: BarkSendManyOutput[],
-    no_sync: boolean
+    feeRate?: number // Optional fee rate in sat/vB
   ): Promise<string>; // Returns txid
+  // Note: feeRate is optional, if not provided, default fee rate will be used
 
   // --- Ark & Lightning Payments ---
   boardAmount(amountSat: number): Promise<string>; // Returns JSON status
@@ -117,24 +151,23 @@ export interface NitroArk extends HybridObject<{ ios: 'c++'; android: 'c++' }> {
     destination: string,
     amountSat: number
   ): Promise<ArkoorPaymentResult>;
-  sendBolt11Payment(
+  sendLightningPayment(
     destination: string,
     amountSat?: number
-  ): Promise<Bolt11PaymentResult>;
+  ): Promise<LightningPaymentResult>;
   sendLnaddr(
     addr: string,
     amountSat: number,
     comment: string
   ): Promise<LnurlPaymentResult>;
-  sendRoundOnchain(
+  sendRoundOnchainPayment(
     destination: string,
-    amountSat: number,
-    no_sync: boolean
+    amountSat: number
   ): Promise<string>; // Returns JSON status
 
   // --- Lightning Invoicing ---
   bolt11Invoice(amountMsat: number): Promise<string>; // Returns invoice string
-  claimBolt11Payment(bolt11: string): Promise<void>; // Throws on error
+  finishLightningReceive(bolt11: string): Promise<void>; // Throws on error
 
   // --- Offboarding / Exiting ---
   offboardSpecific(
@@ -142,7 +175,4 @@ export interface NitroArk extends HybridObject<{ ios: 'c++'; android: 'c++' }> {
     destinationAddress: string
   ): Promise<string>; // Returns JSON result
   offboardAll(destinationAddress: string): Promise<string>; // Returns JSON result
-  exitStartSpecific(vtxoIds: string[]): Promise<string>;
-  startExitForEntireWallet(): Promise<void>;
-  exitProgressOnce(): Promise<string>;
 }

package/src/index.tsx

@@ -6,9 +6,13 @@ import type {
   BarkArkInfo,
   BarkSendManyOutput,
   ArkoorPaymentResult,
-  Bolt11PaymentResult,
+  LightningPaymentResult,
   LnurlPaymentResult,
   OnchainPaymentResult,
+  BarkVtxo,
+  OffchainBalanceResult,
+  OnchainBalanceResult,
+  NewAddressResult,
 } from './NitroArk.nitro';
 
 // Create the hybrid object instance
@@ -81,11 +85,11 @@ export function sync(): Promise<void> {
 }
 
 /**
- * Synchronizes the Ark-specific parts of the wallet.
+ * Synchronizes the Ark-specific exits.
  * @returns A promise that resolves on success.
  */
-export function syncArk(): Promise<void> {
-  return NitroArkHybridObject.syncArk();
+export function syncExits(): Promise<void> {
+  return NitroArkHybridObject.syncExits();
 }
 
 /**
@@ -106,97 +110,121 @@ 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.
+ * @returns A promise resolving to the OffchainBalanceResult object.
  */
-export function offchainBalance(): Promise<number> {
+export function offchainBalance(): Promise<OffchainBalanceResult> {
   return NitroArkHybridObject.offchainBalance();
 }
 
 /**
- * Gets a fresh onchain address for the loaded wallet.
- * @returns A promise resolving to the Bitcoin address string.
+ * Derives the next keypair for the store.
+ * @returns A promise resolving to the hex-encoded public key string.
  */
-export function getOnchainAddress(): Promise<string> {
-  return NitroArkHybridObject.getOnchainAddress();
+export function deriveStoreNextKeypair(): Promise<string> {
+  return NitroArkHybridObject.deriveStoreNextKeypair();
 }
 
 /**
- * Gets the list of onchain UTXOs as a JSON string for the loaded wallet.
- * @param no_sync If true, skips synchronization with the blockchain. Defaults to false.
- * @returns A promise resolving to the JSON string of UTXOs.
+ * Gets the wallet's VTXO public key (hex string).
+ * @param index Index of the VTXO pubkey to retrieve.
+ * @returns A promise resolving to the hex-encoded public key string.
  */
-export function getOnchainUtxos(no_sync: boolean = false): Promise<string> {
-  return NitroArkHybridObject.getOnchainUtxos(no_sync);
+export function peakKeyPair(index: number): Promise<string> {
+  return NitroArkHybridObject.peakKeyPair(index);
 }
 
 /**
- * Gets the wallet's VTXO public key (hex string).
- * @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.
+ * Gets the wallet's Address.
+ * @returns A promise resolving to NewAddressResult object.
  */
-export function getVtxoPubkey(index?: number): Promise<string> {
-  return NitroArkHybridObject.getVtxoPubkey(index);
+export function newAddress(): Promise<NewAddressResult> {
+  return NitroArkHybridObject.newAddress();
 }
 
 /**
  * Gets the list of VTXOs as a JSON string for the loaded wallet.
  * @param no_sync If true, skips synchronization with the blockchain. Defaults to false.
- * @returns A promise resolving to the JSON string of VTXOs.
+ * @returns A promise resolving BarkVtxo[] array.
  */
-export function getVtxos(no_sync: boolean = false): Promise<string> {
-  return NitroArkHybridObject.getVtxos(no_sync);
+export function getVtxos(): Promise<BarkVtxo[]> {
+  return NitroArkHybridObject.getVtxos();
 }
 
 // --- Onchain Operations ---
 
+/**
+ * Gets the onchain balance for the loaded wallet.
+ * @returns A promise resolving to the OnchainBalanceResult object.
+ */
+export function onchainBalance(): Promise<OnchainBalanceResult> {
+  return NitroArkHybridObject.onchainBalance();
+}
+
+/**
+ * Synchronizes the onchain state of the wallet.
+ * @returns A promise that resolves on success.
+ */
+export function onchainSync(): Promise<void> {
+  return NitroArkHybridObject.onchainSync();
+}
+
+/**
+ * Gets the list of unspent onchain outputs as a JSON string for the loaded wallet.
+ * @returns A promise resolving to the JSON string of unspent outputs.
+ */
+export function onchainListUnspent(): Promise<string> {
+  return NitroArkHybridObject.onchainListUnspent();
+}
+
+/**
+ * Gets the list of onchain UTXOs as a JSON string for the loaded wallet.
+ * @returns A promise resolving to the JSON string of UTXOs.
+ */
+export function onchainUtxos(): Promise<string> {
+  return NitroArkHybridObject.onchainUtxos();
+}
+
+/**
+ * Gets a fresh onchain address for the loaded wallet.
+ * @returns A promise resolving to the Bitcoin address string.
+ */
+export function onchainAddress(): Promise<string> {
+  return NitroArkHybridObject.onchainAddress();
+}
+
 /**
  * Sends funds using the onchain wallet.
  * @param destination The destination Bitcoin address.
  * @param amountSat The amount to send in satoshis.
- * @param no_sync If true, skips synchronization with the blockchain. Defaults to false.
  * @returns A promise resolving to the OnchainPaymentResult object
  */
-export function sendOnchain(
+export function onchainSend(
   destination: string,
   amountSat: number
 ): Promise<OnchainPaymentResult> {
-  return NitroArkHybridObject.sendOnchain(destination, amountSat);
+  return NitroArkHybridObject.onchainSend(destination, amountSat);
 }
 
 /**
  * Sends all funds from the onchain wallet to a destination address.
  * @param destination The destination Bitcoin address.
- * @param no_sync If true, skips synchronization with the blockchain. Defaults to false.
  * @returns A promise resolving to the transaction ID string.
  */
-export function drainOnchain(
-  destination: string,
-  no_sync: boolean = false
-): Promise<string> {
-  return NitroArkHybridObject.drainOnchain(destination, no_sync);
+export function onchainDrain(destination: string): Promise<string> {
+  return NitroArkHybridObject.onchainDrain(destination);
 }
 
 /**
  * Sends funds to multiple recipients using the onchain wallet.
  * @param outputs An array of objects containing destination address and amountSat.
- * @param no_sync If true, skips synchronization with the blockchain. Defaults to false.
  * @returns A promise resolving to the transaction ID string.
  */
-export function sendManyOnchain(
-  outputs: BarkSendManyOutput[],
-  no_sync: boolean = false
+export function onchainSendMany(
+  outputs: BarkSendManyOutput[]
 ): Promise<string> {
-  return NitroArkHybridObject.sendManyOnchain(outputs, no_sync);
+  return NitroArkHybridObject.onchainSendMany(outputs);
 }
 
 // --- Lightning Operations ---
@@ -211,12 +239,40 @@ export function bolt11Invoice(amountMsat: number): Promise<string> {
 }
 
 /**
- * Claims a Bolt 11 payment.
- * @param bolt11 The Bolt 11 invoice string to claim.
+ * Claims a Lightning payment.
+ * @param bolt11 The Lightning invoice string to claim.
  * @returns A promise that resolves on success or rejects on error.
  */
-export function claimBolt11Payment(bolt11: string): Promise<void> {
-  return NitroArkHybridObject.claimBolt11Payment(bolt11);
+export function finishLightningReceive(bolt11: string): Promise<void> {
+  return NitroArkHybridObject.finishLightningReceive(bolt11);
+}
+
+/**
+ * Sends a Lightning payment.
+ * @param destination The Lightning invoice.
+ * @param amountSat The amount in satoshis to send. Use 0 for invoice amount.
+ * @returns A promise resolving to a LightningPaymentResult object
+ */
+export function sendLightningPayment(
+  destination: string,
+  amountSat?: number
+): Promise<LightningPaymentResult> {
+  return NitroArkHybridObject.sendLightningPayment(destination, amountSat);
+}
+
+/**
+ * Sends a payment to a Lightning Address.
+ * @param addr The Lightning Address.
+ * @param amountSat The amount in satoshis to send.
+ * @param comment An optional comment.
+ * @returns A promise resolving to a LnurlPaymentResult object
+ */
+export function sendLnaddr(
+  addr: string,
+  amountSat: number,
+  comment: string
+): Promise<LnurlPaymentResult> {
+  return NitroArkHybridObject.sendLnaddr(addr, amountSat, comment);
 }
 
 // --- Ark Operations ---
@@ -251,47 +307,17 @@ export function sendArkoorPayment(
   return NitroArkHybridObject.sendArkoorPayment(destination, amountSat);
 }
 
-/**
- * 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 Bolt11PaymentResult object
- */
-export function sendBolt11Payment(
-  destination: string,
-  amountSat?: number
-): Promise<Bolt11PaymentResult> {
-  return NitroArkHybridObject.sendBolt11Payment(destination, amountSat);
-}
-
-/**
- * Sends a payment to a Lightning Address.
- * @param addr The Lightning Address.
- * @param amountSat The amount in satoshis to send.
- * @param comment An optional comment.
- * @returns A promise resolving to a LnurlPaymentResult object
- */
-export function sendLnaddr(
-  addr: string,
-  amountSat: number,
-  comment: string
-): Promise<LnurlPaymentResult> {
-  return NitroArkHybridObject.sendLnaddr(addr, amountSat, comment);
-}
-
 /**
  * Sends an onchain payment via an Ark round.
  * @param destination The destination Bitcoin address.
  * @param amountSat The amount in satoshis to send.
- * @param no_sync If true, skips synchronization with the wallet. Defaults to false.
  * @returns A promise resolving to a JSON status string.
  */
-export function sendRoundOnchain(
+export function sendRoundOnchainPayment(
   destination: string,
-  amountSat: number,
-  no_sync: boolean = false
+  amountSat: number
 ): Promise<string> {
-  return NitroArkHybridObject.sendRoundOnchain(destination, amountSat, no_sync);
+  return NitroArkHybridObject.sendRoundOnchainPayment(destination, amountSat);
 }
 
 // --- Offboarding / Exiting ---
@@ -320,31 +346,6 @@ export function offboardAll(destinationAddress: string): Promise<string> {
   return NitroArkHybridObject.offboardAll(destinationAddress);
 }
 
-/**
- * Starts the exit process for specific VTXOs.
- * @param vtxoIds Array of VtxoId strings to start exiting.
- * @returns A promise resolving to a JSON status string.
- */
-export function startExitForVtxos(vtxoIds: string[]): Promise<string> {
-  return NitroArkHybridObject.exitStartSpecific(vtxoIds);
-}
-
-/**
- * Starts the exit process for all VTXOs in the wallet.
- * @returns A promise that resolves or rejects.
- */
-export function startExitForEntireWallet(): Promise<void> {
-  return NitroArkHybridObject.startExitForEntireWallet();
-}
-
-/**
- * Progresses the exit process once and returns the current status.
- * @returns A promise resolving to a JSON status string.
- */
-export function exitProgressOnce(): Promise<string> {
-  return NitroArkHybridObject.exitProgressOnce();
-}
-
 // --- Re-export types and enums ---
 export type {
   NitroArk,
@@ -353,8 +354,11 @@ export type {
   BarkArkInfo,
   BarkSendManyOutput,
   ArkoorPaymentResult,
-  Bolt11PaymentResult,
+  LightningPaymentResult,
   LnurlPaymentResult,
   OnchainPaymentResult,
   PaymentTypes,
+  OffchainBalanceResult,
+  OnchainBalanceResult,
+  NewAddressResult,
 } from './NitroArk.nitro';