react-native-nitro-ark 0.0.93 → 0.0.95

package/src/index.tsx

@@ -12,7 +12,10 @@ import type {
   OnchainBalanceResult,
   NewAddressResult,
   KeyPairResult,
+  MailboxAuthorizationResult,
   LightningReceive,
+  BarkNotificationEvent as NitroBarkNotificationEvent,
+  BarkNotificationSubscription,
   BarkMovement as NitroBarkMovement,
   BarkMovementDestination as NitroBarkMovementDestination,
   BoardResult,
@@ -25,10 +28,10 @@ export type BarkVtxo = {
   exit_delta: number; // u16
   anchor_point: string;
   point: string;
-  state: 'Spendable' | 'Spent' | 'Locked' | 'unknown';
+  state: 'Spendable' | 'Spent' | 'Locked';
 };
 
-export type MovementStatus = 'pending' | 'finished' | 'failed' | 'cancelled';
+export type MovementStatus = 'pending' | 'successful' | 'failed' | 'cancelled';
 
 export type BarkMovementDestination = NitroBarkMovementDestination & {
   payment_method:
@@ -47,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');
@@ -215,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);
 }
 
 /**
@@ -228,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);
 }
 
 /**
@@ -307,6 +323,72 @@ export function verifyMessage(
   return NitroArkHybridObject.verifyMessage(message, signature, publicKey);
 }
 
+/**
+ * Gets the mailbox keypair for the loaded wallet.
+ * @returns A promise resolving to a KeyPairResult object.
+ */
+export function mailboxKeypair(): Promise<KeyPairResult> {
+  return NitroArkHybridObject.mailboxKeypair() as Promise<KeyPairResult>;
+}
+
+/**
+ * Gets a mailbox authorization for the loaded wallet.
+ * @param authorizationExpiry Unix timestamp (seconds) for when the authorization expires.
+ * @returns A promise resolving to a MailboxAuthorizationResult object.
+ */
+export function mailboxAuthorization(
+  authorizationExpiry: number
+): Promise<MailboxAuthorizationResult> {
+  return NitroArkHybridObject.mailboxAuthorization(
+    authorizationExpiry
+  ) 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.