@lightsparkdev/lightspark-sdk 1.2.3 → 1.3.1

package/src/objects/LightsparkNodeWithRemoteSigning.ts

@@ -42,54 +42,48 @@ class LightsparkNodeWithRemoteSigning 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.
      **/
@@ -101,15 +95,13 @@ class LightsparkNodeWithRemoteSigning 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.
      **/

package/src/objects/Node.ts

@@ -21,9 +21,8 @@ import type NodeToAddressesConnection from "./NodeToAddressesConnection.js";
 import { SecretFromJson, SecretToJson } from "./Secret.js";
 
 /**
- * This object is an interface representing a Lightning Node on the Lightning
- * Network, and could either be a Lightspark node or a node managed by a third
- * party.
+ * This object is an interface representing a Lightning Node on the Lightning Network,
+ * and could either be a Lightspark node or a node managed by a third party.
  * *
  */
 interface Node {
@@ -43,8 +42,7 @@ interface Node {
   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;
@@ -53,34 +51,30 @@ interface Node {
   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;
 

package/src/objects/NodeAddressType.ts

@@ -1,14 +1,13 @@
 // Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
 
 /**
- * This is an enum of the potential types of addresses that a node on the
- * Lightning Network can have. *
+ * This is an enum of the potential types of addresses that a node on the Lightning Network can
+ * have. *
  */
 export enum NodeAddressType {
   /**
-   * 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/NodeToAddressesConnection.ts

@@ -4,14 +4,14 @@ import type NodeAddress from "./NodeAddress.js";
 import { NodeAddressFromJson, NodeAddressToJson } from "./NodeAddress.js";
 
 /**
- * A connection between a node and the addresses it has announced for itself on
- * Lightning Network. *
+ * A connection between a node and the addresses it has announced for itself on Lightning Network.
+ * *
  */
 interface NodeToAddressesConnection {
   /**
    * 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;
 

package/src/objects/OnChainTransaction.ts

@@ -13,10 +13,9 @@ import TransactionStatus from "./TransactionStatus.js";
 import type Withdrawal from "./Withdrawal.js";
 
 /**
- * This object represents an L1 transaction that occurred on the Bitcoin
- * Network. You can retrieve this object to receive information about a
- * specific on-chain transaction made on the Lightning Network associated with
- * your Lightspark Node.
+ * This object represents an L1 transaction that occurred on the Bitcoin Network.
+ * You can retrieve this object to receive information about a specific on-chain transaction made
+ * on the Lightning Network associated with your Lightspark Node.
  * *
  */
 interface OnChainTransaction {
@@ -39,8 +38,8 @@ interface OnChainTransaction {
   amount: CurrencyAmount;
 
   /**
-   * The height of the block that included this transaction.
-   * This will be zero for unconfirmed transactions.
+   * The height of the block that included this transaction. This will be zero for unconfirmed
+   * transactions.
    **/
   blockHeight: number;
 
@@ -53,28 +52,22 @@ interface OnChainTransaction {
   /** 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;
 
   /**
-   * 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 wallet sending the transaction to commit it to the Bitcoin
+   * blockchain.
    **/
   fees?: CurrencyAmount | undefined;
 
   /**
-   * The hash of the block that included this transaction.
-   * This will be null for unconfirmed transactions.
+   * The hash of the block that included this transaction. This will be null for unconfirmed
+   * transactions.
    **/
   blockHash?: string | undefined;
 
-  /**
-   * The number of blockchain confirmations for this transaction in real time.
-   * *
-   */
+  /** The number of blockchain confirmations for this transaction in real time. **/
   numConfirmations?: number | undefined;
 }
 

package/src/objects/OutgoingPayment.ts

@@ -29,9 +29,9 @@ import type Transaction from "./Transaction.js";
 import TransactionStatus from "./TransactionStatus.js";
 
 /**
- * This object represents a Lightning Network payment sent from a Lightspark
- * Node. You can retrieve this object to receive payment related information
- * about any payment sent from your Lightspark Node on the Lightning Network.
+ * This object represents a Lightning Network payment sent from a Lightspark Node.
+ * You can retrieve this object to receive payment related information about any payment sent from
+ * your Lightspark Node on the Lightning Network.
  * *
  */
 class OutgoingPayment implements LightningTransaction, Transaction, Entity {
@@ -55,31 +55,19 @@ class OutgoingPayment 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,
     /** If known, the final recipient node this payment was sent to. **/
     public readonly destinationId?: string | undefined,
     /** The fees paid by the sender node to send the payment. **/
     public readonly fees?: CurrencyAmount | undefined,
-    /**
-     * The data of the payment request that was paid by this transaction, if
-     * known. *
-     */
+    /** The data of the payment request that was paid by this transaction, if known. **/
     public readonly paymentRequestData?: PaymentRequestData | undefined,
     /** If applicable, the reason why the payment failed. **/
     public readonly failureReason?: PaymentFailureReason | undefined,
-    /**
-     * If applicable, user-facing error message describing why the payment
-     * failed. *
-     */
+    /** If applicable, user-facing error message describing why the payment failed. **/
     public readonly failureMessage?: RichText | 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,
     /** The preimage of the payment. **/
     public readonly paymentPreimage?: string | undefined,

package/src/objects/OutgoingPaymentAttempt.ts

@@ -20,10 +20,9 @@ import type OutgoingPaymentAttemptToHopsConnection from "./OutgoingPaymentAttemp
 import { OutgoingPaymentAttemptToHopsConnectionFromJson } from "./OutgoingPaymentAttemptToHopsConnection.js";
 
 /**
- * This object represents an attempted Lightning Network payment sent from a
- * Lightspark Node. You can retrieve this object to receive payment related
- * information about any payment attempt sent from your Lightspark Node on the
- * Lightning Network,
+ * This object represents an attempted Lightning Network payment sent from a Lightspark Node.
+ * You can retrieve this object to receive payment related information about any payment attempt
+ * sent from your Lightspark Node on the Lightning Network,
  * including any potential reasons the payment may have failed.
  * *
  */
@@ -46,14 +45,11 @@ class OutgoingPaymentAttempt implements Entity {
     public readonly outgoingPaymentId: string,
     /** The typename of the object **/
     public readonly typename: string,
-    /**
-     * If the payment attempt failed, then this contains the Bolt #4 failure
-     * code. *
-     */
+    /** If the payment attempt failed, then this contains the Bolt #4 failure code. **/
     public readonly failureCode?: HtlcAttemptFailureCode | undefined,
     /**
-     * If the payment attempt failed, then this contains the index of the hop
-     * at which the problem occurred.
+     * If the payment attempt failed, then this contains the index of the hop at which the problem
+     * occurred.
      **/
     public readonly failureSourceIndex?: number | undefined,
     /** The time the outgoing payment attempt failed or succeeded. **/
@@ -61,21 +57,17 @@ class OutgoingPaymentAttempt implements Entity {
     /**
      * The total amount of funds required to complete a payment over this route.
      * This value includes the cumulative fees for each hop. As a result,
-     * the attempt extended to the first-hop in the route will need to have at
-     * least this much value, otherwise the route will fail at an intermediate
-     * node due to an insufficient amount.
+     * the attempt extended to the first-hop in the route will need to have at least this much
+     * value, otherwise the route will fail at an intermediate node due to an insufficient amount.
      **/
     public readonly amount?: CurrencyAmount | undefined,
     /**
      * The sum of the fees paid at each hop within the route of this attempt.
-     * In the case of a one-hop payment,
-     * this value will be zero as we don't need to pay a fee to ourselves.
+     * In the case of a one-hop payment, this value will be zero as we don't need to pay a fee to
+     * ourselves.
      **/
     public readonly fees?: CurrencyAmount | undefined,
-    /**
-     * The channel snapshot at the time the outgoing payment attempt was made.
-     * *
-     */
+    /** The channel snapshot at the time the outgoing payment attempt was made. **/
     public readonly channelSnapshot?: ChannelSnapshot | undefined,
   ) {
     autoBind(this);

package/src/objects/OutgoingPaymentAttemptStatus.ts

@@ -1,14 +1,10 @@
 // Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
 
-/**
- * This is an enum of all potential statuses of a payment attempt made from a
- * Lightspark Node. *
- */
+/** This is an enum of all potential statuses of a payment attempt made from a Lightspark Node. **/
 export enum OutgoingPaymentAttemptStatus {
   /**
-   * 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/OutgoingPaymentAttemptToHopsConnection.ts

@@ -6,22 +6,18 @@ import type PageInfo from "./PageInfo.js";
 import { PageInfoFromJson, PageInfoToJson } from "./PageInfo.js";
 
 /**
- * The connection from an outgoing payment attempt to the list of sequential
- * hops that define the path from sender node to recipient node.
- * *
+ * The connection from an outgoing payment attempt to the list of sequential hops that define the
+ * path from sender node to recipient node. *
  */
 interface OutgoingPaymentAttemptToHopsConnection {
   /**
    * 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 hops for the current page of this connection. **/

package/src/objects/OutgoingPaymentToAttemptsConnection.ts

@@ -9,15 +9,12 @@ import { PageInfoFromJson, PageInfoToJson } from "./PageInfo.js";
 interface OutgoingPaymentToAttemptsConnection {
   /**
    * 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 attempts for the current page of this connection. **/

package/src/objects/PageInfo.ts

@@ -1,9 +1,8 @@
 // Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
 
 /**
- * This is an object representing information about a page returned by the
- * Lightspark API. For more information,
- * please see the “Pagination” section of our API docs for more information
+ * This is an object representing information about a page returned by the Lightspark API.
+ * For more information, please see the “Pagination” section of our API docs for more information
  * about its usage. *
  */
 interface PageInfo {

package/src/objects/PayInvoiceInput.ts

@@ -11,14 +11,14 @@ interface PayInvoiceInput {
   timeoutSecs: number;
 
   /**
-   * The maximum amount of fees that you want to pay for this payment to be
-   * sent, expressed in msats. *
+   * The maximum amount of fees that you want to pay for this payment to be sent, expressed in
+   * msats. *
    */
   maximumFeesMsats: number;
 
   /**
-   * The amount you will pay for this invoice, expressed in msats.
-   * It should ONLY be set when the invoice amount is zero.
+   * The amount you will pay for this invoice, expressed in msats. It should ONLY be set when the
+   * invoice amount is zero.
    **/
   amountMsats?: number | undefined;
 }

package/src/objects/PaymentDirection.ts

@@ -3,9 +3,8 @@
 /** This is an enum indicating the direction of the payment. **/
 export enum PaymentDirection {
   /**
-   * 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/PaymentFailureReason.ts

@@ -1,14 +1,13 @@
 // Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
 
 /**
- * This is an enum of the potential reasons why an OutgoingPayment sent from a
- * Lightspark Node may have failed. *
+ * This is an enum of the potential reasons why an OutgoingPayment sent from a Lightspark Node may
+ * have failed. *
  */
 export enum PaymentFailureReason {
   /**
-   * 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/PaymentRequest.ts

@@ -11,10 +11,9 @@ import type PaymentRequestData from "./PaymentRequestData.js";
 import PaymentRequestStatus from "./PaymentRequestStatus.js";
 
 /**
- * This object contains information related to a payment request generated or
- * received by a LightsparkNode. You can retrieve this object to receive
- * payment information about a specific invoice.
- * *
+ * This object contains information related to a payment request generated or received by a
+ * LightsparkNode. You can retrieve this object to receive payment information about a specific
+ * invoice. *
  */
 interface PaymentRequest {
   /**

package/src/objects/PaymentRequestData.ts

@@ -10,9 +10,9 @@ import type InvoiceData from "./InvoiceData.js";
 import { NodeFromJson, NodeToJson } from "./Node.js";
 
 /**
- * This object is an interface of a payment request on the Lightning Network
- * (i.e., a Lightning Invoice). It contains data related to parsing the payment
- * details of a Lightning Invoice. *
+ * This object is an interface of a payment request on the Lightning Network (i.e., a Lightning
+ * Invoice). It contains data related to parsing the payment details of a Lightning Invoice.
+ * *
  */
 interface PaymentRequestData {
   encodedPaymentRequest: string;

package/src/objects/PaymentRequestStatus.ts

@@ -1,14 +1,13 @@
 // Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
 
 /**
- * This is an enum of the potential states that a payment request on the
- * Lightning Network can take. *
+ * This is an enum of the potential states that a payment request on the Lightning Network can
+ * take. *
  */
 export enum PaymentRequestStatus {
   /**
-   * 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/Permission.ts

@@ -1,14 +1,13 @@
 // Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
 
 /**
- * This is an enum of the potential permissions that a Lightspark user can have
- * in regards to account management. *
+ * This is an enum of the potential permissions that a Lightspark user can have in regards to
+ * account management. *
  */
 export enum Permission {
   /**
-   * 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/PostTransactionData.ts

@@ -6,14 +6,11 @@ import {
   CurrencyAmountToJson,
 } from "./CurrencyAmount.js";
 
-/**
- * This object represents post-transaction data that could be used to register
- * payment for KYT. *
- */
+/** This object represents post-transaction data that could be used to register payment for KYT. **/
 interface PostTransactionData {
   /**
-   * The utxo of the channel over which the payment went through in the format
-   * of <transaction_hash>:<output_index>.
+   * The utxo of the channel over which the payment went through in the format of
+   * <transaction_hash>:<output_index>.
    **/
   utxo: string;