@secondts/bark 0.10.0 → 0.11.0

package/bundler/bark_ffi_wasm.d.ts

@@ -67,6 +67,40 @@ export interface ExitTransactionStatus {
     transactionCount: number;
 }
 
+/**
+ * Optional arguments for [`Wallet::open`]
+ *
+ * Every field has a default, so callers only set what they need.
+ */
+export interface OpenWalletArgs {
+    /**
+     * Whether to run the background daemon
+     *
+     * When disabled, you must manually call `Wallet::sync` to sync the wallet.
+     *
+     * Default: true
+     */
+    runDaemon?: boolean;
+    /**
+     * Optional name for IndexedDb
+     *
+     * Default: name based on wallet fingerprint
+     */
+    indexedDbName?: string;
+    /**
+     * Whether to create a new wallet if no wallet exists
+     *
+     *  Default: true
+     */
+    createIfNotExists?: boolean;
+    /**
+     * Whether to create a new wallet even if the Ark server cannot be reached
+     *
+     * Default: false
+     */
+    createWithoutServer?: boolean;
+}
+
 /**
  * Parameters for creating a CPFP (Child Pays For Parent) transaction
  */
@@ -149,7 +183,7 @@ export interface Bolt11InvoiceArgs {
 
 export interface CheckLightningPaymentArgs {
     paymentHash: string;
-    wait: boolean;
+    wait?: boolean;
 }
 
 export interface Config {
@@ -160,7 +194,6 @@ export interface Config {
     bitcoindCookiefile?: string;
     bitcoindUser?: string;
     bitcoindPass?: string;
-    network: Network;
     vtxoRefreshExpiryThreshold?: number;
     vtxoExitMargin?: number;
     htlcRecvClaimDelta?: number;
@@ -170,6 +203,7 @@ export interface Config {
     offboardRequiredConfirmations?: number;
     daemonManualSync?: boolean;
     lightningReceiveClaimRetries?: number;
+    userAgent?: string;
 }
 
 export interface DrainExitsArgs {
@@ -260,6 +294,7 @@ export interface OnchainBalance {
 }
 
 export interface OnchainWalletDefaultArgs {
+    network: Network;
     mnemonic: string;
     config: Config;
     dbName: string;
@@ -268,13 +303,13 @@ export interface OnchainWalletDefaultArgs {
 export interface PayLightningInvoiceArgs {
     invoice: string;
     amountSats?: number;
-    wait: boolean;
+    wait?: boolean;
 }
 
 export interface PayLightningOfferArgs {
     offer: string;
     amountSats?: number;
-    wait: boolean;
+    wait?: boolean;
 }
 
 export interface PendingBoard {
@@ -288,12 +323,12 @@ export interface ProgressExitsArgs {
 }
 
 export interface TryClaimAllLightningReceivesArgs {
-    wait: boolean;
+    wait?: boolean;
 }
 
 export interface TryClaimLightningReceiveArgs {
     paymentHash: string;
-    wait: boolean;
+    wait?: boolean;
 }
 
 export interface Vtxo {
@@ -314,19 +349,6 @@ export interface Vtxo {
     exitTxWeightWu: number;
 }
 
-export interface WalletCreateArgs {
-    mnemonic: string;
-    config: Config;
-    dbName: string;
-    forceRescan: boolean;
-}
-
-export interface WalletOpenArgs {
-    mnemonic: string;
-    config: Config;
-    dbName: string;
-}
-
 export interface WalletProperties {
     network: Network;
     fingerprint: string;
@@ -427,9 +449,13 @@ export class Wallet {
     cancelPendingRound(roundId: number): Promise<void>;
     checkLightningPayment(args: CheckLightningPaymentArgs): Promise<LightningSendStatus>;
     claimableLightningReceiveBalanceSats(): Promise<number>;
-    config(): Promise<Config>;
-    static create(args: WalletCreateArgs): Promise<Wallet>;
-    static createWithOnchain(onchainWallet: OnchainWallet, args: WalletCreateArgs): Promise<Wallet>;
+    config(): Config;
+    /**
+     * Low-level function to initialize a wallet
+     *
+     * You probably want to use [`Wallet::open`] instead.
+     */
+    static create(network: Network, mnemonic_or_seed: string, config: Config, indexedDbName: string | null | undefined, createWithoutServer: boolean): Promise<void>;
     drainExits(args: DrainExitsArgs): Promise<ExitClaimTransaction>;
     estimateArkoorPaymentFee(amountSats: number): Promise<FeeEstimate>;
     estimateBoardFee(amountSats: number): Promise<FeeEstimate>;
@@ -462,7 +488,6 @@ export class Wallet {
     maintenanceRefresh(): Promise<string | undefined>;
     maintenanceWithOnchain(onchainWallet: OnchainWallet): Promise<void>;
     maintenanceWithOnchainDelegated(onchainWallet: OnchainWallet): Promise<void>;
-    maybeScheduleMaintenanceRefresh(): Promise<number | undefined>;
     network(): Promise<Network>;
     newAddress(): Promise<string>;
     newAddressWithIndex(): Promise<AddressWithIndex>;
@@ -470,8 +495,17 @@ export class Wallet {
     notifications(): NotificationHolder;
     offboardAll(bitcoinAddress: string): Promise<OffboardResult>;
     offboardVtxos(vtxoIds: string[], bitcoinAddress: string): Promise<string>;
-    static open(args: WalletOpenArgs): Promise<Wallet>;
-    static openWithOnchain(onchainWallet: OnchainWallet, args: WalletOpenArgs): Promise<Wallet>;
+    /**
+     * Open a wallet, mirroring [`bark::Wallet::open`]: a single entry point
+     * with everything optional. Set `createIfNotExists` to create the wallet
+     * if it doesn't exist yet (replacing the old `create` constructor).
+     *
+     * There is no separate `withOnchain` variant: onchain operations
+     * (boarding, exits, ...) take the onchain wallet per-call, and the web
+     * build has no background daemon, so the onchain wallet is never needed
+     * at open time.
+     */
+    static open(network: Network, mnemonic_or_seed: string, config: Config, onchain: OnchainWallet | null | undefined, args: OpenWalletArgs): Promise<Wallet>;
     payLightningInvoice(args: PayLightningInvoiceArgs): Promise<LightningSendStatus>;
     payLightningOffer(args: PayLightningOfferArgs): Promise<LightningSendStatus>;
     peekAddress(index: number): Promise<string>;
@@ -489,7 +523,7 @@ export class Wallet {
     refreshServer(): Promise<void>;
     refreshVtxos(vtxoIds: string[]): Promise<string | undefined>;
     refreshVtxosDelegated(vtxoIds: string[]): Promise<RoundState | undefined>;
-    sendArkoorPayment(arkAddress: string, amountSats: number): Promise<string>;
+    sendArkoorPayment(arkAddress: string, amountSats: number): Promise<void>;
     sendOnchain(address: string, amountSats: number): Promise<string>;
     signExitClaimInputs(psbtBase64: string): Promise<string>;
     spendableVtxos(): Promise<Vtxo[]>;
@@ -498,6 +532,12 @@ export class Wallet {
     stuckFailedLightningSends(): Promise<LightningSend[]>;
     sync(): Promise<void>;
     syncExits(onchainWallet: OnchainWallet): Promise<void>;
+    /**
+     * Scan for VTXOs that were force-exited on-chain without the user asking
+     * and route them into the unilateral-exit flow so the funds can be claimed.
+     * This already runs automatically as part of `sync`.
+     */
+    syncForceExitedVtxos(): Promise<void>;
     syncPendingBoards(): Promise<void>;
     tryClaimAllLightningReceives(args: TryClaimAllLightningReceivesArgs): Promise<LightningReceive[]>;
     tryClaimLightningReceive(args: TryClaimLightningReceiveArgs): Promise<void>;