@breeztech/breez-sdk-spark 0.19.0 → 0.20.0-dev1

package/web/breez_sdk_spark_wasm.d.ts

@@ -307,6 +307,14 @@ export interface PrfProvider {
      * device. Hosts gate UX on the result.
      */
     isSupported(): Promise<boolean>;
+
+    /**
+     * Optional. Whether the silent single-CTA flow works here (a
+     * no-credential sign-in fast-fails with no UI). Omit to be treated as
+     * unsupported (`false`); the built-in browser provider returns the
+     * WebAuthn immediate-mediation capability.
+     */
+    supportsImmediateMediation?(): Promise<boolean>;
 }
 
 /**
@@ -322,7 +330,9 @@ export interface DeriveSeedOptions {
     allowCredentials?: Uint8Array[];
     /**
      * Fast-fail when no local credential is available. On the web this maps
-     * to WebAuthn `mediation: 'immediate'`: `true` opts in where the browser
+     * to WebAuthn `uiMode: 'immediate'`, used only on the unpinned probe (a
+     * non-empty allowCredentials keeps the standard picker, since a pin means
+     * a credential is already known): `true` opts in where the browser
      * advertises support, `false` uses the standard picker. Unset uses the
      * provider default.
      */
@@ -372,6 +382,15 @@ export interface PasskeyProviderOptions {
     userDisplayName?: string;
 }
 
+/**
+ * Request shape for `PasskeyClient.connectWithPasskey`.
+ */
+export interface ConnectWithPasskeyRequest {
+    label?: string;
+    allowCredentials?: Uint8Array[];
+    excludeCredentials?: Uint8Array[];
+}
+
 /**
  * Request shape for `PasskeyClient.register`.
  */
@@ -389,6 +408,15 @@ export interface SignInRequest {
     preferImmediatelyAvailableCredentials?: boolean;
 }
 
+/**
+ * Response shape for `PasskeyClient.connectWithPasskey`.
+ */
+export interface ConnectWithPasskeyResponse {
+    wallet: Wallet;
+    credential?: PasskeyCredential;
+    labels: string[];
+}
+
 /**
  * Response shape for `PasskeyClient.register`.
  */
