@lightsparkdev/lightspark-sdk 1.5.13 → 1.6.0

package/src/objects/LightsparkNodeWithOSK.ts

@@ -161,15 +161,17 @@ query FetchNodeToAddressesConnection($entity_id: ID!, $first: Int, $types: [Node
   public async getChannels(
     client: LightsparkClient,
     first: number | undefined = undefined,
-    statuses: ChannelStatus[] | undefined = undefined,
     after: string | undefined = undefined,
+    beforeDate: string | undefined = undefined,
+    afterDate: string | undefined = undefined,
+    statuses: ChannelStatus[] | undefined = undefined,
   ): Promise<LightsparkNodeToChannelsConnection> {
     return (await client.executeRawQuery({
       queryPayload: ` 
-query FetchLightsparkNodeToChannelsConnection($entity_id: ID!, $first: Int, $statuses: [ChannelStatus!], $after: String) {
+query FetchLightsparkNodeToChannelsConnection($entity_id: ID!, $first: Int, $after: String, $before_date: DateTime, $after_date: DateTime, $statuses: [ChannelStatus!]) {
     entity(id: $entity_id) {
         ... on LightsparkNodeWithOSK {
-            channels(, first: $first, statuses: $statuses, after: $after) {
+            channels(, first: $first, after: $after, before_date: $before_date, after_date: $after_date, statuses: $statuses) {
                 __typename
                 lightspark_node_to_channels_connection_count: count
                 lightspark_node_to_channels_connection_page_info: page_info {
@@ -281,8 +283,10 @@ query FetchLightsparkNodeToChannelsConnection($entity_id: ID!, $first: Int, $sta
       variables: {
         entity_id: this.id,
         first: first,
-        statuses: statuses,
         after: after,
+        before_date: beforeDate,
+        after_date: afterDate,
+        statuses: statuses,
       },
       constructObject: (json) => {
         const connection = json["entity"]["channels"];

package/src/objects/LightsparkNodeWithRemoteSigning.ts

@@ -154,15 +154,17 @@ query FetchNodeToAddressesConnection($entity_id: ID!, $first: Int, $types: [Node
   public async getChannels(
     client: LightsparkClient,
     first: number | undefined = undefined,
-    statuses: ChannelStatus[] | undefined = undefined,
     after: string | undefined = undefined,
+    beforeDate: string | undefined = undefined,
+    afterDate: string | undefined = undefined,
+    statuses: ChannelStatus[] | undefined = undefined,
   ): Promise<LightsparkNodeToChannelsConnection> {
     return (await client.executeRawQuery({
       queryPayload: ` 
-query FetchLightsparkNodeToChannelsConnection($entity_id: ID!, $first: Int, $statuses: [ChannelStatus!], $after: String) {
+query FetchLightsparkNodeToChannelsConnection($entity_id: ID!, $first: Int, $after: String, $before_date: DateTime, $after_date: DateTime, $statuses: [ChannelStatus!]) {
     entity(id: $entity_id) {
         ... on LightsparkNodeWithRemoteSigning {
-            channels(, first: $first, statuses: $statuses, after: $after) {
+            channels(, first: $first, after: $after, before_date: $before_date, after_date: $after_date, statuses: $statuses) {
                 __typename
                 lightspark_node_to_channels_connection_count: count
                 lightspark_node_to_channels_connection_page_info: page_info {
@@ -274,8 +276,10 @@ query FetchLightsparkNodeToChannelsConnection($entity_id: ID!, $first: Int, $sta
       variables: {
         entity_id: this.id,
         first: first,
-        statuses: statuses,
         after: after,
+        before_date: beforeDate,
+        after_date: afterDate,
+        statuses: statuses,
       },
       constructObject: (json) => {
         const connection = json["entity"]["channels"];

package/src/objects/OnChainFeeTarget.ts

@@ -0,0 +1,19 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+export enum OnChainFeeTarget {
+  /**
+   * This is an enum value that represents values that could be added in the future.
+   * Clients should support unknown values as more of them could be added without notice.
+   */
+  FUTURE_VALUE = "FUTURE_VALUE",
+  /** Transaction expected to be confirmed within 2 blocks. **/
+  HIGH = "HIGH",
+  /** Transaction expected to be confirmed within 6 blocks. **/
+  MEDIUM = "MEDIUM",
+  /** Transaction expected to be confirmed within 18 blocks. **/
+  LOW = "LOW",
+  /** Transaction expected to be confirmed within 50 blocks. **/
+  BACKGROUND = "BACKGROUND",
+}
+
+export default OnChainFeeTarget;

package/src/objects/OnChainTransaction.ts

@@ -54,10 +54,7 @@ interface OnChainTransaction {
   /** The hash of this transaction, so it can be uniquely identified on the Lightning Network. **/
   transactionHash?: string | undefined;
 
-  /**
-   * The fees that were paid by the wallet sending the transaction to commit it to the Bitcoin
-   * blockchain.
-   **/
+  /** The fees that were paid by the node for this transaction. **/
   fees?: CurrencyAmount | undefined;
 
   /**

package/src/objects/OutgoingPayment.ts

@@ -77,6 +77,8 @@ class OutgoingPayment implements LightningTransaction, Transaction, Entity {
     public readonly umaPostTransactionData?: PostTransactionData[] | undefined,
     /** The preimage of the payment. **/
     public readonly paymentPreimage?: string | undefined,
+    /** The idempotency key of the payment. **/
+    public readonly idempotencyKey?: string | undefined,
   ) {
     autoBind(this);
   }
@@ -192,6 +194,7 @@ ${FRAGMENT}
         this.umaPostTransactionData?.map((e) => PostTransactionDataToJson(e)),
       outgoing_payment_payment_preimage: this.paymentPreimage,
       outgoing_payment_is_internal_payment: this.isInternalPayment,
+      outgoing_payment_idempotency_key: this.idempotencyKey,
     };
   }
 }
@@ -228,6 +231,7 @@ export const OutgoingPaymentFromJson = (obj: any): OutgoingPayment => {
       PostTransactionDataFromJson(e),
     ),
     obj["outgoing_payment_payment_preimage"],
+    obj["outgoing_payment_idempotency_key"],
   );
 };
 
@@ -576,6 +580,7 @@ fragment OutgoingPaymentFragment on OutgoingPayment {
     }
     outgoing_payment_payment_preimage: payment_preimage
     outgoing_payment_is_internal_payment: is_internal_payment
+    outgoing_payment_idempotency_key: idempotency_key
 }`;
 
 export default OutgoingPayment;

package/src/objects/OutgoingPaymentForIdempotencyKeyInput.ts

@@ -0,0 +1,24 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+interface OutgoingPaymentForIdempotencyKeyInput {
+  idempotencyKey: string;
+}
+
+export const OutgoingPaymentForIdempotencyKeyInputFromJson = (
+  obj: any,
+): OutgoingPaymentForIdempotencyKeyInput => {
+  return {
+    idempotencyKey:
+      obj["outgoing_payment_for_idempotency_key_input_idempotency_key"],
+  } as OutgoingPaymentForIdempotencyKeyInput;
+};
+export const OutgoingPaymentForIdempotencyKeyInputToJson = (
+  obj: OutgoingPaymentForIdempotencyKeyInput,
+): any => {
+  return {
+    outgoing_payment_for_idempotency_key_input_idempotency_key:
+      obj.idempotencyKey,
+  };
+};
+
+export default OutgoingPaymentForIdempotencyKeyInput;

package/src/objects/OutgoingPaymentForIdempotencyKeyOutput.ts

@@ -0,0 +1,33 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+interface OutgoingPaymentForIdempotencyKeyOutput {
+  paymentId?: string | undefined;
+}
+
+export const OutgoingPaymentForIdempotencyKeyOutputFromJson = (
+  obj: any,
+): OutgoingPaymentForIdempotencyKeyOutput => {
+  return {
+    paymentId:
+      obj["outgoing_payment_for_idempotency_key_output_payment"]?.id ??
+      undefined,
+  } as OutgoingPaymentForIdempotencyKeyOutput;
+};
+export const OutgoingPaymentForIdempotencyKeyOutputToJson = (
+  obj: OutgoingPaymentForIdempotencyKeyOutput,
+): any => {
+  return {
+    outgoing_payment_for_idempotency_key_output_payment:
+      { id: obj.paymentId } ?? undefined,
+  };
+};
+
+export const FRAGMENT = `
+fragment OutgoingPaymentForIdempotencyKeyOutputFragment on OutgoingPaymentForIdempotencyKeyOutput {
+    __typename
+    outgoing_payment_for_idempotency_key_output_payment: payment {
+        id
+    }
+}`;
+
+export default OutgoingPaymentForIdempotencyKeyOutput;

package/src/objects/OutgoingPaymentsForInvoiceQueryOutput.ts

@@ -373,6 +373,7 @@ fragment OutgoingPaymentsForInvoiceQueryOutputFragment on OutgoingPaymentsForInv
         }
         outgoing_payment_payment_preimage: payment_preimage
         outgoing_payment_is_internal_payment: is_internal_payment
+        outgoing_payment_idempotency_key: idempotency_key
     }
 }`;
 

package/src/objects/OutgoingPaymentsForPaymentHashQueryInput.ts

@@ -0,0 +1,34 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+import TransactionStatus from "./TransactionStatus.js";
+
+interface OutgoingPaymentsForPaymentHashQueryInput {
+  /** The 32-byte hash of the payment preimage for which to fetch payments **/
+  paymentHash: string;
+
+  /** An optional filter to only query outgoing payments of given statuses. **/
+  statuses?: TransactionStatus[] | undefined;
+}
+
+export const OutgoingPaymentsForPaymentHashQueryInputFromJson = (
+  obj: any,
+): OutgoingPaymentsForPaymentHashQueryInput => {
+  return {
+    paymentHash:
+      obj["outgoing_payments_for_payment_hash_query_input_payment_hash"],
+    statuses: obj[
+      "outgoing_payments_for_payment_hash_query_input_statuses"
+    ]?.map((e) => TransactionStatus[e]),
+  } as OutgoingPaymentsForPaymentHashQueryInput;
+};
+export const OutgoingPaymentsForPaymentHashQueryInputToJson = (
+  obj: OutgoingPaymentsForPaymentHashQueryInput,
+): any => {
+  return {
+    outgoing_payments_for_payment_hash_query_input_payment_hash:
+      obj.paymentHash,
+    outgoing_payments_for_payment_hash_query_input_statuses: obj.statuses,
+  };
+};
+
+export default OutgoingPaymentsForPaymentHashQueryInput;

package/src/objects/OutgoingPaymentsForPaymentHashQueryOutput.ts

@@ -0,0 +1,37 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+import type OutgoingPayment from "./OutgoingPayment.js";
+import { OutgoingPaymentFromJson } from "./OutgoingPayment.js";
+
+interface OutgoingPaymentsForPaymentHashQueryOutput {
+  payments: OutgoingPayment[];
+}
+
+export const OutgoingPaymentsForPaymentHashQueryOutputFromJson = (
+  obj: any,
+): OutgoingPaymentsForPaymentHashQueryOutput => {
+  return {
+    payments: obj[
+      "outgoing_payments_for_payment_hash_query_output_payments"
+    ].map((e) => OutgoingPaymentFromJson(e)),
+  } as OutgoingPaymentsForPaymentHashQueryOutput;
+};
+export const OutgoingPaymentsForPaymentHashQueryOutputToJson = (
+  obj: OutgoingPaymentsForPaymentHashQueryOutput,
+): any => {
+  return {
+    outgoing_payments_for_payment_hash_query_output_payments: obj.payments.map(
+      (e) => e.toJson(),
+    ),
+  };
+};
+
+export const FRAGMENT = `
+fragment OutgoingPaymentsForPaymentHashQueryOutputFragment on OutgoingPaymentsForPaymentHashQueryOutput {
+    __typename
+    outgoing_payments_for_payment_hash_query_output_payments: payments {
+        id
+    }
+}`;
+
+export default OutgoingPaymentsForPaymentHashQueryOutput;

package/src/objects/PayInvoiceInput.ts

@@ -21,6 +21,12 @@ interface PayInvoiceInput {
    * invoice amount is zero.
    **/
   amountMsats?: number | undefined;
+
+  /**
+   * The idempotency key of the request. The same result will be returned for the same
+   * idempotency key. *
+   */
+  idempotencyKey?: string | undefined;
 }
 
 export const PayInvoiceInputFromJson = (obj: any): PayInvoiceInput => {
@@ -30,6 +36,7 @@ export const PayInvoiceInputFromJson = (obj: any): PayInvoiceInput => {
     timeoutSecs: obj["pay_invoice_input_timeout_secs"],
     maximumFeesMsats: obj["pay_invoice_input_maximum_fees_msats"],
     amountMsats: obj["pay_invoice_input_amount_msats"],
+    idempotencyKey: obj["pay_invoice_input_idempotency_key"],
   } as PayInvoiceInput;
 };
 export const PayInvoiceInputToJson = (obj: PayInvoiceInput): any => {
@@ -39,6 +46,7 @@ export const PayInvoiceInputToJson = (obj: PayInvoiceInput): any => {
     pay_invoice_input_timeout_secs: obj.timeoutSecs,
     pay_invoice_input_maximum_fees_msats: obj.maximumFeesMsats,
     pay_invoice_input_amount_msats: obj.amountMsats,
+    pay_invoice_input_idempotency_key: obj.idempotencyKey,
   };
 };
 

package/src/objects/PayUmaInvoiceInput.ts

@@ -10,6 +10,8 @@ interface PayUmaInvoiceInput {
   maximumFeesMsats: number;
 
   amountMsats?: number | undefined;
+
+  idempotencyKey?: string | undefined;
 }
 
 export const PayUmaInvoiceInputFromJson = (obj: any): PayUmaInvoiceInput => {
@@ -19,6 +21,7 @@ export const PayUmaInvoiceInputFromJson = (obj: any): PayUmaInvoiceInput => {
     timeoutSecs: obj["pay_uma_invoice_input_timeout_secs"],
     maximumFeesMsats: obj["pay_uma_invoice_input_maximum_fees_msats"],
     amountMsats: obj["pay_uma_invoice_input_amount_msats"],
+    idempotencyKey: obj["pay_uma_invoice_input_idempotency_key"],
   } as PayUmaInvoiceInput;
 };
 export const PayUmaInvoiceInputToJson = (obj: PayUmaInvoiceInput): any => {
@@ -28,6 +31,7 @@ export const PayUmaInvoiceInputToJson = (obj: PayUmaInvoiceInput): any => {
     pay_uma_invoice_input_timeout_secs: obj.timeoutSecs,
     pay_uma_invoice_input_maximum_fees_msats: obj.maximumFeesMsats,
     pay_uma_invoice_input_amount_msats: obj.amountMsats,
+    pay_uma_invoice_input_idempotency_key: obj.idempotencyKey,
   };
 };
 

package/src/objects/PaymentFailureReason.ts

@@ -32,6 +32,8 @@ export enum PaymentFailureReason {
   INVOICE_CANCELLED = "INVOICE_CANCELLED",
 
   RISK_SCREENING_FAILED = "RISK_SCREENING_FAILED",
+
+  INSUFFICIENT_BALANCE_ON_SINGLE_PATH_INVOICE = "INSUFFICIENT_BALANCE_ON_SINGLE_PATH_INVOICE",
 }
 
 export default PaymentFailureReason;

package/src/objects/RemoteSigningSubEventType.ts

@@ -23,6 +23,8 @@ export enum RemoteSigningSubEventType {
   REQUEST_INVOICE_PAYMENT_HASH = "REQUEST_INVOICE_PAYMENT_HASH",
 
   REVEAL_COUNTERPARTY_PER_COMMITMENT_SECRET = "REVEAL_COUNTERPARTY_PER_COMMITMENT_SECRET",
+
+  VLS_MESSAGE = "VLS_MESSAGE",
 }
 
 export default RemoteSigningSubEventType;

package/src/objects/RequestWithdrawalInput.ts

@@ -1,5 +1,6 @@
 // Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
 
+import OnChainFeeTarget from "./OnChainFeeTarget.js";
 import WithdrawalMode from "./WithdrawalMode.js";
 
 interface RequestWithdrawalInput {
@@ -17,6 +18,25 @@ interface RequestWithdrawalInput {
 
   /** The strategy that should be used to withdraw the funds from this node. **/
   withdrawalMode: WithdrawalMode;
+
+  /**
+   * The idempotency key of the request. The same result will be returned for the same
+   * idempotency key. *
+   */
+  idempotencyKey?: string | undefined;
+
+  /**
+   * The target of the fee that should be used when crafting the L1 transaction. You should only
+   * set `fee_target` or `sats_per_vbyte`. If neither of them is set, default value of MEDIUM
+   * will be used as `fee_target`.
+   **/
+  feeTarget?: OnChainFeeTarget | undefined;
+
+  /**
+   * A manual fee rate set in sat/vbyte that should be used when crafting the L1 transaction. You
+   * should only set `fee_target` or `sats_per_vbyte`
+   **/
+  satsPerVbyte?: number | undefined;
 }
 
 export const RequestWithdrawalInputFromJson = (
@@ -29,6 +49,12 @@ export const RequestWithdrawalInputFromJson = (
     withdrawalMode:
       WithdrawalMode[obj["request_withdrawal_input_withdrawal_mode"]] ??
       WithdrawalMode.FUTURE_VALUE,
+    idempotencyKey: obj["request_withdrawal_input_idempotency_key"],
+    feeTarget: !!obj["request_withdrawal_input_fee_target"]
+      ? OnChainFeeTarget[obj["request_withdrawal_input_fee_target"]] ??
+        OnChainFeeTarget.FUTURE_VALUE
+      : null,
+    satsPerVbyte: obj["request_withdrawal_input_sats_per_vbyte"],
   } as RequestWithdrawalInput;
 };
 export const RequestWithdrawalInputToJson = (
@@ -39,6 +65,9 @@ export const RequestWithdrawalInputToJson = (
     request_withdrawal_input_bitcoin_address: obj.bitcoinAddress,
     request_withdrawal_input_amount_sats: obj.amountSats,
     request_withdrawal_input_withdrawal_mode: obj.withdrawalMode,
+    request_withdrawal_input_idempotency_key: obj.idempotencyKey,
+    request_withdrawal_input_fee_target: obj.feeTarget,
+    request_withdrawal_input_sats_per_vbyte: obj.satsPerVbyte,
   };
 };
 

package/src/objects/SendPaymentInput.ts

@@ -18,6 +18,12 @@ interface SendPaymentInput {
    * msats. *
    */
   maximumFeesMsats: number;
+
+  /**
+   * The idempotency key of the request. The same result will be returned for the same
+   * idempotency key. *
+   */
+  idempotencyKey?: string | undefined;
 }
 
 export const SendPaymentInputFromJson = (obj: any): SendPaymentInput => {
@@ -27,6 +33,7 @@ export const SendPaymentInputFromJson = (obj: any): SendPaymentInput => {
     timeoutSecs: obj["send_payment_input_timeout_secs"],
     amountMsats: obj["send_payment_input_amount_msats"],
     maximumFeesMsats: obj["send_payment_input_maximum_fees_msats"],
+    idempotencyKey: obj["send_payment_input_idempotency_key"],
   } as SendPaymentInput;
 };
 export const SendPaymentInputToJson = (obj: SendPaymentInput): any => {
@@ -36,6 +43,7 @@ export const SendPaymentInputToJson = (obj: SendPaymentInput): any => {
     send_payment_input_timeout_secs: obj.timeoutSecs,
     send_payment_input_amount_msats: obj.amountMsats,
     send_payment_input_maximum_fees_msats: obj.maximumFeesMsats,
+    send_payment_input_idempotency_key: obj.idempotencyKey,
   };
 };
 

package/src/objects/Transaction.ts

@@ -183,6 +183,7 @@ export const TransactionFromJson = (obj: any): Transaction => {
         PostTransactionDataFromJson(e),
       ),
       obj["outgoing_payment_payment_preimage"],
+      obj["outgoing_payment_idempotency_key"],
     );
   }
   if (obj["__typename"] == "RoutingTransaction") {
@@ -380,6 +381,7 @@ export const TransactionToJson = (obj: Transaction): any => {
         ),
       outgoing_payment_payment_preimage: outgoingPayment.paymentPreimage,
       outgoing_payment_is_internal_payment: outgoingPayment.isInternalPayment,
+      outgoing_payment_idempotency_key: outgoingPayment.idempotencyKey,
     };
   }
   if (obj.typename == "RoutingTransaction") {
@@ -915,6 +917,7 @@ fragment TransactionFragment on Transaction {
         }
         outgoing_payment_payment_preimage: payment_preimage
         outgoing_payment_is_internal_payment: is_internal_payment
+        outgoing_payment_idempotency_key: idempotency_key
     }
     ... on RoutingTransaction {
         __typename

package/src/objects/TransactionStatus.ts

@@ -10,7 +10,7 @@ export enum TransactionStatus {
    * Clients should support unknown values as more of them could be added without notice.
    */
   FUTURE_VALUE = "FUTURE_VALUE",
-  /** Transaction succeeded.. **/
+  /** Transaction succeeded. **/
   SUCCESS = "SUCCESS",
   /** Transaction failed. **/
   FAILED = "FAILED",

package/src/objects/Wallet.ts

@@ -557,6 +557,7 @@ query FetchWalletToTransactionsConnection($entity_id: ID!, $first: Int, $after:
                         }
                         outgoing_payment_payment_preimage: payment_preimage
                         outgoing_payment_is_internal_payment: is_internal_payment
+                        outgoing_payment_idempotency_key: idempotency_key
                     }
                     ... on RoutingTransaction {
                         __typename
@@ -1092,6 +1093,14 @@ query FetchWalletToWithdrawalRequestsConnection($entity_id: ID!, $first: Int, $a
                         currency_amount_preferred_currency_value_rounded: preferred_currency_value_rounded
                         currency_amount_preferred_currency_value_approx: preferred_currency_value_approx
                     }
+                    withdrawal_request_total_fees: total_fees {
+                        __typename
+                        currency_amount_original_value: original_value
+                        currency_amount_original_unit: original_unit
+                        currency_amount_preferred_currency_unit: preferred_currency_unit
+                        currency_amount_preferred_currency_value_rounded: preferred_currency_value_rounded
+                        currency_amount_preferred_currency_value_approx: preferred_currency_value_approx
+                    }
                     withdrawal_request_bitcoin_address: bitcoin_address
                     withdrawal_request_withdrawal_mode: withdrawal_mode
                     withdrawal_request_status: status
@@ -1099,6 +1108,7 @@ query FetchWalletToWithdrawalRequestsConnection($entity_id: ID!, $first: Int, $a
                     withdrawal_request_withdrawal: withdrawal {
                         id
                     }
+                    withdrawal_request_idempotency_key: idempotency_key
                 }
             }
         }

package/src/objects/Withdrawal.ts

@@ -53,10 +53,7 @@ interface Withdrawal {
   /** The hash of this transaction, so it can be uniquely identified on the Lightning Network. **/
   transactionHash?: string | undefined;
 
-  /**
-   * The fees that were paid by the wallet sending the transaction to commit it to the Bitcoin
-   * blockchain.
-   **/
+  /** The fees that were paid by the node for this transaction. **/
   fees?: CurrencyAmount | undefined;
 
   /**