@lightsparkdev/lightspark-sdk 1.9.13 → 1.9.15

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @lightsparkdev/lightspark-sdk
 
+## 1.9.15
+
+### Patch Changes
+
+- 9a7776b: Adding ability to fail HTLCs and add an idempotency key to requestWithdrawal
+- Updated dependencies [9a7776b]
+  - @lightsparkdev/core@1.4.8
+  - @lightsparkdev/crypto-wasm@0.1.22
+
+## 1.9.14
+
+### Patch Changes
+
+- Updated dependencies [8e4690a]
+- Updated dependencies [8e4690a]
+  - @lightsparkdev/core@1.4.7
+  - @lightsparkdev/crypto-wasm@0.1.21
+
 ## 1.9.13
 
 ### Patch Changes

package/dist/{chunk-K62FULET.js → chunk-TWQHQTN7.js}

@@ -9232,6 +9232,20 @@ ${FRAGMENT26}
   };
 };
 
+// src/objects/FailHtlcsOutput.ts
+var FailHtlcsOutputFromJson = (obj) => {
+  return {
+    invoiceId: obj["fail_htlcs_output_invoice"].id
+  };
+};
+var FRAGMENT27 = `
+fragment FailHtlcsOutputFragment on FailHtlcsOutput {
+    __typename
+    fail_htlcs_output_invoice: invoice {
+        id
+    }
+}`;
+
 // src/objects/FeeEstimate.ts
 var FeeEstimateFromJson = (obj) => {
   return {
@@ -9239,7 +9253,7 @@ var FeeEstimateFromJson = (obj) => {
     feeMin: CurrencyAmountFromJson(obj["fee_estimate_fee_min"])
   };
 };
-var FRAGMENT27 = `
+var FRAGMENT28 = `
 fragment FeeEstimateFragment on FeeEstimate {
     __typename
     fee_estimate_fee_fast: fee_fast {
@@ -9298,7 +9312,7 @@ var InvoiceFromJson = (obj) => {
     isLnurl: obj["invoice_is_lnurl"]
   };
 };
-var FRAGMENT28 = `
+var FRAGMENT29 = `
 fragment InvoiceFragment on Invoice {
     __typename
     invoice_id: id
@@ -9618,7 +9632,7 @@ query GetInvoice($id: ID!) {
     }
 }
 
-${FRAGMENT28}    
+${FRAGMENT29}    
 `,
     variables: { id },
     constructObject: (data) => isObject25(data) && "entity" in data && isObject25(data.entity) ? InvoiceFromJson(data.entity) : null
@@ -9626,7 +9640,7 @@ ${FRAGMENT28}
 };
 
 // src/objects/LightningFeeEstimateOutput.ts
-var FRAGMENT29 = `
+var FRAGMENT30 = `
 fragment LightningFeeEstimateOutputFragment on LightningFeeEstimateOutput {
     __typename
     lightning_fee_estimate_output_fee_estimate: fee_estimate {
@@ -9710,7 +9724,7 @@ var LightningTransactionFromJson = (obj) => {
     `Couldn't find a concrete type for interface LightningTransaction corresponding to the typename=${obj["__typename"]}`
   );
 };
-var FRAGMENT30 = `
+var FRAGMENT31 = `
 fragment LightningTransactionFragment on LightningTransaction {
     __typename
     ... on IncomingPayment {
@@ -10144,7 +10158,7 @@ query GetLightningTransaction($id: ID!) {
     }
 }
 
-${FRAGMENT30}    
+${FRAGMENT31}    
 `,
     variables: { id },
     constructObject: (data) => isObject26(data) && "entity" in data && isObject26(data.entity) ? LightningTransactionFromJson(data.entity) : null
@@ -10181,7 +10195,7 @@ var LightsparkNodeOwnerFromJson = (obj) => {
     `Couldn't find a concrete type for interface LightsparkNodeOwner corresponding to the typename=${obj["__typename"]}`
   );
 };