@@ -483,8 +511,10 @@ export interface BitcoinAddressDetails {
 
 export interface BitcoinChainService {
     getAddressUtxos(address: string): Promise<Utxo[]>;
+    getAddressTxos(address: string): Promise<Utxo[]>;
     getTransactionStatus(txid: string): Promise<TxStatus>;
     getTransactionHex(txid: string): Promise<string>;
+    getOutspend(txid: string, vout: number): Promise<Outspend>;
     broadcastTransaction(tx: string): Promise<void>;
     recommendedFees(): Promise<RecommendedFees>;
 }
@@ -690,6 +720,10 @@ export interface ConversionSide {
     fee: string;
 }
 
+export interface CpfpSigner {
+    signPsbt(psbtBytes: Uint8Array): Promise<Uint8Array>;
+}
+
 export interface CreateIssuerTokenRequest {
     name: string;
     ticker: string;
@@ -927,6 +961,7 @@ export interface ExternalSparkSigner {
     getStaticDepositPublicKey(index: number): Promise<PublicKeyBytes>;
     signAuthenticationChallenge(challenge: Uint8Array): Promise<EcdsaSignatureBytes>;
     signMessage(message: Uint8Array): Promise<EcdsaSignatureBytes>;
+    signLeafRefundSpend(leafId: ExternalTreeNodeId, sighash: Uint8Array): Promise<SchnorrSignatureBytes>;
     signFrost(jobs: ExternalFrostJob[]): Promise<ExternalFrostShareResult[]>;
     prepareTransfer(request: ExternalPrepareTransferRequest): Promise<ExternalPreparedTransfer>;
     prepareClaim(request: ExternalPrepareClaimRequest): Promise<ExternalPreparedClaim>;
@@ -1254,6 +1289,11 @@ export interface PaymentRequestSource {
     bip353Address?: string;
 }
 
+export interface PerBranchFunding {
+    leafId: string;
+    fundingSat: number;
+}
+
 export interface PrepareLnurlPayRequest {
     amount: bigint;
     comment?: string;
@@ -1291,6 +1331,24 @@ export interface PrepareSendPaymentResponse {
     feePolicy: FeePolicy;
 }
 
+export interface PrepareUnilateralExitRequest {
+    feeRateSatPerVbyte: number;
+    fundingKind: CpfpFundingKind;
+    destination: string;
+    selection: ExitLeafSelection;
+}
+
+export interface PrepareUnilateralExitResponse {
+    leaves: UnilateralExitLeaf[];
+    recoverableValueSat: number;
+    totalFeeSat: number;
+    fanoutFeeSat: number;
+    singleUtxoFundingSat: number;
+    perBranchFunding: PerBranchFunding[];
+    feeRateSatPerVbyte: number;
+    destination: string;
+}
+
 export interface ProvisionalPayment {
     paymentId: string;
     amount: bigint;
@@ -1366,6 +1424,12 @@ export interface RefundDepositResponse {
     txHex: string;
 }
 
+export interface RefundPendingConversionsResponse {
+    refunded: number;
+    skipped: number;
+    failed: number;
+}
+
 export interface RegisterLightningAddressRequest {
     username: string;
     description?: string;
@@ -1673,6 +1737,34 @@ export interface UnfreezeIssuerTokenResponse {
     impactedTokenAmount: bigint;
 }
 
+export interface UnilateralExitLeaf {
+    leafId: string;
+    value: number;
+}
+
+export interface UnilateralExitRequest {
+    prepared: PrepareUnilateralExitResponse;
+    fundingInputs: CpfpInput[];
+}
+
+export interface UnilateralExitResponse {
+    recoverableValueSat: number;
+    totalFeeSat: number;
+    leaves: UnilateralExitLeaf[];
+    transactions: UnilateralExitTransaction[];
+}
+
+export interface UnilateralExitTransaction {
+    kind: UnilateralExitTxKind;
+    nodeId?: string;
+    txid: string;
+    txHex: string;
+    cpfpTxHex?: string;
+    csvTimelockBlocks?: number;
+    dependsOn: string[];
+    status: ConfirmationStatus;
+}
+
 export interface UnregisterWebhookRequest {
     webhookId: string;
 }
@@ -1692,6 +1784,7 @@ export interface UpdateContactRequest {
 export interface UpdateUserSettingsRequest {
     sparkPrivateModeEnabled?: boolean;
     stableBalanceActiveLabel?: StableBalanceActiveLabel;
+    sparkMasterIdentityPublicKey?: SparkMasterIdentityPublicKey;
 }
 
 export interface UrlSuccessActionData {
@@ -1703,6 +1796,7 @@ export interface UrlSuccessActionData {
 export interface UserSettings {
     sparkPrivateModeEnabled: boolean;
     stableBalanceActiveLabel?: string;
+    sparkMasterIdentityPublicKey?: string;
 }
 
 export interface Utxo {
@@ -1736,6 +1830,8 @@ export type BuyBitcoinRequest = { type: "moonpay"; lockedAmountSat?: number; red
 
 export type ChainApiType = "esplora" | "mempoolSpace";
 
+export type ConfirmationStatus = "confirmed" | "unconfirmed" | "unverified";
+
 export type ConversionChain = { type: "spark" } | { type: "lightning" } | { type: "external"; name: string; chainId?: string };
 
 export type ConversionFilter = "ammRefundNeeded" | "orchestraPending" | "boltzPending";
@@ -1750,6 +1846,10 @@ export type ConversionStatus = "pending" | "completed" | "failed" | "refundNeede
 
 export type ConversionType = { type: "fromBitcoin" } | { type: "toBitcoin"; fromTokenIdentifier: string };
 
+export type CpfpFundingKind = { type: "p2wpkh" } | { type: "p2tr" } | { type: "custom"; scriptPubkeyHex: string; signedInputWeight: number };
+
+export type CpfpInput = { type: "p2wpkh"; txid: string; vout: number; value: number; pubkey: string } | { type: "p2tr"; txid: string; vout: number; value: number; pubkey: string } | { type: "custom"; txid: string; vout: number; value: number; scriptPubkeyHex: string; signedInputWeight: number };
+
 export type CrossChainAddressFamily = "evm" | "solana" | "tron";
 
 export type CrossChainFeeMode = "feesExcluded" | "feesIncluded";
@@ -1762,6 +1862,8 @@ export type CrossChainRouteFilter = { type: "send"; addressDetails: CrossChainAd
 
 export type DepositClaimError = { type: "maxDepositClaimFeeExceeded"; tx: string; vout: number; maxFee?: Fee; requiredFeeSats: number; requiredFeeRateSatPerVbyte: number } | { type: "missingUtxo"; tx: string; vout: number } | { type: "generic"; message: string };
 
+export type ExitLeafSelection = { type: "auto" } | { type: "specific"; leafIds: string[] };
+
 export type ExternalFrostDerivation = { type: "signingLeaf"; leafId: ExternalTreeNodeId } | { type: "staticDeposit"; index: number } | { type: "htlcPreimage" } | { type: "identity" };
 
 export type ExternalSparkInvoiceKind = "sats" | "tokens";
@@ -1786,6 +1888,8 @@ export type OptimizationMode = "full" | "singleRound";
 
 export type OptimizationOutcome = { type: "completed"; roundsExecuted: number } | { type: "inProgress" };
 
+export type Outspend = { type: "unspent" } | { type: "spent"; txid: string; vin: number; status: TxStatus };
+
 export type PaymentDetails = { type: "spark"; invoiceDetails?: SparkInvoicePaymentDetails; htlcDetails?: SparkHtlcDetails; conversionInfo?: ConversionInfo } | { type: "token"; metadata: TokenMetadata; txHash: string; txType: TokenTransactionType; invoiceDetails?: SparkInvoicePaymentDetails; conversionInfo?: ConversionInfo } | { type: "lightning"; description?: string; invoice: string; destinationPubkey: string; htlcDetails: SparkHtlcDetails; lnurlPayInfo?: LnurlPayInfo; lnurlWithdrawInfo?: LnurlWithdrawInfo; lnurlReceiveMetadata?: LnurlReceiveMetadata; conversionInfo?: ConversionInfo } | { type: "withdraw"; txId: string } | { type: "deposit"; txId: string; vout: number };
 
 export type PaymentDetailsFilter = { type: "spark"; htlcStatus?: SparkHtlcStatus[]; conversionRefundNeeded?: boolean } | { type: "token"; conversionRefundNeeded?: boolean; txHash?: string; txType?: TokenTransactionType } | { type: "lightning"; htlcStatus?: SparkHtlcStatus[] };
@@ -1822,6 +1926,8 @@ export type SourceAsset = { type: "bitcoin" } | { type: "token"; tokenIdentifier
 
 export type SparkHtlcStatus = "waitingForPreimage" | "preimageShared" | "returned";
 
+export type SparkMasterIdentityPublicKey = { type: "set"; publicKey: string } | { type: "unset" };
+
 export type StableBalanceActiveLabel = { type: "set"; label: string } | { type: "unset" };
 
 export type StoragePaymentDetailsFilter = { type: "spark"; htlcStatus?: SparkHtlcStatus[]; conversionFilter?: ConversionFilter } | { type: "token"; conversionFilter?: ConversionFilter; txHash?: string; txType?: TokenTransactionType } | { type: "lightning"; htlcStatus?: SparkHtlcStatus[]; conversionFilter?: ConversionFilter };
@@ -1836,6 +1942,8 @@ export type TransferSignature = { type: "transfer"; signed: ExternalPreparedTran
 
 export type TransferTarget = { type: "spark"; address: string; sparkInvoice?: string } | { type: "lightning"; bolt11: string; lnurlPay?: LnurlPayContext; feePolicy: FeePolicy; completionTimeoutSecs?: number } | { type: "coopExit"; address: string; feeQuote: SendOnchainFeeQuote; confirmationSpeed: OnchainConfirmationSpeed };
 
+export type UnilateralExitTxKind = "fanOut" | "node" | "refund" | "sweep";
+
 export type UnsignedTransferPackage = { type: "swap"; prepareTransfer: ExternalPrepareTransferRequest; targetAmounts: number[]; amountSat: number; feeSat: number } | { type: "transfer"; prepareTransfer: ExternalPrepareTransferRequest; amountSat: number; feeSat: number; target: TransferTarget } | { type: "token"; prepareTokenTransaction: ExternalPrepareTokenTransactionRequest; tokenContext: number[]; tokenIdentifier: string; amount: string; fee: string; isSwap: boolean };
 
 export type UpdateDepositPayload = { type: "claimError"; error: DepositClaimError } | { type: "refund"; refundTxid: string; refundTx: string };
@@ -1856,7 +1964,9 @@ export class BitcoinChainServiceHandle {
     free(): void;
     [Symbol.dispose](): void;
     broadcastTransaction(tx: string): Promise<void>;
+    getAddressTxos(address: string): Promise<any>;
     getAddressUtxos(address: string): Promise<any>;
+    getOutspend(txid: string, vout: number): Promise<any>;
     getTransactionHex(txid: string): Promise<any>;
     getTransactionStatus(txid: string): Promise<any>;
     recommendedFees(): Promise<any>;
@@ -1901,23 +2011,35 @@ export class BreezSdk {
     parse(input: string): Promise<InputType>;
     prepareLnurlPay(request: PrepareLnurlPayRequest): Promise<PrepareLnurlPayResponse>;
     prepareSendPayment(request: PrepareSendPaymentRequest): Promise<PrepareSendPaymentResponse>;
+    prepareUnilateralExit(request: PrepareUnilateralExitRequest): Promise<PrepareUnilateralExitResponse>;
     publishSignedLnurlPayPackage(request: PublishSignedLnurlPayPackageRequest): Promise<PublishSignedLnurlPayResponse>;
     publishSignedTransferPackage(request: PublishSignedTransferPackageRequest): Promise<PublishSignedTransferPackageResponse>;
     receivePayment(request: ReceivePaymentRequest): Promise<ReceivePaymentResponse>;
     recommendedFees(): Promise<RecommendedFees>;
     refundDeposit(request: RefundDepositRequest): Promise<RefundDepositResponse>;
-    refundPendingConversions(): Promise<void>;
+    refundPendingConversions(): Promise<RefundPendingConversionsResponse>;
     registerLightningAddress(request: RegisterLightningAddressRequest): Promise<LightningAddressInfo>;
     registerWebhook(request: RegisterWebhookRequest): Promise<RegisterWebhookResponse>;
     removeEventListener(id: string): Promise<boolean>;
     sendPayment(request: SendPaymentRequest): Promise<SendPaymentResponse>;
     signMessage(request: SignMessageRequest): Promise<SignMessageResponse>;
     syncWallet(request: SyncWalletRequest): Promise<SyncWalletResponse>;
+    unilateralExit(request: UnilateralExitRequest, signer: CpfpSigner): Promise<UnilateralExitResponse>;
     unregisterWebhook(request: UnregisterWebhookRequest): Promise<void>;
     updateContact(request: UpdateContactRequest): Promise<Contact>;
     updateUserSettings(request: UpdateUserSettingsRequest): Promise<void>;
 }
 
+/**
+ * A CPFP signer matching the `CpfpSigner` TypeScript interface.
+ */
+export class DefaultCpfpSigner {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    signPsbt(psbt_bytes: Uint8Array): Promise<Uint8Array>;
+}
+
 /**
  * A JS handle to a backend's own session store (from `defaultSessionStore`),
  * exposing the same `getSession` / `setSession` interface. Wrap it in a JS
@@ -2013,6 +2135,7 @@ export class ExternalSparkSignerHandle {
     prepareTransfer(request: ExternalPrepareTransferRequest): Promise<ExternalPreparedTransfer>;
     signAuthenticationChallenge(challenge: Uint8Array): Promise<EcdsaSignatureBytes>;
     signFrost(jobs: ExternalFrostJob[]): Promise<ExternalFrostShareResult[]>;
+    signLeafRefundSpend(leaf_id: ExternalTreeNodeId, sighash: Uint8Array): Promise<SchnorrSignatureBytes>;
     signMessage(message: Uint8Array): Promise<EcdsaSignatureBytes>;
     signSparkInvoice(request: ExternalSignSparkInvoiceRequest): Promise<ExternalSignedSparkInvoice>;
     signStaticDepositRefund(request: ExternalSignStaticDepositRefundRequest): Promise<ExternalFrostSignature>;
@@ -2060,6 +2183,18 @@ export class PasskeyClient {
      * hosts can gate UX on.
      */
     checkAvailability(): Promise<PasskeyAvailability>;
+    /**
+     * Single-CTA onboarding: silent sign-in that falls through to
+     * registration when no credential exists on the device. Pins
+     * immediate mediation, so on web only use it where the browser
+     * advertises it (`supportsImmediateMediation`); otherwise the silent
+     * probe degrades to the standard picker and a dismiss does not fall
+     * through to register, so
+     * present an explicit create / sign-in choice instead. Called without
+     * a `label`, the response `labels` lists a returning user's wallets
+     * for a picker.
+     */
+    connectWithPasskey(request: ConnectWithPasskeyRequest): Promise<ConnectWithPasskeyResponse>;
     /**
      * Label sub-object. List / publish labels for this passkey's identity.
      */
@@ -2084,6 +2219,14 @@ export class PasskeyClient {
      * label set in the same ceremony.
      */
     signIn(request: SignInRequest): Promise<SignInResponse>;
+    /**
+     * Whether this browser advertises WebAuthn immediate mediation: the
+     * silent single-CTA probe (a no-credential sign-in fast-fails with no
+     * UI) works here, so a web host can pick single- vs two-button
+     * onboarding. Web-only and WASM-only: native does the silent probe
+     * inherently, so there is nothing to query off-web.
+     */
+    supportsImmediateMediation(): Promise<boolean>;
 }
 
 /**
@@ -2317,6 +2460,11 @@ export function newSharedSdkContext(config: WasmSdkContextConfig): Promise<WasmS
  */
 export function postgresStorage(config: PostgresStorageConfig): WasmStorageConfig;
 
+/**
+ * Creates a default CPFP signer backed by a single private key.
+ */
+export function singleKeyCpfpSigner(secret_key_bytes: Uint8Array): DefaultCpfpSigner;
+
 /**
  * Runs automatically when the wasm module is instantiated. Installs the
  * panic hook so Rust panics surface as readable `console.error` output
@@ -2336,6 +2484,7 @@ export interface InitOutput {
     readonly memory: WebAssembly.Memory;
     readonly __wbg_bitcoinchainservicehandle_free: (a: number, b: number) => void;
     readonly __wbg_breezsdk_free: (a: number, b: number) => void;
+    readonly __wbg_defaultcpfpsigner_free: (a: number, b: number) => void;
     readonly __wbg_externalsigners_free: (a: number, b: number) => void;
     readonly __wbg_passkeyclient_free: (a: number, b: number) => void;
     readonly __wbg_passkeylabels_free: (a: number, b: number) => void;
@@ -2344,7 +2493,9 @@ export interface InitOutput {
     readonly __wbg_wasmsdkcontext_free: (a: number, b: number) => void;
     readonly __wbg_wasmstorageconfig_free: (a: number, b: number) => void;
     readonly bitcoinchainservicehandle_broadcastTransaction: (a: number, b: number, c: number) => any;
+    readonly bitcoinchainservicehandle_getAddressTxos: (a: number, b: number, c: number) => any;
     readonly bitcoinchainservicehandle_getAddressUtxos: (a: number, b: number, c: number) => any;
+    readonly bitcoinchainservicehandle_getOutspend: (a: number, b: number, c: number, d: number) => any;
     readonly bitcoinchainservicehandle_getTransactionHex: (a: number, b: number, c: number) => any;
     readonly bitcoinchainservicehandle_getTransactionStatus: (a: number, b: number, c: number) => any;
     readonly bitcoinchainservicehandle_recommendedFees: (a: number) => any;
@@ -2383,6 +2534,7 @@ export interface InitOutput {
     readonly breezsdk_parse: (a: number, b: number, c: number) => any;
     readonly breezsdk_prepareLnurlPay: (a: number, b: any) => any;
     readonly breezsdk_prepareSendPayment: (a: number, b: any) => any;
+    readonly breezsdk_prepareUnilateralExit: (a: number, b: any) => any;
     readonly breezsdk_publishSignedLnurlPayPackage: (a: number, b: any) => any;
     readonly breezsdk_publishSignedTransferPackage: (a: number, b: any) => any;
     readonly breezsdk_receivePayment: (a: number, b: any) => any;
@@ -2395,6 +2547,7 @@ export interface InitOutput {
     readonly breezsdk_sendPayment: (a: number, b: any) => any;
     readonly breezsdk_signMessage: (a: number, b: any) => any;
     readonly breezsdk_syncWallet: (a: number, b: any) => any;
+    readonly breezsdk_unilateralExit: (a: number, b: any, c: any) => any;
     readonly breezsdk_unregisterWebhook: (a: number, b: any) => any;
     readonly breezsdk_updateContact: (a: number, b: any) => any;
     readonly breezsdk_updateUserSettings: (a: number, b: any) => any;
@@ -2410,6 +2563,7 @@ export interface InitOutput {
     readonly defaultServerConfig: (a: any) => any;
     readonly defaultSessionStore: (a: number, b: any, c: number, d: number) => any;
     readonly defaultStorage: (a: number, b: number) => number;
+    readonly defaultcpfpsigner_signPsbt: (a: number, b: number, c: number) => any;
     readonly defaultsessionstore_getSession: (a: number, b: number, c: number) => any;
     readonly defaultsessionstore_setSession: (a: number, b: number, c: number, d: any) => any;
     readonly externalbreezsignerhandle_decryptEcies: (a: number, b: number, c: number, d: number, e: number) => any;
@@ -2436,6 +2590,7 @@ export interface InitOutput {
     readonly externalsparksignerhandle_prepareTransfer: (a: number, b: any) => any;
     readonly externalsparksignerhandle_signAuthenticationChallenge: (a: number, b: number, c: number) => any;
     readonly externalsparksignerhandle_signFrost: (a: number, b: number, c: number) => any;
+    readonly externalsparksignerhandle_signLeafRefundSpend: (a: number, b: any, c: number, d: number) => any;
     readonly externalsparksignerhandle_signMessage: (a: number, b: number, c: number) => any;
     readonly externalsparksignerhandle_signSparkInvoice: (a: number, b: any) => any;
     readonly externalsparksignerhandle_signStaticDepositRefund: (a: number, b: any) => any;
@@ -2446,10 +2601,12 @@ export interface InitOutput {
     readonly newRestChainService: (a: number, b: number, c: any, d: any, e: number) => any;
     readonly newSharedSdkContext: (a: any) => any;
     readonly passkeyclient_checkAvailability: (a: number) => any;
+    readonly passkeyclient_connectWithPasskey: (a: number, b: any) => any;
     readonly passkeyclient_labels: (a: number) => number;
     readonly passkeyclient_new: (a: any, b: number, c: number, d: number) => number;
     readonly passkeyclient_register: (a: number, b: any) => any;
     readonly passkeyclient_signIn: (a: number, b: any) => any;
+    readonly passkeyclient_supportsImmediateMediation: (a: number) => any;
     readonly passkeylabels_list: (a: number) => any;
     readonly passkeylabels_store: (a: number, b: number, c: number) => any;
     readonly postgresStorage: (a: any) => number;
@@ -2470,6 +2627,7 @@ export interface InitOutput {
     readonly sdkbuilder_withSharedContext: (a: number, b: number) => number;
     readonly sdkbuilder_withStorage: (a: number, b: any) => number;
     readonly sdkbuilder_withStorageBackend: (a: number, b: number) => number;
+    readonly singleKeyCpfpSigner: (a: number, b: number) => [number, number, number];
     readonly start: () => void;
     readonly tokenissuer_burnIssuerToken: (a: number, b: any) => any;
     readonly tokenissuer_createIssuerToken: (a: number, b: any) => any;