@buildonspark/spark-sdk 0.1.43 → 0.1.44

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # @buildonspark/spark-sdk
 
+## 0.1.44
+
+### Patch Changes
+
+- Add fee estimate quote for coop exit requests
+- Allow coop exit fees to be taken from wallet balance instead of withdrawal amount if specified
+
 ## 0.1.43
 
 ### Patch Changes

package/dist/{RequestLightningSendInput-Na1mHdWg.d.cts → RequestLightningSendInput-BxbCtwpV.d.cts}

@@ -1,6 +1,6 @@
 import { Query } from '@lightsparkdev/core';
 import { B as BitcoinNetwork } from './BitcoinNetwork-TnABML0T.cjs';
-import { S as SparkSigner } from './signer-IO3oMRNj.cjs';
+import { S as SparkSigner } from './signer-DaY8c60s.cjs';
 
 /** This enum identifies the unit of currency associated with a CurrencyAmount. **/
 declare enum CurrencyUnit {
@@ -90,6 +90,44 @@ interface CoopExitFeeEstimatesOutput {
     speedSlow?: CoopExitFeeEstimate | undefined;
 }
 
+interface CoopExitFeeQuote {
+    /**
+     * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
+     * string.
+     **/
+    id: string;
+    /** The date and time when the entity was first created. **/
+    createdAt: string;
+    /** The date and time when the entity was last updated. **/
+    updatedAt: string;
+    /** The network the coop exit fee quote is on. **/
+    network: BitcoinNetwork;
+    /** The total currency amount of all the nodes user swapped for the coop exit quote. **/
+    totalAmount: CurrencyAmount;
+    /** The fee user pays for the coop exit not including the L1 broadcast fee when exit speed is fast. **/
+    userFeeFast: CurrencyAmount;
+    /** The fee user pays for the coop exit not including the L1 broadcast fee when exit speed is medium. **/
+    userFeeMedium: CurrencyAmount;
+    /** The fee user pays for the coop exit not including the L1 broadcast fee when exit speed is slow. **/
+    userFeeSlow: CurrencyAmount;
+    /** The L1 broadcast fee user pays for the coop exit when exit speed is fast. **/
+    l1BroadcastFeeFast: CurrencyAmount;
+    /** The L1 broadcast fee user pays for the coop exit when exit speed is medium. **/
+    l1BroadcastFeeMedium: CurrencyAmount;
+    /** The L1 broadcast fee user pays for the coop exit when exit speed is slow. **/
+    l1BroadcastFeeSlow: CurrencyAmount;
+    /** The time when the coop exit fee quote expires. **/
+    expiresAt: string;
+    /** The typename of the object **/
+    typename: string;
+}
+declare const getCoopExitFeeQuoteQuery: (id: string) => Query<CoopExitFeeQuote>;
+
+interface CoopExitFeeQuoteInput {
+    leafExternalIds: string[];
+    withdrawalAddress: string;
+}
+
 declare enum ExitSpeed {
     /**
      * This is an enum value that represents values that could be added in the future.
@@ -282,10 +320,10 @@ declare class SspClient {
     getCoopExitFeeEstimate({ leafExternalIds, withdrawalAddress, }: CoopExitFeeEstimatesInput): Promise<CoopExitFeeEstimatesOutput | null>;
     getCurrentUser(): Promise<void>;
     completeCoopExit({ userOutboundTransferExternalId, coopExitRequestId, }: CompleteCoopExitInput): Promise<CoopExitRequest | null>;
-    requestCoopExit({ leafExternalIds, withdrawalAddress, idempotencyKey, exitSpeed, }: RequestCoopExitInput): Promise<CoopExitRequest | null>;
+    requestCoopExit({ leafExternalIds, withdrawalAddress, idempotencyKey, exitSpeed, feeLeafExternalIds, feeQuoteId, withdrawAll, }: RequestCoopExitInput): Promise<CoopExitRequest | null>;
     requestLightningReceive({ amountSats, network, paymentHash, expirySecs, memo, includeSparkAddress, receiverIdentityPubkey, descriptionHash, }: RequestLightningReceiveInput): Promise<LightningReceiveRequest | null>;
     requestLightningSend({ encodedInvoice, idempotencyKey, amountSats, }: RequestLightningSendInput): Promise<LightningSendRequest | null>;
-    requestLeaveSwap({ adaptorPubkey, totalAmountSats, targetAmountSats, feeSats, userLeaves, idempotencyKey, }: RequestLeavesSwapInput): Promise<LeavesSwapRequest | null>;
+    requestLeaveSwap({ adaptorPubkey, totalAmountSats, targetAmountSats, feeSats, userLeaves, idempotencyKey, targetAmountSatsList, }: RequestLeavesSwapInput): Promise<LeavesSwapRequest | null>;
     completeLeaveSwap({ adaptorSecretKey, userOutboundTransferExternalId, leavesSwapRequestId, }: CompleteLeavesSwapInput): Promise<LeavesSwapRequest | null>;
     getLightningReceiveRequest(id: string): Promise<LightningReceiveRequest | null>;
     getLightningSendRequest(id: string): Promise<LightningSendRequest | null>;
@@ -305,6 +343,7 @@ declare class SspClient {
     getChallenge(): Promise<GetChallengeOutput | null>;
     verifyChallenge(signature: string, protectedChallenge: string): Promise<VerifyChallengeOutput | null>;
     authenticate(): Promise<void>;
+    getCoopExitFeeQuote({ leafExternalIds, withdrawalAddress, }: CoopExitFeeQuoteInput): Promise<CoopExitFeeQuote | null>;
 }
 
 interface Leaf {
@@ -512,4 +551,4 @@ interface RequestLightningSendInput {
     amountSats?: number | undefined;
 }
 
-export { type SwapLeaf as A, type SspClientOptions as B, type ClaimStaticDepositOutput as C, SspClient as D, ExitSpeed as E, type GetChallengeOutput as G, type HasSspClientOptions as H, type Invoice as I, type Leaf as L, type MayHaveSspClientOptions as M, type PageInfo as P, type RequestCoopExitInput as R, SparkCoopExitRequestStatus as S, Transfer as T, type UserLeafInput as U, type VerifyChallengeOutput as V, type CompleteCoopExitInput as a, type CompleteLeavesSwapInput as b, type CoopExitFeeEstimate as c, type CoopExitFeeEstimatesInput as d, type CoopExitFeeEstimatesOutput as e, type CoopExitRequest as f, getCoopExitRequestQuery as g, type CurrencyAmount as h, CurrencyUnit as i, type LeavesSwapFeeEstimateOutput as j, getLeavesSwapRequestQuery as k, type LeavesSwapRequest as l, getLightningReceiveRequestQuery as m, type LightningReceiveRequest as n, LightningReceiveRequestStatus as o, type LightningSendFeeEstimateOutput as p, getLightningSendRequestQuery as q, type LightningSendRequest as r, LightningSendRequestStatus as s, type RequestLeavesSwapInput as t, type RequestLightningReceiveInput as u, type RequestLightningSendInput as v, SparkLeavesSwapRequestStatus as w, type SparkTransferToLeavesConnection as x, type StaticDepositQuoteInput as y, type StaticDepositQuoteOutput as z };
+export { type SparkTransferToLeavesConnection as A, type StaticDepositQuoteInput as B, type ClaimStaticDepositOutput as C, type StaticDepositQuoteOutput as D, ExitSpeed as E, type SwapLeaf as F, type GetChallengeOutput as G, type HasSspClientOptions as H, type Invoice as I, type SspClientOptions as J, SspClient as K, type Leaf as L, type MayHaveSspClientOptions as M, type PageInfo as P, type RequestCoopExitInput as R, SparkCoopExitRequestStatus as S, Transfer as T, type UserLeafInput as U, type VerifyChallengeOutput as V, type CompleteCoopExitInput as a, type CompleteLeavesSwapInput as b, type CoopExitFeeEstimate as c, type CoopExitFeeEstimatesInput as d, type CoopExitFeeEstimatesOutput as e, type CoopExitFeeQuote as f, getCoopExitFeeQuoteQuery as g, type CoopExitFeeQuoteInput as h, type CoopExitRequest as i, getCoopExitRequestQuery as j, type CurrencyAmount as k, CurrencyUnit as l, type LeavesSwapFeeEstimateOutput as m, getLeavesSwapRequestQuery as n, type LeavesSwapRequest as o, getLightningReceiveRequestQuery as p, type LightningReceiveRequest as q, LightningReceiveRequestStatus as r, type LightningSendFeeEstimateOutput as s, getLightningSendRequestQuery as t, type LightningSendRequest as u, LightningSendRequestStatus as v, type RequestLeavesSwapInput as w, type RequestLightningReceiveInput as x, type RequestLightningSendInput as y, SparkLeavesSwapRequestStatus as z };

package/dist/{RequestLightningSendInput-D7fZdT4A.d.ts → RequestLightningSendInput-RGel43ks.d.ts}

@@ -1,6 +1,6 @@
 import { Query } from '@lightsparkdev/core';
 import { B as BitcoinNetwork } from './BitcoinNetwork-TnABML0T.js';
-import { S as SparkSigner } from './signer-wqesWifN.js';
+import { S as SparkSigner } from './signer-D7vfYik9.js';
 
 /** This enum identifies the unit of currency associated with a CurrencyAmount. **/
 declare enum CurrencyUnit {
@@ -90,6 +90,44 @@ interface CoopExitFeeEstimatesOutput {
     speedSlow?: CoopExitFeeEstimate | undefined;
 }
 
+interface CoopExitFeeQuote {
+    /**
+     * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
+     * string.
+     **/
+    id: string;
+    /** The date and time when the entity was first created. **/
+    createdAt: string;
+    /** The date and time when the entity was last updated. **/
+    updatedAt: string;
+    /** The network the coop exit fee quote is on. **/
+    network: BitcoinNetwork;
+    /** The total currency amount of all the nodes user swapped for the coop exit quote. **/
+    totalAmount: CurrencyAmount;
+    /** The fee user pays for the coop exit not including the L1 broadcast fee when exit speed is fast. **/
+    userFeeFast: CurrencyAmount;
+    /** The fee user pays for the coop exit not including the L1 broadcast fee when exit speed is medium. **/
+    userFeeMedium: CurrencyAmount;
+    /** The fee user pays for the coop exit not including the L1 broadcast fee when exit speed is slow. **/
+    userFeeSlow: CurrencyAmount;
+    /** The L1 broadcast fee user pays for the coop exit when exit speed is fast. **/
+    l1BroadcastFeeFast: CurrencyAmount;
+    /** The L1 broadcast fee user pays for the coop exit when exit speed is medium. **/
+    l1BroadcastFeeMedium: CurrencyAmount;
+    /** The L1 broadcast fee user pays for the coop exit when exit speed is slow. **/
+    l1BroadcastFeeSlow: CurrencyAmount;
+    /** The time when the coop exit fee quote expires. **/
+    expiresAt: string;
+    /** The typename of the object **/
+    typename: string;
+}
+declare const getCoopExitFeeQuoteQuery: (id: string) => Query<CoopExitFeeQuote>;
+
+interface CoopExitFeeQuoteInput {
+    leafExternalIds: string[];
+    withdrawalAddress: string;
+}
+
 declare enum ExitSpeed {
     /**
      * This is an enum value that represents values that could be added in the future.
@@ -282,10 +320,10 @@ declare class SspClient {
     getCoopExitFeeEstimate({ leafExternalIds, withdrawalAddress, }: CoopExitFeeEstimatesInput): Promise<CoopExitFeeEstimatesOutput | null>;
     getCurrentUser(): Promise<void>;
     completeCoopExit({ userOutboundTransferExternalId, coopExitRequestId, }: CompleteCoopExitInput): Promise<CoopExitRequest | null>;
-    requestCoopExit({ leafExternalIds, withdrawalAddress, idempotencyKey, exitSpeed, }: RequestCoopExitInput): Promise<CoopExitRequest | null>;
+    requestCoopExit({ leafExternalIds, withdrawalAddress, idempotencyKey, exitSpeed, feeLeafExternalIds, feeQuoteId, withdrawAll, }: RequestCoopExitInput): Promise<CoopExitRequest | null>;
     requestLightningReceive({ amountSats, network, paymentHash, expirySecs, memo, includeSparkAddress, receiverIdentityPubkey, descriptionHash, }: RequestLightningReceiveInput): Promise<LightningReceiveRequest | null>;
     requestLightningSend({ encodedInvoice, idempotencyKey, amountSats, }: RequestLightningSendInput): Promise<LightningSendRequest | null>;
-    requestLeaveSwap({ adaptorPubkey, totalAmountSats, targetAmountSats, feeSats, userLeaves, idempotencyKey, }: RequestLeavesSwapInput): Promise<LeavesSwapRequest | null>;
+    requestLeaveSwap({ adaptorPubkey, totalAmountSats, targetAmountSats, feeSats, userLeaves, idempotencyKey, targetAmountSatsList, }: RequestLeavesSwapInput): Promise<LeavesSwapRequest | null>;
     completeLeaveSwap({ adaptorSecretKey, userOutboundTransferExternalId, leavesSwapRequestId, }: CompleteLeavesSwapInput): Promise<LeavesSwapRequest | null>;
     getLightningReceiveRequest(id: string): Promise<LightningReceiveRequest | null>;
     getLightningSendRequest(id: string): Promise<LightningSendRequest | null>;
@@ -305,6 +343,7 @@ declare class SspClient {
     getChallenge(): Promise<GetChallengeOutput | null>;
     verifyChallenge(signature: string, protectedChallenge: string): Promise<VerifyChallengeOutput | null>;
     authenticate(): Promise<void>;
+    getCoopExitFeeQuote({ leafExternalIds, withdrawalAddress, }: CoopExitFeeQuoteInput): Promise<CoopExitFeeQuote | null>;
 }
 
 interface Leaf {
@@ -512,4 +551,4 @@ interface RequestLightningSendInput {
     amountSats?: number | undefined;
 }
 
-export { type SwapLeaf as A, type SspClientOptions as B, type ClaimStaticDepositOutput as C, SspClient as D, ExitSpeed as E, type GetChallengeOutput as G, type HasSspClientOptions as H, type Invoice as I, type Leaf as L, type MayHaveSspClientOptions as M, type PageInfo as P, type RequestCoopExitInput as R, SparkCoopExitRequestStatus as S, Transfer as T, type UserLeafInput as U, type VerifyChallengeOutput as V, type CompleteCoopExitInput as a, type CompleteLeavesSwapInput as b, type CoopExitFeeEstimate as c, type CoopExitFeeEstimatesInput as d, type CoopExitFeeEstimatesOutput as e, type CoopExitRequest as f, getCoopExitRequestQuery as g, type CurrencyAmount as h, CurrencyUnit as i, type LeavesSwapFeeEstimateOutput as j, getLeavesSwapRequestQuery as k, type LeavesSwapRequest as l, getLightningReceiveRequestQuery as m, type LightningReceiveRequest as n, LightningReceiveRequestStatus as o, type LightningSendFeeEstimateOutput as p, getLightningSendRequestQuery as q, type LightningSendRequest as r, LightningSendRequestStatus as s, type RequestLeavesSwapInput as t, type RequestLightningReceiveInput as u, type RequestLightningSendInput as v, SparkLeavesSwapRequestStatus as w, type SparkTransferToLeavesConnection as x, type StaticDepositQuoteInput as y, type StaticDepositQuoteOutput as z };
+export { type SparkTransferToLeavesConnection as A, type StaticDepositQuoteInput as B, type ClaimStaticDepositOutput as C, type StaticDepositQuoteOutput as D, ExitSpeed as E, type SwapLeaf as F, type GetChallengeOutput as G, type HasSspClientOptions as H, type Invoice as I, type SspClientOptions as J, SspClient as K, type Leaf as L, type MayHaveSspClientOptions as M, type PageInfo as P, type RequestCoopExitInput as R, SparkCoopExitRequestStatus as S, Transfer as T, type UserLeafInput as U, type VerifyChallengeOutput as V, type CompleteCoopExitInput as a, type CompleteLeavesSwapInput as b, type CoopExitFeeEstimate as c, type CoopExitFeeEstimatesInput as d, type CoopExitFeeEstimatesOutput as e, type CoopExitFeeQuote as f, getCoopExitFeeQuoteQuery as g, type CoopExitFeeQuoteInput as h, type CoopExitRequest as i, getCoopExitRequestQuery as j, type CurrencyAmount as k, CurrencyUnit as l, type LeavesSwapFeeEstimateOutput as m, getLeavesSwapRequestQuery as n, type LeavesSwapRequest as o, getLightningReceiveRequestQuery as p, type LightningReceiveRequest as q, LightningReceiveRequestStatus as r, type LightningSendFeeEstimateOutput as s, getLightningSendRequestQuery as t, type LightningSendRequest as u, LightningSendRequestStatus as v, type RequestLeavesSwapInput as w, type RequestLightningReceiveInput as x, type RequestLightningSendInput as y, SparkLeavesSwapRequestStatus as z };

package/dist/address/index.d.cts

@@ -1,5 +1,5 @@
-import { P as PaymentIntentFields } from '../spark-CDm4gqS6.cjs';
-import { a as NetworkType } from '../network-D5lKssVl.cjs';
+import { P as PaymentIntentFields } from '../spark-C4ZrsgjC.cjs';
+import { a as NetworkType } from '../network-CfxLnaot.cjs';
 import '@bufbuild/protobuf/wire';
 import 'nice-grpc-common';
 import '@buildonspark/lrc20-sdk';

package/dist/address/index.d.ts

@@ -1,5 +1,5 @@
-import { P as PaymentIntentFields } from '../spark-CDm4gqS6.js';
-import { a as NetworkType } from '../network-xkBSpaTn.js';
+import { P as PaymentIntentFields } from '../spark-C4ZrsgjC.js';
+import { a as NetworkType } from '../network-CroCOQ0B.js';
 import '@bufbuild/protobuf/wire';
 import 'nice-grpc-common';
 import '@buildonspark/lrc20-sdk';

package/dist/address/index.js

@@ -4,8 +4,8 @@ import {
   encodeSparkAddress,
   isValidPublicKey,
   isValidSparkAddress
-} from "../chunk-O4RYNJNB.js";
-import "../chunk-M6A4KFIG.js";
+} from "../chunk-KEKGSH7B.js";
+import "../chunk-4Q2ZDYYU.js";
 import "../chunk-VTUGIIWI.js";
 import "../chunk-GSI4OLXZ.js";
 import "../chunk-MVRQ5US7.js";