-var FRAGMENT31 = `
+var FRAGMENT32 = `
 fragment LightsparkNodeOwnerFragment on LightsparkNodeOwner {
     __typename
     ... on Account {
@@ -10242,7 +10256,7 @@ query GetLightsparkNodeOwner($id: ID!) {
     }
 }
 
-${FRAGMENT31}    
+${FRAGMENT32}    
 `,
     variables: { id },
     constructObject: (data) => isObject27(data) && "entity" in data && isObject27(data.entity) ? LightsparkNodeOwnerFromJson(data.entity) : null
@@ -10263,7 +10277,7 @@ var OfferFromJson = (obj) => {
     description: obj["offer_description"]
   };
 };
-var FRAGMENT32 = `
+var FRAGMENT33 = `
 fragment OfferFragment on Offer {
     __typename
     offer_id: id
@@ -10294,7 +10308,7 @@ query GetOffer($id: ID!) {
     }
 }
 
-${FRAGMENT32}    
+${FRAGMENT33}    
 `,
     variables: { id },
     constructObject: (data) => isObject28(data) && "entity" in data && isObject28(data.entity) ? OfferFromJson(data.entity) : null
@@ -10317,7 +10331,7 @@ var OfferDataFromJson = (obj) => {
     expiresAt: obj["offer_data_expires_at"]
   };
 };
-var FRAGMENT33 = `
+var FRAGMENT34 = `
 fragment OfferDataFragment on OfferData {
     __typename
     offer_data_id: id
@@ -10346,7 +10360,7 @@ query GetOfferData($id: ID!) {
     }
 }
 
-${FRAGMENT33}    
+${FRAGMENT34}    
 `,
     variables: { id },
     constructObject: (data) => isObject29(data) && "entity" in data && isObject29(data.entity) ? OfferDataFromJson(data.entity) : null
@@ -10444,7 +10458,7 @@ var OnChainTransactionFromJson = (obj) => {
     `Couldn't find a concrete type for interface OnChainTransaction corresponding to the typename=${obj["__typename"]}`
   );
 };
-var FRAGMENT34 = `
+var FRAGMENT35 = `
 fragment OnChainTransactionFragment on OnChainTransaction {
     __typename
     ... on ChannelClosingTransaction {
@@ -10587,7 +10601,7 @@ query GetOnChainTransaction($id: ID!) {
     }
 }
 
-${FRAGMENT34}    
+${FRAGMENT35}    
 `,
     variables: { id },
     constructObject: (data) => isObject30(data) && "entity" in data && isObject30(data.entity) ? OnChainTransactionFromJson(data.entity) : null
@@ -10648,7 +10662,7 @@ var RoutingTransactionFromJson = (obj) => {
     failureReason: !!obj["routing_transaction_failure_reason"] ? RoutingTransactionFailureReason_default[obj["routing_transaction_failure_reason"]] ?? RoutingTransactionFailureReason_default.FUTURE_VALUE : null
   };
 };
-var FRAGMENT35 = `
+var FRAGMENT36 = `
 fragment RoutingTransactionFragment on RoutingTransaction {
     __typename
     routing_transaction_id: id
@@ -10696,7 +10710,7 @@ query GetRoutingTransaction($id: ID!) {
     }
 }
 
-${FRAGMENT35}    
+${FRAGMENT36}    
 `,
     variables: { id },
     constructObject: (data) => isObject31(data) && "entity" in data && isObject31(data.entity) ? RoutingTransactionFromJson(data.entity) : null
@@ -10713,7 +10727,7 @@ var SignableFromJson = (obj) => {
     typename: "Signable"
   };
 };
-var FRAGMENT36 = `
+var FRAGMENT37 = `
 fragment SignableFragment on Signable {
     __typename
     signable_id: id
@@ -10731,7 +10745,7 @@ query GetSignable($id: ID!) {
     }
 }
 
