@lightsparkdev/lightspark-sdk 1.2.3 → 1.3.1

package/src/objects/GraphNode.ts

@@ -12,9 +12,8 @@ import { NodeToAddressesConnectionFromJson } from "./NodeToAddressesConnection.j
 
 /**
  * This object represents a node that exists on the Lightning Network,
- * including nodes not managed by Lightspark.
- * You can retrieve this object to get publicly available information about any
- * node on the Lightning Network.
+ * including nodes not managed by Lightspark. You can retrieve this object to get publicly
+ * available information about any node on the Lightning Network.
  * *
  */
 class GraphNode implements Node, Entity {
@@ -31,40 +30,34 @@ class GraphNode implements Node, Entity {
     /** The Bitcoin Network this node is deployed in. **/
     public readonly bitcoinNetwork: BitcoinNetwork,
     /**
-     * The name of this node in the network.
-     * It will be the most human-readable option possible,
+     * The name of this node in the network. It will be the most human-readable option possible,
      * depending on the data available for this node.
      **/
     public readonly displayName: string,
     /** The typename of the object **/
     public readonly typename: string,
     /**
-     * A name that identifies the node.
-     * It has no importance in terms of operating the node,
-     * it is just a way to identify and search for commercial services or
-     * popular nodes. This alias can be changed at any time by the node
-     * operator.
+     * A name that identifies the node. It has no importance in terms of operating the node,
+     * it is just a way to identify and search for commercial services or popular nodes.
+     * This alias can be changed at any time by the node operator.
      **/
     public readonly alias?: string | undefined,
     /**
-     * A hexadecimal string that describes a color. For example "#000000" is
-     * black, "#FFFFFF" is white. It has no importance in terms of operating
-     * the node,
+     * A hexadecimal string that describes a color. For example "#000000" is black, "#FFFFFF" is
+     * white. It has no importance in terms of operating the node,
      * it is just a way to visually differentiate nodes.
      * That color can be changed at any time by the node operator.
      **/
     public readonly color?: string | undefined,
     /**
-     * A summary metric used to capture how well positioned a node is to send,
-     * receive, or route transactions efficiently.
-     * Maximizing a node's conductivity helps a node’s transactions to be
-     * capital efficient. The value is an integer ranging between 0 and 10
-     * (bounds included).
+     * A summary metric used to capture how well positioned a node is to send, receive, or route
+     * transactions efficiently. Maximizing a node's conductivity helps a node’s transactions to be
+     * capital efficient. The value is an integer ranging between 0 and 10 (bounds included).
      **/
     public readonly conductivity?: number | undefined,
     /**
-     * The public key of this node. It acts as a unique identifier of this node
-     * in the Lightning Network. *
+     * The public key of this node. It acts as a unique identifier of this node in the Lightning
+     * Network. *
      */
     public readonly publicKey?: string | undefined,
   ) {

package/src/objects/Hop.ts

@@ -8,9 +8,9 @@ import {
 } from "./CurrencyAmount.js";
 
 /**
- * This object represents a specific node that existed on a particular payment
- * route. You can retrieve this object to get information about a node on a
- * particular payment path and all payment-relevant information for that node.
+ * This object represents a specific node that existed on a particular payment route.
+ * You can retrieve this object to get information about a node on a particular payment path and
+ * all payment-relevant information for that node.
  * *
  */
 interface Hop {
@@ -41,10 +41,7 @@ interface Hop {
   /** The amount that is to be forwarded to the destination node. **/
   amountToForward?: CurrencyAmount | undefined;
 
-  /**
-   * The fees to be collected by the source node for forwarding the payment
-   * over the hop. *
-   */
+  /** The fees to be collected by the source node for forwarding the payment over the hop. **/
   fee?: CurrencyAmount | undefined;
 
   /** The block height at which an unsettled HTLC is considered expired. **/

package/src/objects/HtlcAttemptFailureCode.ts

@@ -1,14 +1,13 @@
 // Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
 
 /**
- * This is an enum representing a particular reason why an htlc sent over the
- * Lightning Network may have failed. *
+ * This is an enum representing a particular reason why an htlc sent over the Lightning Network may
+ * have failed. *
  */
 export enum HtlcAttemptFailureCode {
   /**
-   * 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.
+   * 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",
 

package/src/objects/IncentivesIneligibilityReason.ts

@@ -1,46 +1,34 @@
 // Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
 
-/**
- * Describes the reason for an invitation to not be eligible for incentives.
- * *
- */
+/** Describes the reason for an invitation to not be eligible for incentives. **/
 export enum IncentivesIneligibilityReason {
   /**
-   * 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.
+   * 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",
   /**
-   * This invitation is not eligible for incentives because it has been created
-   * outside of the incentives flow. *
+   * This invitation is not eligible for incentives because it has been created outside of the
+   * incentives flow. *
    */
   DISABLED = "DISABLED",
-  /**
-   * This invitation is not eligible for incentives because the sender is not
-   * eligible. *
-   */
+  /** This invitation is not eligible for incentives because the sender is not eligible. **/
   SENDER_NOT_ELIGIBLE = "SENDER_NOT_ELIGIBLE",
-  /**
-   * This invitation is not eligible for incentives because the receiver is not
-   * eligible. *
-   */
+  /** This invitation is not eligible for incentives because the receiver is not eligible. **/
   RECEIVER_NOT_ELIGIBLE = "RECEIVER_NOT_ELIGIBLE",
   /**
-   * This invitation is not eligible for incentives because the sending VASP is
-   * not part of the incentives program.
-   * *
+   * This invitation is not eligible for incentives because the sending VASP is not part of the
+   * incentives program. *
    */
   SENDING_VASP_NOT_ELIGIBLE = "SENDING_VASP_NOT_ELIGIBLE",
   /**
-   * This invitation is not eligible for incentives because the receiving VASP
-   * is not part of the incentives program.
-   * *
+   * This invitation is not eligible for incentives because the receiving VASP is not part of the
+   * incentives program. *
    */
   RECEIVING_VASP_NOT_ELIGIBLE = "RECEIVING_VASP_NOT_ELIGIBLE",
   /**
-   * This invitation is not eligible for incentives because the sender and
-   * receiver are in the same region. *
+   * This invitation is not eligible for incentives because the sender and receiver are in the same
+   * region. *
    */
   NOT_CROSS_BORDER = "NOT_CROSS_BORDER",
 }

package/src/objects/IncentivesStatus.ts

@@ -3,23 +3,20 @@
 /** Describes the status of the incentives for this invitation. **/
 export enum IncentivesStatus {
   /**
-   * 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.
+   * 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",
   /**
-   * The invitation is eligible for incentives in its current state.
-   * When it is claimed, we will reassess.
-   * *
+   * The invitation is eligible for incentives in its current state. When it is claimed, we will
+   * reassess. *
    */
   PENDING = "PENDING",
   /** The incentives have been validated. **/
   VALIDATED = "VALIDATED",
   /**
    * This invitation is not eligible for incentives.
-   * A more detailed reason can be found in the
-   * `incentives_ineligibility_reason` field.
+   * A more detailed reason can be found in the `incentives_ineligibility_reason` field.
    * *
    */
   INELIGIBLE = "INELIGIBLE",

package/src/objects/IncomingPayment.ts

@@ -22,10 +22,9 @@ import type Transaction from "./Transaction.js";
 import TransactionStatus from "./TransactionStatus.js";
 
 /**
- * This object represents any payment sent to a Lightspark node on the
- * Lightning Network. You can retrieve this object to receive payment related
- * information about a specific payment received by a Lightspark node.
- * *
+ * This object represents any payment sent to a Lightspark node on the Lightning Network.
+ * You can retrieve this object to receive payment related information about a specific payment
+ * received by a Lightspark node. *
  */
 class IncomingPayment implements LightningTransaction, Transaction, Entity {
   constructor(
@@ -48,20 +47,14 @@ class IncomingPayment implements LightningTransaction, Transaction, Entity {
     public readonly typename: string,
     /** The date and time when this transaction was completed or failed. **/
     public readonly resolvedAt?: string | undefined,
-    /**
-     * The hash of this transaction, so it can be uniquely identified on the
-     * Lightning Network. *
-     */
+    /** The hash of this transaction, so it can be uniquely identified on the Lightning Network. **/
     public readonly transactionHash?: string | undefined,
     /**
      * The optional payment request for this incoming payment,
      * which will be null if the payment is sent through keysend.
      **/
     public readonly paymentRequestId?: string | undefined,
-    /**
-     * The post transaction data which can be used in KYT payment registration.
-     * *
-     */
+    /** The post transaction data which can be used in KYT payment registration. **/
     public readonly umaPostTransactionData?: PostTransactionData[] | undefined,
   ) {
     autoBind(this);

package/src/objects/IncomingPaymentAttempt.ts

@@ -9,10 +9,9 @@ import {
 import IncomingPaymentAttemptStatus from "./IncomingPaymentAttemptStatus.js";
 
 /**
- * This object represents any attempted payment sent to a Lightspark node on
- * the Lightning Network. You can retrieve this object to receive payment
- * related information about a specific incoming payment attempt.
- * *
+ * This object represents any attempted payment sent to a Lightspark node on the Lightning Network.
+ * You can retrieve this object to receive payment related information about a specific incoming
+ * payment attempt. *
  */
 interface IncomingPaymentAttempt {
   /**

package/src/objects/IncomingPaymentAttemptStatus.ts

@@ -1,14 +1,10 @@
 // Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
 
-/**
- * This is an enum that enumerates all potential statuses for an incoming
- * payment attempt. *
- */
+/** This is an enum that enumerates all potential statuses for an incoming payment attempt. **/
 export enum IncomingPaymentAttemptStatus {
   /**
-   * 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.
+   * 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",
 

package/src/objects/IncomingPaymentToAttemptsConnection.ts

@@ -12,15 +12,12 @@ import { PageInfoFromJson, PageInfoToJson } from "./PageInfo.js";
 interface IncomingPaymentToAttemptsConnection {
   /**
    * The total count of objects in this connection, using the current filters.
-   * It is different from the number of objects returned in the current page
-   * (in the `entities` field).
+   * It is different from the number of objects returned in the current page (in the `entities`
+   * field).
    **/
   count: number;
 
-  /**
-   * An object that holds pagination information about the objects in this
-   * connection. *
-   */
+  /** An object that holds pagination information about the objects in this connection. **/
   pageInfo: PageInfo;
 
   /** The incoming payment attempts for the current page of this connection. **/

package/src/objects/InvoiceData.ts

@@ -11,8 +11,8 @@ import { NodeFromJson, NodeToJson } from "./Node.js";
 
 /**
  * This object represents the data associated with a BOLT #11 invoice.
- * You can retrieve this object to receive the relevant data associated with a
- * specific invoice. *
+ * You can retrieve this object to receive the relevant data associated with a specific invoice.
+ * *
  */
 interface InvoiceData {
   encodedPaymentRequest: string;

package/src/objects/InvoiceType.ts

@@ -3,9 +3,8 @@
 /** This is an enum for potential invoice types. **/
 export enum InvoiceType {
   /**
-   * 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.
+   * 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",
   /** A standard Bolt 11 invoice. **/

package/src/objects/LightningFeeEstimateForInvoiceInput.ts

@@ -8,8 +8,8 @@ interface LightningFeeEstimateForInvoiceInput {
   encodedPaymentRequest: string;
 
   /**
-   * If the invoice does not specify a payment amount,
-   * then the amount that you wish to pay, expressed in msats.
+   * If the invoice does not specify a payment amount, then the amount that you wish to pay,
+   * expressed in msats.
    **/
   amountMsats?: number | undefined;
 }

package/src/objects/LightningTransaction.ts

@@ -23,10 +23,9 @@ import RoutingTransactionFailureReason from "./RoutingTransactionFailureReason.j
 import TransactionStatus from "./TransactionStatus.js";
 
 /**
- * This is an object representing a transaction made over the Lightning
- * Network. You can retrieve this object to receive information about a
- * specific transaction made over Lightning for a Lightspark node.
- * *
+ * This is an object representing a transaction made over the Lightning Network.
+ * You can retrieve this object to receive information about a specific transaction made over
+ * Lightning for a Lightspark node. *
  */
 interface LightningTransaction {
   /**
@@ -53,10 +52,7 @@ interface LightningTransaction {
   /** The date and time when this transaction was completed or failed. **/
   resolvedAt?: string | undefined;
 
-  /**
-   * The hash of this transaction, so it can be uniquely identified on the
-   * Lightning Network. *
-   */
+  /** The hash of this transaction, so it can be uniquely identified on the Lightning Network. **/
   transactionHash?: string | undefined;
 }
 

package/src/objects/LightsparkNode.ts

@@ -25,9 +25,9 @@ import type NodeToAddressesConnection from "./NodeToAddressesConnection.js";
 import { SecretFromJson, SecretToJson } from "./Secret.js";
 
 /**
- * This is an object representing a node managed by Lightspark and owned by the
- * current connected account. This object contains information about the node’s
- * configuration, state, and metadata. *
+ * This is an object representing a node managed by Lightspark and owned by the current connected
+ * account. This object contains information about the node’s configuration, state, and metadata.
+ * *
  */
 interface LightsparkNode {
   /**
@@ -46,8 +46,7 @@ interface LightsparkNode {
   bitcoinNetwork: BitcoinNetwork;
 
   /**
-   * The name of this node in the network.
-   * It will be the most human-readable option possible,
+   * The name of this node in the network. It will be the most human-readable option possible,
    * depending on the data available for this node.
    **/
   displayName: string;
@@ -56,8 +55,8 @@ interface LightsparkNode {
   ownerId: string;
 
   /**
-   * The utxos of the channels that are connected to this node.
-   * This is used in uma flow for pre-screening.
+   * The utxos of the channels that are connected to this node. This is used in uma flow for
+   * pre-screening.
    **/
   umaPrescreeningUtxos: string[];
 
@@ -65,34 +64,30 @@ interface LightsparkNode {
   typename: string;
 
   /**
-   * A name that identifies the node. It has no importance in terms of
-   * operating the node, it is just a way to identify and search for commercial
-   * services or popular nodes. This alias can be changed at any time by the
-   * node operator.
+   * A name that identifies the node. It has no importance in terms of operating the node,
+   * it is just a way to identify and search for commercial services or popular nodes.
+   * This alias can be changed at any time by the node operator.
    **/
   alias?: string | undefined;
 
   /**
-   * A hexadecimal string that describes a color. For example "#000000" is
-   * black, "#FFFFFF" is white. It has no importance in terms of operating the
-   * node,
+   * A hexadecimal string that describes a color. For example "#000000" is black, "#FFFFFF" is
+   * white. It has no importance in terms of operating the node,
    * it is just a way to visually differentiate nodes.
    * That color can be changed at any time by the node operator.
    **/
   color?: string | undefined;
 
   /**
-   * A summary metric used to capture how well positioned a node is to send,
-   * receive, or route transactions efficiently.
-   * Maximizing a node's conductivity helps a node’s transactions to be capital
-   * efficient. The value is an integer ranging between 0 and 10 (bounds
-   * included).
+   * A summary metric used to capture how well positioned a node is to send, receive, or route
+   * transactions efficiently. Maximizing a node's conductivity helps a node’s transactions to be
+   * capital efficient. The value is an integer ranging between 0 and 10 (bounds included).
    **/
   conductivity?: number | undefined;
 
   /**
-   * The public key of this node. It acts as a unique identifier of this node
-   * in the Lightning Network. *
+   * The public key of this node. It acts as a unique identifier of this node in the Lightning
+   * Network. *
    */
   publicKey?: string | undefined;
 
@@ -100,8 +95,8 @@ interface LightsparkNode {
   status?: LightsparkNodeStatus | undefined;
 
   /**
-   * The sum of the balance on the Bitcoin Network, channel balances,
-   * and commit fees on this node.
+   * The sum of the balance on the Bitcoin Network, channel balances, and commit fees on this
+   * node.
    *
    * @deprecated Use `balances` instead.
    **/
@@ -115,8 +110,7 @@ interface LightsparkNode {
   totalLocalBalance?: CurrencyAmount | undefined;
 
   /**
-   * The sum of the channel balances (online only) that are available to send
-   * on this node.
+   * The sum of the channel balances (online only) that are available to send on this node.
    *
    * @deprecated Use `balances` instead.
    **/

package/src/objects/LightsparkNodeStatus.ts

@@ -2,9 +2,8 @@
 
 export enum LightsparkNodeStatus {
   /**
-   * 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.
+   * 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",
 

package/src/objects/LightsparkNodeToChannelsConnection.ts

@@ -8,15 +8,12 @@ import { PageInfoFromJson, PageInfoToJson } from "./PageInfo.js";
 interface LightsparkNodeToChannelsConnection {
   /**
    * The total count of objects in this connection, using the current filters.
-   * It is different from the number of objects returned in the current page
-   * (in the `entities` field).
+   * It is different from the number of objects returned in the current page (in the `entities`
+   * field).
    **/
   count: number;
 
-  /**
-   * An object that holds pagination information about the objects in this
-   * connection. *
-   */
+  /** An object that holds pagination information about the objects in this connection. **/
   pageInfo: PageInfo;
 
   /** The channels for the current page of this connection. **/

package/src/objects/LightsparkNodeWithOSK.ts

@@ -44,54 +44,48 @@ class LightsparkNodeWithOSK implements LightsparkNode, Node, Entity {
     /** The Bitcoin Network this node is deployed in. **/
     public readonly bitcoinNetwork: BitcoinNetwork,
     /**
-     * The name of this node in the network.
-     * It will be the most human-readable option possible,
+     * The name of this node in the network. It will be the most human-readable option possible,
      * depending on the data available for this node.
      **/
     public readonly displayName: string,
     /** The owner of this LightsparkNode. **/
     public readonly ownerId: string,
     /**
-     * The utxos of the channels that are connected to this node.
-     * This is used in uma flow for pre-screening.
+     * The utxos of the channels that are connected to this node. This is used in uma flow for
+     * pre-screening.
      **/
     public readonly umaPrescreeningUtxos: string[],
     /** The typename of the object **/
     public readonly typename: string,
     /**
-     * A name that identifies the node.
-     * It has no importance in terms of operating the node,
-     * it is just a way to identify and search for commercial services or
-     * popular nodes. This alias can be changed at any time by the node
-     * operator.
+     * A name that identifies the node. It has no importance in terms of operating the node,
+     * it is just a way to identify and search for commercial services or popular nodes.
+     * This alias can be changed at any time by the node operator.
      **/
     public readonly alias?: string | undefined,
     /**
-     * A hexadecimal string that describes a color. For example "#000000" is
-     * black, "#FFFFFF" is white. It has no importance in terms of operating
-     * the node,
+     * A hexadecimal string that describes a color. For example "#000000" is black, "#FFFFFF" is
+     * white. It has no importance in terms of operating the node,
      * it is just a way to visually differentiate nodes.
      * That color can be changed at any time by the node operator.
      **/
     public readonly color?: string | undefined,
     /**
-     * A summary metric used to capture how well positioned a node is to send,
-     * receive, or route transactions efficiently.
-     * Maximizing a node's conductivity helps a node’s transactions to be
-     * capital efficient. The value is an integer ranging between 0 and 10
-     * (bounds included).
+     * A summary metric used to capture how well positioned a node is to send, receive, or route
+     * transactions efficiently. Maximizing a node's conductivity helps a node’s transactions to be
+     * capital efficient. The value is an integer ranging between 0 and 10 (bounds included).
      **/
     public readonly conductivity?: number | undefined,
     /**
-     * The public key of this node. It acts as a unique identifier of this node
-     * in the Lightning Network. *
+     * The public key of this node. It acts as a unique identifier of this node in the Lightning
+     * Network. *
      */
     public readonly publicKey?: string | undefined,
     /** The current status of this node. **/
     public readonly status?: LightsparkNodeStatus | undefined,
     /**
-     * The sum of the balance on the Bitcoin Network, channel balances,
-     * and commit fees on this node.
+     * The sum of the balance on the Bitcoin Network, channel balances, and commit fees on this
+     * node.
      *
      * @deprecated Use `balances` instead.
      **/
@@ -103,15 +97,13 @@ class LightsparkNodeWithOSK implements LightsparkNode, Node, Entity {
      **/
     public readonly totalLocalBalance?: CurrencyAmount | undefined,
     /**
-     * The sum of the channel balances (online only) that are available to send
-     * on this node.
+     * The sum of the channel balances (online only) that are available to send on this node.
      *
      * @deprecated Use `balances` instead.
      **/
     public readonly localBalance?: CurrencyAmount | undefined,
     /**
-     * The sum of the channel balances that are available to receive on this
-     * node.
+     * The sum of the channel balances that are available to receive on this node.
      *
      * @deprecated Use `balances` instead.
      **/
@@ -125,8 +117,8 @@ class LightsparkNodeWithOSK implements LightsparkNode, Node, Entity {
     /** The balances that describe the funds in this node. **/
     public readonly balances?: Balances | undefined,
     /**
-     * The private key client is using to sign a GraphQL request which will be
-     * verified at server side. *
+     * The private key client is using to sign a GraphQL request which will be verified at server
+     * side. *
      */
     public readonly encryptedSigningPrivateKey?: Secret | undefined,
   ) {