@lightsparkdev/lightspark-sdk 1.2.3 → 1.3.0

package/src/objects/Channel.ts

@@ -18,8 +18,8 @@ import type TransactionType from "./TransactionType.js";
 
 /**
  * This is an object representing a channel on the Lightning Network.
- * You can retrieve this object to get detailed information on a specific
- * Lightning Network channel. *
+ * You can retrieve this object to get detailed information on a specific Lightning Network
+ * channel. *
  */
 class Channel implements Entity {
   constructor(
@@ -39,48 +39,39 @@ class Channel implements Entity {
     /** The transaction that funded the channel upon channel opening. **/
     public readonly fundingTransactionId?: string | undefined,
     /**
-     * The total amount of funds in this channel,
-     * including the channel balance on the local node,
-     * the channel balance on the remote node and the on-chain fees to close
-     * the channel.
+     * The total amount of funds in this channel, including the channel balance on the local node,
+     * the channel balance on the remote node and the on-chain fees to close the channel.
      **/
     public readonly capacity?: CurrencyAmount | undefined,
     /** The channel balance on the local node. **/
     public readonly localBalance?: CurrencyAmount | undefined,
     /**
-     * The channel balance on the local node that is currently allocated to
-     * in-progress payments. *
+     * The channel balance on the local node that is currently allocated to in-progress payments.
+     * *
      */
     public readonly localUnsettledBalance?: CurrencyAmount | undefined,
     /** The channel balance on the remote node. **/
     public readonly remoteBalance?: CurrencyAmount | undefined,
     /**
-     * The channel balance on the remote node that is currently allocated to
-     * in-progress payments. *
-     */
-    public readonly remoteUnsettledBalance?: CurrencyAmount | undefined,
-    /**
-     * The channel balance that is currently allocated to in-progress payments.
+     * The channel balance on the remote node that is currently allocated to in-progress payments.
      * *
      */
+    public readonly remoteUnsettledBalance?: CurrencyAmount | undefined,
+    /** The channel balance that is currently allocated to in-progress payments. **/
     public readonly unsettledBalance?: CurrencyAmount | undefined,
     /**
-     * The total balance in this channel,
-     * including the channel balance on both local and remote nodes.
-     * *
+     * The total balance in this channel, including the channel balance on both local and remote
+     * nodes. *
      */
     public readonly totalBalance?: CurrencyAmount | undefined,
     /** The current status of this channel. **/
     public readonly status?: ChannelStatus | undefined,
     /**
-     * The estimated time to wait for the channel's hash timelock contract to
-     * expire when force closing the channel. It is in unit of minutes.
+     * The estimated time to wait for the channel's hash timelock contract to expire when force
+     * closing the channel. It is in unit of minutes.
      **/
     public readonly estimatedForceClosureWaitMinutes?: number | undefined,
-    /**
-     * The amount to be paid in fees for the current set of commitment
-     * transactions. *
-     */
+    /** The amount to be paid in fees for the current set of commitment transactions. **/
     public readonly commitFee?: CurrencyAmount | undefined,
     /** The fees charged for routing payments through this channel. **/
     public readonly fees?: ChannelFees | undefined,
@@ -88,8 +79,8 @@ class Channel implements Entity {
     public readonly remoteNodeId?: string | undefined,
     /**
      * The unique identifier of the channel on Lightning Network,
-     * which is the location in the chain that the channel was confirmed.
-     * The format is <block-height>:<tx-index>:<tx-output>.
+     * which is the location in the chain that the channel was confirmed. The format is
+     * <block-height>:<tx-index>:<tx-output>.
      **/
     public readonly shortChannelId?: string | undefined,
   ) {

package/src/objects/ChannelClosingTransaction.ts

@@ -9,9 +9,8 @@ import {
 import TransactionStatus from "./TransactionStatus.js";
 
 /**
- * This is an object representing a transaction which closes a channel on the
- * Lightning Network. This operation allocates balances back to the local and
- * remote nodes.
+ * This is an object representing a transaction which closes a channel on the Lightning Network.
+ * This operation allocates balances back to the local and remote nodes.
  * *
  */
 interface ChannelClosingTransaction {
@@ -34,8 +33,8 @@ interface ChannelClosingTransaction {
   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;
 
@@ -48,28 +47,22 @@ interface ChannelClosingTransaction {
   /** 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;
 
   /** If known, the channel this transaction is closing. **/

package/src/objects/ChannelFees.ts

@@ -6,10 +6,7 @@ import {
   CurrencyAmountToJson,
 } from "./CurrencyAmount.js";
 
-/**
- * This represents the fee policies set for a channel on the Lightning Network.
- * *
- */
+/** This represents the fee policies set for a channel on the Lightning Network. **/
 interface ChannelFees {
   baseFee?: CurrencyAmount | undefined;
 

package/src/objects/ChannelOpeningTransaction.ts

@@ -9,9 +9,8 @@ import {
 import TransactionStatus from "./TransactionStatus.js";
 
 /**
- * This is an object representing a transaction which opens a channel on the
- * Lightning Network. This object occurs only for channels funded by the local
- * Lightspark node.
+ * This is an object representing a transaction which opens a channel on the Lightning Network.
+ * This object occurs only for channels funded by the local Lightspark node.
  * *
  */
 interface ChannelOpeningTransaction {
@@ -34,8 +33,8 @@ interface ChannelOpeningTransaction {
   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;
 
@@ -48,28 +47,22 @@ interface ChannelOpeningTransaction {
   /** 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;
 
   /** If known, the channel this transaction is opening. **/

package/src/objects/ChannelStatus.ts

@@ -1,48 +1,42 @@
 // Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
 
-/**
- * This is an enum representing the status of a channel on the Lightning
- * Network. *
- */
+/** This is an enum representing the status of a channel on the Lightning Network. **/
 export enum ChannelStatus {
   /**
-   * 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 channel is online and ready to send and receive funds. **/
   OK = "OK",
   /**
-   * The channel has been created, but the Bitcoin transaction that initiates
-   * it still needs to be confirmed on the Bitcoin blockchain.
-   * *
+   * The channel has been created, but the Bitcoin transaction that initiates it still needs to be
+   * confirmed on the Bitcoin blockchain. *
    */
   PENDING = "PENDING",
   /** The channel is not available, likely because the peer is not online. **/
   OFFLINE = "OFFLINE",
   /**
-   * The channel is behaving properly, but its remote balance is much higher
-   * than its local balance so it is not balanced properly for sending funds
-   * out.
+   * The channel is behaving properly, but its remote balance is much higher than its local balance
+   * so it is not balanced properly for sending funds out.
    * *
    */
   UNBALANCED_FOR_SEND = "UNBALANCED_FOR_SEND",
   /**
-   * The channel is behaving properly, but its remote balance is much lower
-   * than its local balance so it is not balanced properly for receiving funds.
+   * The channel is behaving properly, but its remote balance is much lower than its local balance
+   * so it is not balanced properly for receiving funds.
    * *
    */
   UNBALANCED_FOR_RECEIVE = "UNBALANCED_FOR_RECEIVE",
   /**
-   * The channel has been closed. Information about the channel is still
-   * available for historical purposes but the channel cannot be used anymore.
+   * The channel has been closed. Information about the channel is still available for historical
+   * purposes but the channel cannot be used anymore.
    * *
    */
   CLOSED = "CLOSED",
   /**
-   * Something unexpected happened and we cannot determine the status of this
-   * channel. Please try again later or contact the support.
+   * Something unexpected happened and we cannot determine the status of this channel.
+   * Please try again later or contact the support.
    * *
    */
   ERROR = "ERROR",

package/src/objects/ChannelToTransactionsConnection.ts

@@ -9,8 +9,8 @@ import {
 interface ChannelToTransactionsConnection {
   /**
    * 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;
 
@@ -21,14 +21,14 @@ interface ChannelToTransactionsConnection {
   averageFee?: CurrencyAmount | undefined;
 
   /**
-   * The total amount transacted for the transactions that transited through
-   * this channel, according to the filters and constraints of the connection.
+   * The total amount transacted for the transactions that transited through this channel,
+   * according to the filters and constraints of the connection.
    **/
   totalAmountTransacted?: CurrencyAmount | undefined;
 
   /**
-   * The total amount of fees for the transactions that transited through this
-   * channel, according to the filters and constraints of the connection.
+   * The total amount of fees for the transactions that transited through this channel,
+   * according to the filters and constraints of the connection.
    **/
   totalFees?: CurrencyAmount | undefined;
 }

package/src/objects/ComplianceProvider.ts

@@ -3,9 +3,8 @@
 /** This is an enum identifying a type of compliance provider. **/
 export enum ComplianceProvider {
   /**
-   * 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/Connection.ts

@@ -40,15 +40,12 @@ import type WalletToTransactionsConnection from "./WalletToTransactionsConnectio
 interface Connection {
   /**
    * 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 typename of the object **/

package/src/objects/CreateApiTokenInput.ts

@@ -3,10 +3,7 @@
 import Permission from "./Permission.js";
 
 interface CreateApiTokenInput {
-  /**
-   * An arbitrary name that the user can choose to identify the API token in a
-   * list. *
-   */
+  /** An arbitrary name that the user can choose to identify the API token in a list. **/
   name: string;
 
   /** List of permissions to grant to the API token **/

package/src/objects/CreateLnurlInvoiceInput.ts

@@ -9,8 +9,8 @@ interface CreateLnurlInvoiceInput {
 
   /**
    * The SHA256 hash of the LNURL metadata payload.
-   * This will be present in the h-tag (SHA256 purpose of payment) of the
-   * resulting Bolt 11 invoice.
+   * This will be present in the h-tag (SHA256 purpose of payment) of the resulting Bolt 11
+   * invoice.
    **/
   metadataHash: string;
 

package/src/objects/CreateTestModePaymentoutput.ts

@@ -2,8 +2,8 @@
 
 /**
  * This is an object identifying the output of a test mode payment.
- * This object can be used to retrieve the associated payment made from a Test
- * Mode Payment call. *
+ * This object can be used to retrieve the associated payment made from a Test Mode Payment call.
+ * *
  */
 interface CreateTestModePaymentoutput {
   /**

package/src/objects/CurrencyAmount.ts

@@ -14,16 +14,14 @@ interface CurrencyAmount {
   preferredCurrencyUnit: CurrencyUnit;
 
   /**
-   * The rounded numeric value for this CurrencyAmount in the very base level
-   * of user's preferred currency. For example, for USD, the value will be in
-   * cents.
+   * The rounded numeric value for this CurrencyAmount in the very base level of user's preferred
+   * currency. For example, for USD, the value will be in cents.
    **/
   preferredCurrencyValueRounded: number;
 
   /**
-   * The approximate float value for this CurrencyAmount in the very base level
-   * of user's preferred currency. For example, for USD, the value will be in
-   * cents.
+   * The approximate float value for this CurrencyAmount in the very base level of user's
+   * preferred currency. For example, for USD, the value will be in cents.
    **/
   preferredCurrencyValueApprox: number;
 }

package/src/objects/CurrencyUnit.ts

@@ -1,20 +1,16 @@
 // Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
 
-/**
- * This enum identifies the unit of currency associated with a CurrencyAmount.
- * *
- */
+/** This enum identifies the unit of currency associated with a CurrencyAmount. **/
 export enum CurrencyUnit {
   /**
-   * 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",
   /**
    * Bitcoin is the cryptocurrency native to the Bitcoin network.
-   * It is used as the native medium for value transfer for the Lightning
-   * Network. *
+   * It is used as the native medium for value transfer for the Lightning Network.
+   * *
    */
   BITCOIN = "BITCOIN",
   /**
@@ -24,8 +20,8 @@ export enum CurrencyUnit {
    */
   SATOSHI = "SATOSHI",
   /**
-   * 0.001 Satoshi, or 10e-11 Bitcoin. We recommend using the Satoshi unit
-   * instead when possible. *
+   * 0.001 Satoshi, or 10e-11 Bitcoin. We recommend using the Satoshi unit instead when possible.
+   * *
    */
   MILLISATOSHI = "MILLISATOSHI",
   /** United States Dollar. **/

package/src/objects/Deposit.ts

@@ -11,8 +11,8 @@ import TransactionStatus from "./TransactionStatus.js";
 /**
  * This object represents a Deposit made to a Lightspark node wallet.
  * This operation occurs for any L1 funding transaction to the wallet.
- * You can retrieve this object to receive detailed information about the
- * deposit. *
+ * You can retrieve this object to receive detailed information about the deposit.
+ * *
  */
 interface Deposit {
   /**
@@ -34,8 +34,8 @@ interface Deposit {
   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;
 
@@ -51,28 +51,22 @@ interface Deposit {
   /** 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/Entity.ts

@@ -3,8 +3,8 @@
 /**
  * This interface is used by all the entities in the Lightspark system.
  * It defines a few core fields that are available everywhere.
- * Any object that implements this interface can be queried using the `entity`
- * query and its ID. *
+ * Any object that implements this interface can be queried using the `entity` query and its ID.
+ * *
  */
 interface Entity {
   /**

package/src/objects/FeeEstimate.ts

@@ -7,9 +7,9 @@ import {
 } from "./CurrencyAmount.js";
 
 /**
- * This object represents the estimated L1 transaction fees for the Bitcoin
- * network. Fee estimates are separated by potential confirmation speeds for
- * settlement. *
+ * This object represents the estimated L1 transaction fees for the Bitcoin network.
+ * Fee estimates are separated by potential confirmation speeds for settlement.
+ * *
  */
 interface FeeEstimate {
   feeFast: CurrencyAmount;

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",