-${FRAGMENT36}    
+${FRAGMENT37}    
 `,
     variables: { id },
     constructObject: (data) => isObject32(data) && "entity" in data && isObject32(data.entity) ? SignableFromJson(data.entity) : null
@@ -10768,7 +10782,7 @@ var TransactionUpdateFromJson = (obj) => {
     transactionHash: obj["transaction_hash"]
   };
 };
-var FRAGMENT37 = `
+var FRAGMENT38 = `
 fragment TransactionUpdateFragment on Transaction {
     __typename
     id
@@ -10801,7 +10815,7 @@ var UmaCurrencyFromJson = (obj) => {
     typename: "UmaCurrency"
   };
 };
-var FRAGMENT38 = `
+var FRAGMENT39 = `
 fragment UmaCurrencyFragment on UmaCurrency {
     __typename
     uma_currency_id: id
@@ -10823,7 +10837,7 @@ query GetUmaCurrency($id: ID!) {
     }
 }
 
-${FRAGMENT38}    
+${FRAGMENT39}    
 `,
     variables: { id },
     constructObject: (data) => isObject33(data) && "entity" in data && isObject33(data.entity) ? UmaCurrencyFromJson(data.entity) : null
@@ -10872,7 +10886,7 @@ var UmaInvitationFromJson = (obj) => {
     expiresAt: obj["uma_invitation_expires_at"]
   };
 };
-var FRAGMENT39 = `
+var FRAGMENT40 = `
 fragment UmaInvitationFragment on UmaInvitation {
     __typename
     uma_invitation_id: id
@@ -10907,7 +10921,7 @@ query GetUmaInvitation($id: ID!) {
     }
 }
 
