react-native-nitro-ark 0.0.103 → 0.0.105

package/src/NitroArk.nitro.ts

@@ -76,6 +76,13 @@ export interface ArkoorPaymentResult {
   vtxos: BarkVtxo[];
 }
 
+export interface BarkFeeEstimate {
+  gross_amount_sat: number; // u64
+  fee_sat: number; // u64
+  net_amount_sat: number; // u64
+  vtxos_spent: string[];
+}
+
 export interface ExitProgressStatusResult {
   vtxo_id: string;
   state: string;
@@ -92,6 +99,22 @@ export interface ExitVtxoResult {
   is_initialized: boolean;
 }
 
+export interface ExitTransactionPackageResult {
+  exit_txid: string;
+  exit_tx_hex: string;
+  child_txid: string;
+  child_tx_hex: string;
+  child_origin: string;
+  has_child: boolean;
+}
+
+export interface ExitStatusResult {
+  vtxo_id: string;
+  state: string;
+  history: string[];
+  transactions: ExitTransactionPackageResult[];
+}
+
 export interface LightningSendResult {
   invoice: string;
   payment_hash: string;
@@ -210,9 +233,17 @@ export interface NitroArk extends HybridObject<{ ios: 'c++'; android: 'c++' }> {
   maintenanceRefresh(): Promise<void>;
   sync(): Promise<void>;
   startExitForEntireWallet(): Promise<void>;
+  startExitForVtxos(vtxoIds: string[]): Promise<void>;
   syncExit(): Promise<void>;
+  syncNoProgress(): Promise<void>;
   progressExits(feeRateSatPerKvb?: number): Promise<ExitProgressStatusResult[]>;
   getExitVtxos(): Promise<ExitVtxoResult[]>;
+  listClaimable(): Promise<ExitVtxoResult[]>;
+  getExitStatus(
+    vtxoId: string,
+    includeHistory?: boolean,
+    includeTransactions?: boolean
+  ): Promise<ExitStatusResult | undefined>;
   hasPendingExits(): Promise<boolean>;
   pendingExitTotal(): Promise<number>;
   allClaimableAtHeight(): Promise<number | undefined>;
@@ -300,6 +331,7 @@ export interface NitroArk extends HybridObject<{ ios: 'c++'; android: 'c++' }> {
     destination: string,
     amountSat: number
   ): Promise<ArkoorPaymentResult>;
+  estimateArkoorPaymentFee(amountSat: number): Promise<BarkFeeEstimate>;
   payLightningInvoice(
     destination: string,
     amountSat?: number
@@ -313,7 +345,12 @@ export interface NitroArk extends HybridObject<{ ios: 'c++'; android: 'c++' }> {
     amountSat: number,
     comment: string
   ): Promise<LightningSendResult>;
+  estimateLightningSendFee(amountSat: number): Promise<BarkFeeEstimate>;
   sendOnchain(destination: string, amountSat: number): Promise<string>;
+  estimateSendOnchain(
+    destination: string,
+    amountSat: number
+  ): Promise<BarkFeeEstimate>;
 
   // --- Lightning Invoicing ---
   bolt11Invoice(
@@ -340,4 +377,5 @@ export interface NitroArk extends HybridObject<{ ios: 'c++'; android: 'c++' }> {
     destinationAddress: string
   ): Promise<string>;
   offboardAll(destinationAddress: string): Promise<string>;
+  estimateOffboardAll(destinationAddress: string): Promise<BarkFeeEstimate>;
 }

package/src/index.tsx

@@ -6,8 +6,11 @@ import type {
   Bolt11Invoice,
   BarkSendManyOutput,
   ArkoorPaymentResult,
+  BarkFeeEstimate,
   ExitProgressStatusResult as NitroExitProgressStatusResult,
   ExitVtxoResult as NitroExitVtxoResult,
+  ExitStatusResult as NitroExitStatusResult,
+  ExitTransactionPackageResult as NitroExitTransactionPackageResult,
   LightningSendResult,
   OnchainPaymentResult,
   OffchainBalanceResult,
@@ -57,6 +60,17 @@ export type ExitVtxoResult = Omit<NitroExitVtxoResult, 'state' | 'history'> & {
   history: ExitProgressState[];
 };
 
+export type ExitTransactionPackageResult = NitroExitTransactionPackageResult;
+
+export type ExitStatusResult = Omit<
+  NitroExitStatusResult,
+  'state' | 'history'
+> & {
+  state: ExitProgressState;
+  history: ExitProgressState[];
+  transactions: ExitTransactionPackageResult[];
+};
+
 export type BarkMovementDestination = NitroBarkMovementDestination & {
   payment_method:
     | 'ark'
@@ -220,6 +234,15 @@ export function startExitForEntireWallet(): Promise<void> {
   return NitroArkHybridObject.startExitForEntireWallet();
 }
 
+/**
+ * Starts unilateral exits for selected wallet VTXOs.
+ * @param vtxoIds VTXO IDs to exit.
+ * @returns A promise that resolves on success.
+ */
+export function startExitForVtxos(vtxoIds: string[]): Promise<void> {
+  return NitroArkHybridObject.startExitForVtxos(vtxoIds);
+}
+
 /**
  * Synchronizes the exit coordinator state.
  * @returns A promise that resolves on success.
@@ -228,6 +251,14 @@ export function syncExit(): Promise<void> {
   return NitroArkHybridObject.syncExit();
 }
 
+/**
+ * Synchronizes tracked exits without advancing their state.
+ * @returns A promise that resolves on success.
+ */
+export function syncNoProgress(): Promise<void> {
+  return NitroArkHybridObject.syncNoProgress();
+}
+
 /**
  * Progresses tracked exits by one step.
  * @param feeRateSatPerKvb Optional fee rate override in sat/kvB.
@@ -249,6 +280,33 @@ export function getExitVtxos(): Promise<ExitVtxoResult[]> {
   return NitroArkHybridObject.getExitVtxos() as Promise<ExitVtxoResult[]>;
 }
 
+/**
+ * Lists tracked unilateral exits that are claimable.
+ * @returns A promise resolving to claimable exit entries.
+ */
+export function listClaimable(): Promise<ExitVtxoResult[]> {
+  return NitroArkHybridObject.listClaimable() as Promise<ExitVtxoResult[]>;
+}
+
+/**
+ * Gets the detailed unilateral exit status for a tracked VTXO.
+ * @param vtxoId Exit VTXO ID to inspect.
+ * @param includeHistory Whether to include the state transition history.
+ * @param includeTransactions Whether to include exit transaction packages as hex.
+ * @returns A promise resolving to the exit status, or undefined when the VTXO is not tracked as an exit.
+ */
+export function getExitStatus(
+  vtxoId: string,
+  includeHistory?: boolean,
+  includeTransactions?: boolean
+): Promise<ExitStatusResult | undefined> {
+  return NitroArkHybridObject.getExitStatus(
+    vtxoId,
+    includeHistory,
+    includeTransactions
+  ) as Promise<ExitStatusResult | undefined>;
+}
+
 /**
  * Checks whether the wallet has exits that are still pending.
  * @returns A promise resolving to true when any tracked exit is not yet claimable.
@@ -723,6 +781,17 @@ export function payLightningAddress(
   return NitroArkHybridObject.payLightningAddress(addr, amountSat, comment);
 }
 
+/**
+ * Estimates the fee for a Lightning send.
+ * @param amountSat The amount in satoshis to send.
+ * @returns A promise resolving to the fee estimate.
+ */
+export function estimateLightningSendFee(
+  amountSat: number
+): Promise<BarkFeeEstimate> {
+  return NitroArkHybridObject.estimateLightningSendFee(amountSat);
+}
+
 // --- Ark Operations ---
 
 /**
@@ -764,6 +833,17 @@ export function sendArkoorPayment(
   return NitroArkHybridObject.sendArkoorPayment(destination, amountSat);
 }
 
+/**
+ * Estimates the fee for an Arkoor payment.
+ * @param amountSat The amount in satoshis to send.
+ * @returns A promise resolving to the fee estimate.
+ */
+export function estimateArkoorPaymentFee(
+  amountSat: number
+): Promise<BarkFeeEstimate> {
+  return NitroArkHybridObject.estimateArkoorPaymentFee(amountSat);
+}
+
 /**
  * Sends an onchain payment via an Ark round.
  * @param destination The destination Bitcoin address.
@@ -777,6 +857,19 @@ export function sendOnchain(
   return NitroArkHybridObject.sendOnchain(destination, amountSat);
 }
 
+/**
+ * Estimates the fee for sending an onchain payment via an Ark round.
+ * @param destination The destination Bitcoin address.
+ * @param amountSat The amount in satoshis to send.
+ * @returns A promise resolving to the fee estimate.
+ */
+export function estimateSendOnchain(
+  destination: string,
+  amountSat: number
+): Promise<BarkFeeEstimate> {
+  return NitroArkHybridObject.estimateSendOnchain(destination, amountSat);
+}
+
 // --- Offboarding / Exiting ---
 
 /**
@@ -801,6 +894,17 @@ export function offboardAll(destinationAddress: string): Promise<string> {
   return NitroArkHybridObject.offboardAll(destinationAddress);
 }
 
+/**
+ * Estimates the fee for offboarding all Ark funds to an onchain address.
+ * @param destinationAddress The destination Bitcoin address.
+ * @returns A promise resolving to the fee estimate.
+ */
+export function estimateOffboardAll(
+  destinationAddress: string
+): Promise<BarkFeeEstimate> {
+  return NitroArkHybridObject.estimateOffboardAll(destinationAddress);
+}
+
 // --- Re-export types and enums ---
 export type {
   NitroArk,
@@ -811,6 +915,7 @@ export type {
   BoardResult,
   BarkSendManyOutput,
   ArkoorPaymentResult,
+  BarkFeeEstimate,
   LightningSendResult,
   OnchainPaymentResult,
   OffchainBalanceResult,