@lightsparkdev/lightspark-sdk 1.2.2 → 1.2.3

package/src/objects/LightsparkNode.ts

@@ -24,11 +24,15 @@ import type NodeAddressType from "./NodeAddressType.js";
 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 {
   /**
-   * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
-   * string.
+   * The unique identifier of this entity across all Lightspark systems.
+   * Should be treated as an opaque string.
    **/
   id: string;
 
@@ -42,8 +46,9 @@ interface LightsparkNode {
   bitcoinNetwork: BitcoinNetwork;
 
   /**
-   * 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.
+   * 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;
 
@@ -51,8 +56,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[];
 
@@ -60,34 +65,43 @@ 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, it is just a way to visually differentiate nodes.
+   * 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;
 
   /** The current status of this node. **/
   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,7 +115,8 @@ 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/LightsparkNodeOwner.ts

@@ -9,8 +9,8 @@ import WalletStatus from "./WalletStatus.js";
 /** This is an object representing the owner of a LightsparkNode. **/
 interface LightsparkNodeOwner {
   /**
-   * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
-   * string.
+   * The unique identifier of this entity across all Lightspark systems.
+   * Should be treated as an opaque string.
    **/
   id: string;
 

package/src/objects/LightsparkNodeStatus.ts

@@ -2,8 +2,9 @@
 
 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

@@ -7,12 +7,16 @@ 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).
+   * 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).
    **/
   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

@@ -33,8 +33,8 @@ import { SecretFromJson, SecretToJson } from "./Secret.js";
 class LightsparkNodeWithOSK implements LightsparkNode, Node, Entity {
   constructor(
     /**
-     * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
-     * string.
+     * The unique identifier of this entity across all Lightspark systems.
+     * Should be treated as an opaque string.
      **/
     public readonly id: string,
     /** The date and time when the entity was first created. **/
@@ -44,43 +44,54 @@ 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, depending
-     * on the data available for this node.
+     * 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, it is just a way to visually differentiate nodes.
+     * 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.
      **/
@@ -92,13 +103,15 @@ 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.
      **/
@@ -111,7 +124,10 @@ class LightsparkNodeWithOSK implements LightsparkNode, Node, Entity {
     public readonly blockchainBalance?: BlockchainBalance | undefined,
     /** 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,
   ) {
     autoBind(this);

package/src/objects/LightsparkNodeWithRemoteSigning.ts

@@ -31,8 +31,8 @@ import { NodeToAddressesConnectionFromJson } from "./NodeToAddressesConnection.j
 class LightsparkNodeWithRemoteSigning implements LightsparkNode, Node, Entity {
   constructor(
     /**
-     * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
-     * string.
+     * The unique identifier of this entity across all Lightspark systems.
+     * Should be treated as an opaque string.
      **/
     public readonly id: string,
     /** The date and time when the entity was first created. **/
@@ -42,43 +42,54 @@ 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, depending
-     * on the data available for this node.
+     * 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, it is just a way to visually differentiate nodes.
+     * 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.
      **/
@@ -90,13 +101,15 @@ 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

@@ -20,11 +20,16 @@ import type NodeAddressType from "./NodeAddressType.js";
 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 {
   /**
-   * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
-   * string.
+   * The unique identifier of this entity across all Lightspark systems.
+   * Should be treated as an opaque string.
    **/
   id: string;
 
@@ -38,8 +43,9 @@ interface Node {
   bitcoinNetwork: BitcoinNetwork;
 
   /**
-   * 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.
+   * 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;
 
@@ -47,27 +53,35 @@ 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, it is just a way to visually differentiate nodes.
+   * 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;
 
   getAddresses(

package/src/objects/NodeAddressType.ts

@@ -1,10 +1,14 @@
 // 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

@@ -3,11 +3,15 @@
 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).
+   * 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).
    **/
   count: number;
 

package/src/objects/OnChainTransaction.ts

@@ -12,11 +12,17 @@ import type Deposit from "./Deposit.js";
 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 {
   /**
-   * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
-   * string.
+   * The unique identifier of this entity across all Lightspark systems.
+   * Should be treated as an opaque string.
    **/
   id: string;
 
@@ -33,8 +39,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;
 
@@ -47,22 +53,28 @@ 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

@@ -28,12 +28,17 @@ import { RichTextFromJson, RichTextToJson } from "./RichText.js";
 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 {
   constructor(
     /**
-     * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
-     * string.
+     * The unique identifier of this entity across all Lightspark systems.
+     * Should be treated as an opaque string.
      **/
     public readonly id: string,
     /** The date and time when this transaction was initiated. **/
@@ -50,19 +55,31 @@ 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,