-${FRAGMENT39}    
+${FRAGMENT40}    
 `,
     variables: { id },
     constructObject: (data) => isObject34(data) && "entity" in data && isObject34(data.entity) ? UmaInvitationFromJson(data.entity) : null
@@ -10945,7 +10959,7 @@ var WithdrawalFeeEstimateOutputFromJson = (obj) => {
     )
   };
 };
-var FRAGMENT40 = `
+var FRAGMENT41 = `
 fragment WithdrawalFeeEstimateOutputFragment on WithdrawalFeeEstimateOutput {
     __typename
     withdrawal_fee_estimate_output_fee_estimate: fee_estimate {
@@ -10964,7 +10978,7 @@ export {
   CurrencyAmountFromJson,
   FRAGMENT2 as FRAGMENT,
   FeeEstimateFromJson,
-  FRAGMENT27 as FRAGMENT2,
+  FRAGMENT28 as FRAGMENT2,
   NodeAddressType_default,
   GraphNode_default,
   LightsparkNodeStatus_default,
@@ -10978,14 +10992,14 @@ export {
   FRAGMENT9 as FRAGMENT3,
   PaymentRequestStatus_default,
   InvoiceFromJson,
-  FRAGMENT28 as FRAGMENT4,
+  FRAGMENT29 as FRAGMENT4,
   getInvoiceQuery,
   IncentivesIneligibilityReason_default,
   IncentivesStatus_default,
   getUmaCurrencyQuery,
   UmaInvitationStatus_default,
   UmaInvitationFromJson,
-  FRAGMENT39 as FRAGMENT5,
+  FRAGMENT40 as FRAGMENT5,
   getUmaInvitationQuery,
   Permission_default,
   ApiTokenFromJson,
@@ -10997,17 +11011,19 @@ export {
   IncomingPaymentFromJson,
   FRAGMENT12 as FRAGMENT7,
   IncomingPayment_default,
-  FRAGMENT29 as FRAGMENT8,
+  FailHtlcsOutputFromJson,
+  FRAGMENT27 as FRAGMENT8,
+  FRAGMENT30 as FRAGMENT9,
   HtlcAttemptFailureCode_default,
   OutgoingPaymentAttemptStatus_default,
   getHopQuery,
   OutgoingPaymentAttempt_default,
   PaymentFailureReason_default,
   OutgoingPaymentFromJson,
-  FRAGMENT15 as FRAGMENT9,
+  FRAGMENT15 as FRAGMENT10,
   OutgoingPayment_default,
   PaymentRequestFromJson,
-  FRAGMENT10,
+  FRAGMENT10 as FRAGMENT11,
   getPaymentRequestQuery,
   RequestInitiator_default,
   WithdrawalMode_default,
@@ -11016,16 +11032,16 @@ export {
   getChannelOpeningTransactionQuery,
   getWithdrawalQuery,
   WithdrawalRequestFromJson,
-  FRAGMENT20 as FRAGMENT11,
+  FRAGMENT20 as FRAGMENT12,
   WithdrawalRequest_default,
   RoutingTransactionFailureReason_default,
   TransactionFromJson,
-  FRAGMENT16 as FRAGMENT12,
+  FRAGMENT16 as FRAGMENT13,
   getTransactionQuery,
   TransactionUpdateFromJson,
-  FRAGMENT37 as FRAGMENT13,
+  FRAGMENT38 as FRAGMENT14,
   WithdrawalFeeEstimateOutputFromJson,
-  FRAGMENT40 as FRAGMENT14,
+  FRAGMENT41 as FRAGMENT15,
   getLightsparkNodeQuery,
   WalletStatus_default,
   Wallet_default,

package/dist/{index-tN3Kv2I2.d.cts → index-C753xMTP.d.cts}

@@ -1618,6 +1618,10 @@ interface CreateApiTokenOutput {
     clientSecret: string;
 }
 
+interface FailHtlcsOutput {
+    invoiceId: string;
+}
+
 /**
  * This object represents the estimated L1 transaction fees for the Bitcoin network. Fee estimates
  * are separated by potential confirmation speeds for settlement. *
@@ -3202,9 +3206,11 @@ declare class LightsparkClient {
      *     to create an [AMP invoice](https://docs.lightning.engineering/lightning-network-tools/lnd/amp), which can be
      *     paid multiple times.
      * @param expirySecs The number of seconds until the invoice expires. Defaults to 86400 (1 day).
+     * @param paymentHash An optional payment hash to use for the invoice.
+     * @param preimageNonce An optional 32 byte nonce used to generate the payment hash.
      * @returns An Invoice object, or undefined if the invoice could not be created.
      */
-    createInvoiceWithDetails(nodeId: string, amountMsats: number, memo: string, type?: InvoiceType | undefined, expirySecs?: number | undefined): Promise<Invoice | undefined>;
+    createInvoiceWithDetails(nodeId: string, amountMsats: number, memo: string, type?: InvoiceType | undefined, expirySecs?: number | undefined, paymentHash?: string | undefined, preimageNonce?: string | undefined): Promise<Invoice | undefined>;
     /**
      * Creates an offer for the given node.
      *
@@ -3259,6 +3265,14 @@ declare class LightsparkClient {
      * @returns The cancelled invoice, or undefined if the invoice could not be cancelled.
      */
     cancelInvoice(invoiceId: string): Promise<Invoice | undefined>;
+    /**
+     * Fails all pending HTLCs (Hash Time Locked Contracts) for a given invoice.
+     *
+     * @param invoiceId The ID of the invoice for which to fail HTLCs.
+     * @param cancelInvoice Whether to also cancel the invoice after failing the HTLCs.
+     * @returns The output containing the invoice ID, or undefined if the operation failed.
+     */
+    failHtlcs(invoiceId: string, cancelInvoice: boolean): Promise<FailHtlcsOutput | undefined>;
     /**
      * Decodes an encoded lightning invoice string.
      *
@@ -3419,7 +3433,7 @@ declare class LightsparkClient {
      * @param bitcoinAddress The Bitcoin address to withdraw funds to.
      * @param mode The mode to use for the withdrawal. See `WithdrawalMode` for more information.
      */
-    requestWithdrawal(nodeId: string, amountSats: number, bitcoinAddress: string, mode: WithdrawalMode): Promise<WithdrawalRequest>;
+    requestWithdrawal(nodeId: string, amountSats: number, bitcoinAddress: string, mode: WithdrawalMode, idempotencyKey?: string | undefined): Promise<WithdrawalRequest>;
     /**
      * Adds funds to a Lightspark node on the REGTEST network.
      * If the amount is not specified, 10,000,000 SATOSHI will be added.
@@ -4053,10 +4067,6 @@ interface FailHtlcsInput {
     cancelInvoice: boolean;
 }
 
-interface FailHtlcsOutput {
-    invoiceId: string;
-}
-
 interface FundNodeInput {
     nodeId: string;
     amountSats?: number | undefined;

package/dist/{index-BZwvqXMx.d.ts → index-COyfARTo.d.ts}

@@ -1618,6 +1618,10 @@ interface CreateApiTokenOutput {
     clientSecret: string;
 }
 
+interface FailHtlcsOutput {
+    invoiceId: string;
+}
+
 /**
  * This object represents the estimated L1 transaction fees for the Bitcoin network. Fee estimates
  * are separated by potential confirmation speeds for settlement. *
@@ -3202,9 +3206,11 @@ declare class LightsparkClient {
      *     to create an [AMP invoice](https://docs.lightning.engineering/lightning-network-tools/lnd/amp), which can be
      *     paid multiple times.
      * @param expirySecs The number of seconds until the invoice expires. Defaults to 86400 (1 day).
+     * @param paymentHash An optional payment hash to use for the invoice.
+     * @param preimageNonce An optional 32 byte nonce used to generate the payment hash.
      * @returns An Invoice object, or undefined if the invoice could not be created.
      */
-    createInvoiceWithDetails(nodeId: string, amountMsats: number, memo: string, type?: InvoiceType | undefined, expirySecs?: number | undefined): Promise<Invoice | undefined>;
+    createInvoiceWithDetails(nodeId: string, amountMsats: number, memo: string, type?: InvoiceType | undefined, expirySecs?: number | undefined, paymentHash?: string | undefined, preimageNonce?: string | undefined): Promise<Invoice | undefined>;
     /**
      * Creates an offer for the given node.
      *
@@ -3259,6 +3265,14 @@ declare class LightsparkClient {
      * @returns The cancelled invoice, or undefined if the invoice could not be cancelled.
      */
     cancelInvoice(invoiceId: string): Promise<Invoice | undefined>;
+    /**
+     * Fails all pending HTLCs (Hash Time Locked Contracts) for a given invoice.
+     *
+     * @param invoiceId The ID of the invoice for which to fail HTLCs.
+     * @param cancelInvoice Whether to also cancel the invoice after failing the HTLCs.
+     * @returns The output containing the invoice ID, or undefined if the operation failed.
+     */
+    failHtlcs(invoiceId: string, cancelInvoice: boolean): Promise<FailHtlcsOutput | undefined>;
     /**
      * Decodes an encoded lightning invoice string.
      *
@@ -3419,7 +3433,7 @@ declare class LightsparkClient {
      * @param bitcoinAddress The Bitcoin address to withdraw funds to.
      * @param mode The mode to use for the withdrawal. See `WithdrawalMode` for more information.
      */
-    requestWithdrawal(nodeId: string, amountSats: number, bitcoinAddress: string, mode: WithdrawalMode): Promise<WithdrawalRequest>;
+    requestWithdrawal(nodeId: string, amountSats: number, bitcoinAddress: string, mode: WithdrawalMode, idempotencyKey?: string | undefined): Promise<WithdrawalRequest>;
     /**
      * Adds funds to a Lightspark node on the REGTEST network.
      * If the amount is not specified, 10,000,000 SATOSHI will be added.
@@ -4053,10 +4067,6 @@ interface FailHtlcsInput {
     cancelInvoice: boolean;
 }
 
-interface FailHtlcsOutput {
-    invoiceId: string;
-}
-
 interface FundNodeInput {
     nodeId: string;
     amountSats?: number | undefined;