@breeztech/breez-sdk-spark 0.24.1 → 0.26.0

package/deno/breez_sdk_spark_wasm.d.ts

@@ -545,7 +545,7 @@ export interface BatchRecipient {
 
 export interface BatchTotal {
     tokenIdentifier?: string;
-    amount: bigint;
+    amount: string;
 }
 
 export interface Bip21Details {
@@ -681,6 +681,15 @@ export interface CheckMessageResponse {
     isValid: boolean;
 }
 
+export interface CheckUnilateralExitRequest {
+    exit: UnilateralExitResponse;
+}
+
+export interface CheckUnilateralExitResponse {
+    exit: UnilateralExitResponse;
+    verdict: UnilateralExitVerdict;
+}
+
 export interface ClaimDepositQuote {
     confirmationsRequired: number;
     creditAmountSats: number;
@@ -696,7 +705,7 @@ export interface ClaimDepositRequest {
 }
 
 export interface ClaimDepositResponse {
-    payment?: Payment;
+    outcome: ClaimDepositOutcome;
 }
 
 export interface ClaimHtlcPaymentRequest {
@@ -746,6 +755,12 @@ export interface Config {
     crossChainConfig?: CrossChainConfig;
 }
 
+export interface ConfirmedExitNode {
+    nodeId: string;
+    confirmedBy: ExitNodeConfirmation;
+    blockHeight?: number;
+}
+
 export interface ConnectRequest {
     config: Config;
     seed: Seed;
@@ -817,12 +832,17 @@ export interface Credentials {
     password: string;
 }
 
+export interface CrossChainAcceptedAsset {
+    asset: SparkAsset;
+    limits?: CrossChainRouteLimits;
+}
+
 export interface CrossChainAddressDetails {
     address: string;
     addressFamily: CrossChainAddressFamily;
     contractAddress?: string;
     chainId?: number;
-    amount?: bigint;
+    amount?: string;
 }
 
 export interface CrossChainConfig {
@@ -830,6 +850,25 @@ export interface CrossChainConfig {
     defaultTargetOverpayBps?: number;
 }
 
+export interface CrossChainReceiveInfo {
+    depositAddress: string;
+    depositAmount: string;
+    expectedReceivedAmount: string;
+    destinationAsset: string;
+    tokenIdentifier?: string;
+    serviceFeeAmount: string;
+    serviceFeeAsset?: string;
+    serviceFeeAssetDecimals?: number;
+    expiresAt: number;
+}
+
+export interface CrossChainRouteLimits {
+    minAmount?: string;
+    maxAmount?: string;
+    minUsdCents?: number;
+    maxUsdCents?: number;
+}
+
 export interface CrossChainRoutePair {
     provider: CrossChainProvider;
     chain: string;
@@ -838,8 +877,8 @@ export interface CrossChainRoutePair {
     contractAddress?: string;
     decimals: number;
     exactOutEligible: boolean;
-    supportedSources: SourceAsset[];
-    supportedSourceChains: SourceChain[];
+    acceptedAssets: CrossChainAcceptedAsset[];
+    deliveryMethods: DeliveryMethod[];
 }
 
 export interface CurrencyInfo {
@@ -862,6 +901,7 @@ export interface DepositInfo {
     claimError?: DepositClaimError;
     instantClaimStatus?: InstantClaimStatus;
     refundState?: RefundState;
+    maxClaimFee?: MaxFee;
 }
 
 export interface EcdsaSignatureBytes {
@@ -872,6 +912,19 @@ export interface EventListener {
     onEvent: (e: SdkEvent) => void;
 }
 
+export interface ExitChainState {
+    confirmedNodes: ConfirmedExitNode[];
+    refunds: ExitRefund[];
+    stoppedLeafIds: string[];
+    unverifiedNodeIds: string[];
+    unverifiableConfirmedNodeIds: string[];
+}
+
+export interface ExitRefund {
+    leafId: string;
+    state: ExitRefundState;
+}
+
 export interface ExportUnilateralExitStateResponse {
     exitState: string;
 }
@@ -929,6 +982,10 @@ export interface ExternalInputParser {
     parserUrl: string;
 }
 
+export interface ExternalLeafSigningKey {
+    derivedFrom: ExternalTreeNodeId;
+}
+
 export interface ExternalNewLeafKey {
     nodeId: ExternalTreeNodeId;
     newSigningPublicKey: number[];
@@ -1075,6 +1132,7 @@ export interface ExternalStartedStaticDepositRefund {
 export interface ExternalTransferLeafInput {
     nodeId: ExternalTreeNodeId;
     newLeafId: ExternalTreeNodeId;
+    signingKey: ExternalLeafSigningKey;
 }
 
 export interface ExternalTreeNodeId {
@@ -1447,6 +1505,7 @@ export interface PreparePaymentLinkResponse {
     asset: string;
     serviceFeeAmount: bigint;
     serviceFeeAsset?: string;
+    serviceFeeAssetDecimals?: number;
     expiresAt: string;
 }
 
@@ -1486,11 +1545,14 @@ export interface PrepareUnilateralExitResponse {
     leaves: UnilateralExitLeaf[];
     recoverableValueSat: number;
     totalFeeSat: number;
+    cpfpFeeSat: number;
     fanoutFeeSat: number;
+    sweepFeeSat: number;
     singleUtxoFundingSat: number;
     perBranchFunding: PerBranchFunding[];
     feeRateSatPerVbyte: number;
     destination: string;
+    exitChainState: ExitChainState;
 }
 
 export interface ProvisionalPayment {
@@ -1530,6 +1592,7 @@ export interface ReceivePaymentRequest {
 export interface ReceivePaymentResponse {
     paymentRequest: string;
     fee: bigint;
+    crossChainInfo?: CrossChainReceiveInfo;
 }
 
 export interface RecommendedFees {
@@ -1635,6 +1698,7 @@ export interface SendOnchainFeeQuote {
     speedFast: SendOnchainSpeedFeeQuote;
     speedMedium: SendOnchainSpeedFeeQuote;
     speedSlow: SendOnchainSpeedFeeQuote;
+    isEstimate: boolean;
 }
 
 export interface SendOnchainSpeedFeeQuote {
@@ -1787,6 +1851,8 @@ export interface Storage {
     deleteDeposit: (txid: string, vout: number) => Promise<void>;
     listDeposits: () => Promise<DepositInfo[]>;
     updateDeposit: (txid: string, vout: number, payload: UpdateDepositPayload) => Promise<void>;
+    listWatchedDepositAddresses: () => Promise<WatchedDepositAddress[]>;
+    updateWatchedDepositAddress: (address: string, payload: UpdateWatchedAddressPayload) => Promise<void>;
     setLnurlMetadata: (metadata: SetLnurlMetadataItem[]) => Promise<void>;
     getPaymentsByParentIds: (parentPaymentIds: string[]) => Promise<{ [parentId: string]: RelatedPayment[] }>;
     listContacts: (request: ListContactsRequest) => Promise<Contact[]>;
@@ -1921,8 +1987,12 @@ export interface UnilateralExitRequest {
 export interface UnilateralExitResponse {
     recoverableValueSat: number;
     totalFeeSat: number;
+    cpfpFeeSat: number;
+    fanoutFeeSat: number;
+    sweepFeeSat: number;
     leaves: UnilateralExitLeaf[];
     transactions: UnilateralExitTransaction[];
+    fundingInputs: CpfpInput[];
 }
 
 export interface UnilateralExitTransaction {
@@ -1933,7 +2003,7 @@ export interface UnilateralExitTransaction {
     cpfpTxHex?: string;
     csvTimelockBlocks?: number;
     dependsOn: string[];
-    status: ConfirmationStatus;
+    status: ExitTransactionStatus;
 }
 
 export interface UnregisterWebhookRequest {
@@ -1977,6 +2047,12 @@ export interface Utxo {
     status: TxStatus;
 }
 
+export interface WatchedDepositAddress {
+    address: string;
+    issuedAt: number;
+    seen: boolean;
+}
+
 export interface Webhook {
     id: string;
     url: string;
@@ -2003,13 +2079,15 @@ export type BuyBitcoinRequest = { type: "moonpay"; lockedAmountSat?: number; red
 
 export type ChainApiType = "esplora" | "mempoolSpace";
 
-export type ConfirmationStatus = "confirmed" | "unconfirmed" | "unverified";
+export type ClaimDeferredReason = { type: "maxFeeExceeded"; requiredFeeSats: number; maxFeeSats: number } | { type: "noEarlyClaimAvailable" } | { type: "providerDeclined"; message: string };
+
+export type ClaimDepositOutcome = { type: "settled"; payment: Payment } | { type: "submitted" } | { type: "deferred"; reason: ClaimDeferredReason };
 
 export type ConversionChain = { type: "spark" } | { type: "lightning" } | { type: "external"; name: string; chainId?: string };
 
 export type ConversionFilter = "ammRefundNeeded" | "orchestraPending" | "boltzPending";
 
-export type ConversionInfo = { type: "amm"; poolId: string; conversionId: string; status: ConversionStatus; fee?: string; purpose?: ConversionPurpose; amountAdjustment?: AmountAdjustmentReason; degradation?: SwapDegradation } | { type: "orchestra"; chain: string; chainId?: string; asset?: string; assetContract?: string; recipientAddress: string; assetAmountIn?: string; estimatedOut: string; deliveredAmount?: string; status: ConversionStatus; feeAmount?: string; serviceFeeAmount?: string; serviceFeeAsset?: string; assetDecimals: number; orderId: string; quoteId: string; readToken?: string } | { type: "boltz"; chain: string; chainId?: string; asset?: string; assetContract?: string; recipientAddress: string; assetAmountIn?: string; estimatedOut: string; deliveredAmount?: string; status: ConversionStatus; feeAmount?: string; serviceFeeAmount?: string; serviceFeeAsset?: string; assetDecimals: number; swapId: string; invoice: string; invoiceAmountSats: number; bridgeRef?: string; maxSlippageBps: number; quoteDegraded?: boolean };
+export type ConversionInfo = { type: "amm"; poolId: string; conversionId: string; status: ConversionStatus; fee?: string; purpose?: ConversionPurpose; amountAdjustment?: AmountAdjustmentReason; degradation?: SwapDegradation } | { type: "orchestra"; chain: string; chainId?: string; asset?: string; assetContract?: string; recipientAddress: string; assetAmountIn?: string; estimatedOut: string; deliveredAmount?: string; externalTxHash?: string; status: ConversionStatus; feeAmount?: string; serviceFeeAmount?: string; serviceFeeAsset?: string; serviceFeeAssetDecimals?: number; assetDecimals: number; orderId: string; quoteId: string; readToken?: string } | { type: "boltz"; chain: string; chainId?: string; asset?: string; assetContract?: string; recipientAddress: string; assetAmountIn?: string; estimatedOut: string; deliveredAmount?: string; status: ConversionStatus; feeAmount?: string; serviceFeeAmount?: string; serviceFeeAsset?: string; assetDecimals: number; swapId: string; invoice: string; invoiceAmountSats: number; bridgeRef?: string; maxSlippageBps: number; quoteDegraded?: boolean };
 
 export type ConversionProvider = "amm" | "orchestra" | "boltz";
 
@@ -2033,10 +2111,18 @@ export type CrossChainProviderContext = { type: "orchestra"; quoteId: string; de
 
 export type CrossChainRouteFilter = { type: "send"; addressDetails: CrossChainAddressDetails } | { type: "receive"; contractAddress?: string } | { type: "paymentLink"; addressDetails: CrossChainAddressDetails };
 
+export type DeliveryMethod = "spark" | "lightning" | "bitcoin";
+
 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 ExitNodeConfirmation = "cpfp" | "direct";
+
+export type ExitRefundState = { type: "onChain"; txHex: string; vout: number; valueSat: number; blockHeight?: number } | { type: "swept" };
+
+export type ExitTransactionStatus = { type: "confirmed"; blockHeight?: number } | { type: "ready" } | { type: "waitingForDependencies" } | { type: "waitingForTimelock"; spendableAtHeight?: number } | { type: "unverified" };
+
 export type ExternalFrostDerivation = { type: "signingLeaf"; leafId: ExternalTreeNodeId } | { type: "staticDeposit"; index: number } | { type: "htlcPreimage" } | { type: "identity" };
 
 export type ExternalSparkInvoiceKind = "sats" | "tokens";
@@ -2049,13 +2135,13 @@ export type FeePolicy = "feesExcluded" | "feesIncluded";
 
 export type InputType = ({ type: "bitcoinAddress" } & BitcoinAddressDetails) | ({ type: "bolt11Invoice" } & Bolt11InvoiceDetails) | ({ type: "bolt12Invoice" } & Bolt12InvoiceDetails) | ({ type: "bolt12Offer" } & Bolt12OfferDetails) | ({ type: "lightningAddress" } & LightningAddressDetails) | ({ type: "lnurlPay" } & LnurlPayRequestDetails) | ({ type: "silentPaymentAddress" } & SilentPaymentAddressDetails) | ({ type: "lnurlAuth" } & LnurlAuthRequestDetails) | ({ type: "url" } & string) | ({ type: "bip21" } & Bip21Details) | ({ type: "bolt12InvoiceRequest" } & Bolt12InvoiceRequestDetails) | ({ type: "lnurlWithdraw" } & LnurlWithdrawRequestDetails) | ({ type: "sparkAddress" } & SparkAddressDetails) | ({ type: "sparkInvoice" } & SparkInvoiceDetails) | ({ type: "crossChainAddress" } & CrossChainAddressDetails);
 
-export type InstantClaimStatus = { type: "declined"; maxFeeSats?: number; confirmations?: number } | { type: "submitted"; claimId: string };
+export type InstantClaimStatus = { type: "declined"; maxFeeSats?: number; confirmations?: number } | { type: "submitted"; claimId: string } | { type: "claimed" };
 
 export type LnurlCallbackStatus = { type: "ok" } | { type: "errorStatus"; errorDetails: LnurlErrorDetails };
 
 export type MaxFee = { type: "fixed"; amount: number } | { type: "rate"; satPerVbyte: number } | { type: "networkRecommended"; leewaySatPerVbyte: number };
 
-export type Network = "mainnet" | "regtest";
+export type Network = "mainnet" | "regtest" | "signet";
 
 export type OnchainConfirmationSpeed = "fast" | "medium" | "slow";
 
@@ -2083,15 +2169,15 @@ export type PublishSignedLnurlPayResponse = { type: "swapCompleted" } | { type:
 
 export type PublishSignedTransferPackageResponse = { type: "swapCompleted" } | { type: "paymentSent"; payment: Payment } | { type: "paymentsSent"; payments: Payment[] };
 
-export type ReceivePaymentMethod = { type: "sparkAddress" } | { type: "sparkInvoice"; amount?: string; tokenIdentifier?: string; expiryTime?: number; description?: string; senderPublicKey?: string } | { type: "bitcoinAddress"; newAddress?: boolean } | { type: "bolt11Invoice"; description: string; amountSats?: number; expirySecs?: number; paymentHash?: string; receiverIdentityPublicKey?: string };
+export type ReceivePaymentMethod = { type: "sparkAddress" } | { type: "sparkInvoice"; amount?: string; tokenIdentifier?: string; expiryTime?: number; description?: string; senderPublicKey?: string } | { type: "bitcoinAddress"; newAddress?: boolean } | { type: "bolt11Invoice"; description: string; amountSats?: number; expirySecs?: number; paymentHash?: string; receiverIdentityPublicKey?: string } | { type: "crossChain"; route: CrossChainRoutePair; amount: string; destination?: SparkAsset; feeMode?: CrossChainFeeMode; maxSlippageBps?: number; targetOverpayBps?: number };
 
 export type RefundState = { type: "broadcastPending"; lastError?: string } | { type: "broadcast" };
 
-export type SdkEvent = { type: "synced" } | { type: "unclaimedDeposits"; unclaimedDeposits: DepositInfo[] } | { type: "claimedDeposits"; claimedDeposits: DepositInfo[] } | { type: "paymentSucceeded"; payment: Payment } | { type: "paymentPending"; payment: Payment } | { type: "paymentFailed"; payment: Payment } | { type: "autoOptimization"; optimizationEvent: AutoOptimizationEvent } | { type: "lightningAddressChanged"; lightningAddress?: LightningAddressInfo } | { type: "newDeposits"; newDeposits: DepositInfo[] } | { type: "unilateralExitStateChanged" };
+export type SdkEvent = { type: "synced" } | { type: "unclaimedDeposits"; unclaimedDeposits: DepositInfo[] } | { type: "claimedDeposits"; claimedDeposits: DepositInfo[] } | { type: "paymentSucceeded"; payment: Payment } | { type: "paymentPending"; payment: Payment } | { type: "paymentFailed"; payment: Payment } | { type: "paymentMetadataUpdated"; payment: Payment } | { type: "autoOptimization"; optimizationEvent: AutoOptimizationEvent } | { type: "lightningAddressChanged"; lightningAddress?: LightningAddressInfo } | { type: "newDeposits"; newDeposits: DepositInfo[] } | { type: "unilateralExitStateChanged" };
 
 export type Seed = { type: "mnemonic"; mnemonic: string; passphrase?: string } | ({ type: "entropy" } & number[]);
 
-export type SendPaymentMethod = { type: "bitcoinAddress"; address: BitcoinAddressDetails; feeQuote: SendOnchainFeeQuote } | { type: "bolt11Invoice"; invoiceDetails: Bolt11InvoiceDetails; sparkTransferFeeSats?: number; lightningFeeSats: number } | { type: "sparkAddress"; address: string; fee: string; tokenIdentifier?: string } | { type: "sparkInvoice"; sparkInvoiceDetails: SparkInvoiceDetails; fee: string; tokenIdentifier?: string } | { type: "crossChainAddress"; route: CrossChainRoutePair; recipientAddress: string; amountIn: string; assetAmountIn: string; estimatedOut: string; feeAmount: string; serviceFeeAmount: string; serviceFeeAsset?: string; sourceTransferFeeSats: number; feeMode: CrossChainFeeMode; expiresAt: string; providerContext: CrossChainProviderContext };
+export type SendPaymentMethod = { type: "bitcoinAddress"; address: BitcoinAddressDetails; feeQuote: SendOnchainFeeQuote } | { type: "bolt11Invoice"; invoiceDetails: Bolt11InvoiceDetails; sparkTransferFeeSats?: number; lightningFeeSats: number } | { type: "sparkAddress"; address: string; fee: string; tokenIdentifier?: string } | { type: "sparkInvoice"; sparkInvoiceDetails: SparkInvoiceDetails; fee: string; tokenIdentifier?: string } | { type: "crossChainAddress"; route: CrossChainRoutePair; recipientAddress: string; amountIn: string; assetAmountIn: string; estimatedOut: string; feeAmount: string; serviceFeeAmount: string; serviceFeeAsset?: string; serviceFeeAssetDecimals?: number; sourceTransferFeeSats: number; feeMode: CrossChainFeeMode; expiresAt: string; providerContext: CrossChainProviderContext };
 
 export type SendPaymentOptions = { type: "bitcoinAddress"; confirmationSpeed: OnchainConfirmationSpeed } | { type: "bolt11Invoice"; preferSpark: boolean; completionTimeoutSecs?: number } | { type: "sparkAddress"; htlcOptions?: SparkHtlcOptions };
 
@@ -2099,9 +2185,7 @@ export type ServiceStatus = "operational" | "degraded" | "partial" | "unknown" |
 
 export type SessionStoreError = { type: "notFound" } | ({ type: "generic" } & string);
 
-export type SourceAsset = { type: "bitcoin" } | { type: "token"; tokenIdentifier: string };
-
-export type SourceChain = "spark" | "lightning" | "bitcoin";
+export type SparkAsset = { type: "bitcoin" } | { type: "token"; tokenIdentifier: string };
 
 export type SparkHtlcStatus = "waitingForPreimage" | "preimageShared" | "returned";
 
@@ -2123,11 +2207,17 @@ 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 UnilateralExitRedoReason = "onChainStateDiverged";
+
 export type UnilateralExitTxKind = "fanOut" | "node" | "refund" | "sweep";
 
+export type UnilateralExitVerdict = { type: "valid" } | { type: "done" } | { type: "redo"; reason: UnilateralExitRedoReason };
+
 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 } | { type: "tokenBatch"; prepareTokenTransaction: ExternalPrepareTokenTransactionRequest; tokenContext: number[]; totals: BatchTotal[]; isSwap: boolean };
 
-export type UpdateDepositPayload = { type: "claimError"; error: DepositClaimError } | { type: "refund"; refundTxid: string; refundTx: string; state: RefundState } | { type: "instantClaim"; status: InstantClaimStatus } | { type: "refundBroadcastState"; refundTxid: string; state: RefundState };
+export type UpdateDepositPayload = { type: "claimError"; error: DepositClaimError } | { type: "refund"; refundTxid: string; refundTx: string; state: RefundState } | { type: "instantClaim"; status: InstantClaimStatus } | { type: "refundBroadcastState"; refundTxid: string; state: RefundState } | { type: "maxClaimFee"; maxFee?: MaxFee };
+
+export type UpdateWatchedAddressPayload = { type: "watch"; issuedAt: number } | { type: "seen" } | { type: "unwatch"; issuedAt: number };
 
 export type WebhookEventType = { type: "lightningReceiveFinished" } | { type: "lightningSendFinished" } | { type: "coopExitFinished" } | { type: "staticDepositFinished" } | ({ type: "unknown" } & string);
 
@@ -2167,6 +2257,7 @@ export class BreezSdk {
     buyBitcoin(request: BuyBitcoinRequest): Promise<BuyBitcoinResponse>;
     checkLightningAddressAvailable(request: CheckLightningAddressRequest): Promise<boolean>;
     checkMessage(request: CheckMessageRequest): Promise<CheckMessageResponse>;
+    checkUnilateralExit(request: CheckUnilateralExitRequest): Promise<CheckUnilateralExitResponse>;
     claimDeposit(request: ClaimDepositRequest): Promise<ClaimDepositResponse>;
     claimHtlcPayment(request: ClaimHtlcPaymentRequest): Promise<ClaimHtlcPaymentResponse>;
     claimLightningAddressTransfer(request: ClaimTransferRequest): Promise<LightningAddressInfo>;