@secondts/bark 0.6.3 → 0.8.0

package/bundler/bark_ffi_wasm.d.ts

@@ -94,6 +94,15 @@ export interface ExitProgressStatus {
     error: string | undefined;
 }
 
+/**
+ * Terminal/in-flight state of an outgoing lightning send.
+ *
+ * Mirrors `bark`\'s `LightningSendState`. `pay_lightning_*` and
+ * `check_lightning_payment` now return this so callers can drive the
+ * crash-safe send flow themselves (initiate with `wait = false`, then poll).
+ */
+export type LightningSendStatus = { type: "unknown" } | { type: "inProgress"; send: LightningSend } | { type: "paid"; payment_hash: string; preimage: string };
+
 export interface AddressWithIndex {
     address: string;
     index: number;
@@ -199,9 +208,23 @@ export interface LightningReceive {
 
 export interface LightningSend {
     invoice: string;
+    /**
+     * Amount being paid, in sats (`payment_amount`).
+     */
     amountSats: number;
+    /**
+     * Routing/ark fee for the send, in sats.
+     */
+    feeSats: number;
+    /**
+     * Number of input VTXOs locked into the in-flight HTLC.
+     */
     htlcVtxoCount: number;
-    preimage: string | undefined;
+    /**
+     * Whether the send is stuck in the revocation-failed state: the payment
+     * failed but revoking the HTLC also failed
+     */
+    hasFailedRevocation: boolean;
 }
 
 export interface Movement {
@@ -242,11 +265,13 @@ export interface OnchainWalletDefaultArgs {
 export interface PayLightningInvoiceArgs {
     invoice: string;
     amountSats?: number;
+    wait: boolean;
 }
 
 export interface PayLightningOfferArgs {
     offer: string;
     amountSats?: number;
+    wait: boolean;
 }
 
 export interface PendingBoard {
@@ -386,7 +411,9 @@ export class Wallet {
     [Symbol.dispose](): void;
     allExitsClaimableAtHeight(): Promise<number | undefined>;
     allVtxos(): Promise<Vtxo[]>;
+    allowLightningSendToExit(paymentHash: string): Promise<void>;
     arkInfo(): Promise<ArkInfo | undefined>;
+    attemptLightningReceiveExit(paymentHash: string): Promise<void>;
     balance(): Promise<Balance>;
     boardAll(onchainWallet: OnchainWallet): Promise<PendingBoard>;
     boardAmount(onchainWallet: OnchainWallet, amountSats: number): Promise<PendingBoard>;
@@ -395,7 +422,7 @@ export class Wallet {
     cancelAllPendingRounds(): Promise<void>;
     cancelLightningReceive(paymentHash: string): Promise<void>;
     cancelPendingRound(roundId: number): Promise<void>;
-    checkLightningPayment(args: CheckLightningPaymentArgs): Promise<string | undefined>;
+    checkLightningPayment(args: CheckLightningPaymentArgs): Promise<LightningSendStatus>;
     claimableLightningReceiveBalanceSats(): Promise<number>;
     config(): Promise<Config>;
     static create(args: WalletCreateArgs): Promise<Wallet>;
@@ -421,7 +448,9 @@ export class Wallet {
     history(): Promise<Movement[]>;
     historyByPaymentMethod(paymentMethodType: string, paymentMethodValue: string): Promise<Movement[]>;
     importVtxo(vtxoBase64: string): Promise<void>;
+    isInvoicePaid(paymentHash: string): Promise<boolean>;
     lightningReceiveStatus(paymentHash: string): Promise<LightningReceive | undefined>;
+    lightningSendState(paymentHash: string): Promise<LightningSendStatus>;
     listClaimableExits(): Promise<ExitVtxo[]>;
     mailboxAuthorization(): string;
     mailboxIdentifier(): string;
@@ -440,8 +469,8 @@ export class Wallet {
     offboardVtxos(vtxoIds: string[], bitcoinAddress: string): Promise<string>;
     static open(args: WalletOpenArgs): Promise<Wallet>;
     static openWithOnchain(onchainWallet: OnchainWallet, args: WalletOpenArgs): Promise<Wallet>;
-    payLightningInvoice(args: PayLightningInvoiceArgs): Promise<LightningSend>;
-    payLightningOffer(args: PayLightningOfferArgs): Promise<LightningSend>;
+    payLightningInvoice(args: PayLightningInvoiceArgs): Promise<LightningSendStatus>;
+    payLightningOffer(args: PayLightningOfferArgs): Promise<LightningSendStatus>;
     peekAddress(index: number): Promise<string>;
     pendingBoardVtxos(): Promise<Vtxo[]>;
     pendingBoards(): Promise<PendingBoard[]>;
@@ -463,6 +492,7 @@ export class Wallet {
     spendableVtxos(): Promise<Vtxo[]>;
     startExitForEntireWallet(): Promise<void>;
     startExitForVtxos(vtxoIds: string[]): Promise<void>;
+    stuckFailedLightningSends(): Promise<LightningSend[]>;
     sync(): Promise<void>;
     syncExits(onchainWallet: OnchainWallet): Promise<void>;
     syncPendingBoards(): Promise<void>;