@lightsparkdev/lightspark-sdk 1.2.2 → 1.2.3

package/src/objects/AccountToNodesConnection.ts

@@ -11,12 +11,16 @@ import { PageInfoFromJson, PageInfoToJson } from "./PageInfo.js";
 /** A connection between an account and the nodes it manages. **/
 interface AccountToNodesConnection {
   /**
-   * 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 nodes for the current page of this connection. **/

package/src/objects/AccountToPaymentRequestsConnection.ts

@@ -10,12 +10,16 @@ import {
 
 interface AccountToPaymentRequestsConnection {
   /**
-   * 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 payment requests for the current page of this connection. **/

package/src/objects/AccountToTransactionsConnection.ts

@@ -12,12 +12,16 @@ import { TransactionFromJson, TransactionToJson } from "./Transaction.js";
 
 interface AccountToTransactionsConnection {
   /**
-   * 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 transactions for the current page of this connection. **/
@@ -27,20 +31,20 @@ interface AccountToTransactionsConnection {
   typename: string;
 
   /**
-   * Profit (or loss) generated by the transactions in this connection, with the set of filters and
-   * constraints provided.
+   * Profit (or loss) generated by the transactions in this connection,
+   * with the set of filters and constraints provided.
    **/
   profitLoss?: CurrencyAmount | undefined;
 
   /**
-   * Average fee earned for the transactions in this connection, with the set of filters and constraints
-   * provided.
+   * Average fee earned for the transactions in this connection,
+   * with the set of filters and constraints provided.
    **/
   averageFeeEarned?: CurrencyAmount | undefined;
 
   /**
-   * Total amount transacted by the transactions in this connection, with the set of filters and
-   * constraints provided.
+   * Total amount transacted by the transactions in this connection,
+   * with the set of filters and constraints provided.
    **/
   totalAmountTransacted?: CurrencyAmount | undefined;
 }

package/src/objects/AccountToWalletsConnection.ts

@@ -7,12 +7,16 @@ import { WalletFromJson } from "./Wallet.js";
 
 interface AccountToWalletsConnection {
   /**
-   * 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 wallets for the current page of this connection. **/

package/src/objects/ApiToken.ts

@@ -3,11 +3,16 @@
 import { type Query } from "@lightsparkdev/core";
 import Permission from "./Permission.js";
 
-/** This is an object representing a Lightspark API token, that can be used to authenticate this account when making API calls or using our SDKs. See the “Authentication” section of our API docs for more details on its usage. **/
+/**
+ * This is an object representing a Lightspark API token,
+ * that can be used to authenticate this account when making API calls or using
+ * our SDKs. See the “Authentication” section of our API docs for more details
+ * on its usage. *
+ */
 interface ApiToken {
   /**
-   * 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;
 
@@ -18,14 +23,15 @@ interface ApiToken {
   updatedAt: string;
 
   /**
-   * An opaque identifier that should be used as a client_id (or username) in the HTTP Basic
-   * Authentication scheme when issuing requests against the Lightspark API.
+   * An opaque identifier that should be used as a client_id (or username) in
+   * the HTTP Basic Authentication scheme when issuing requests against the
+   * Lightspark API.
    **/
   clientId: string;
 
   /**
-   * An arbitrary name chosen by the creator of the token to help identify the token in the list of
-   * tokens that have been created for the account.
+   * An arbitrary name chosen by the creator of the token to help identify the
+   * token in the list of tokens that have been created for the account.
    **/
   name: string;
 

package/src/objects/Balances.ts

@@ -6,28 +6,38 @@ import {
   CurrencyAmountToJson,
 } from "./CurrencyAmount.js";
 
-/** This is an object representing the balance associated with your Lightspark account. You can retrieve this object to see your balance, which can be broken down into several different categorizations. **/
+/**
+ * This is an object representing the balance associated with your Lightspark
+ * account. You can retrieve this object to see your balance,
+ * which can be broken down into several different categorizations.
+ * *
+ */
 interface Balances {
   /**
-   * This represents the balance that should be displayed when asked "how much do I own right now?". It
-   * represents the amount currently owned, including things that may not be owned soon (e.g. in-flight
-   * outgoing payments, in-flight withdrawals, commit fees, etc.). It really is a snapshot of what is
-   * officially owned at this instant.
+   * This represents the balance that should be displayed when asked "how much
+   * do I own right now?". It represents the amount currently owned,
+   * including things that may not be owned soon (e.g. in-flight outgoing
+   * payments, in-flight withdrawals, commit fees, etc.).
+   * It really is a snapshot of what is officially owned at this instant.
    **/
   ownedBalance: CurrencyAmount;
 
   /**
-   * This represents the balance that should be displayed when asked "how much can I send on Lightning
-   * right now?". It represents the amount currently available to be sent on the Lightning network. We
-   * remove from the balance all the funds that are temporarily locked (e.g. channel reserves).
+   * This represents the balance that should be displayed when asked "how much
+   * can I send on Lightning right now?".
+   * It represents the amount currently available to be sent on the Lightning
+   * network. We remove from the balance all the funds that are temporarily
+   * locked (e.g. channel reserves).
    **/
   availableToSendBalance: CurrencyAmount;
 
   /**
-   * This represents the balance that should be displayed when asked "how much money can I withdraw on
-   * the Bitcoin network right now?". It represents the amount currently available to withdraw and is
-   * usually equal to the `owned_balance` but it does not include in-flight operations (which would
-   * likely succeed and therefore likely make your withdrawal fail).
+   * This represents the balance that should be displayed when asked "how much
+   * money can I withdraw on the Bitcoin network right now?".
+   * It represents the amount currently available to withdraw and is usually
+   * equal to the `owned_balance` but it does not include in-flight operations
+   * (which would likely succeed and therefore likely make your withdrawal
+   * fail).
    **/
   availableToWithdrawBalance: CurrencyAmount;
 }

package/src/objects/BitcoinNetwork.ts

@@ -3,15 +3,20 @@
 /** This is an enum identifying a particular Bitcoin Network. **/
 export enum BitcoinNetwork {
   /**
-   * 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 production version of the Bitcoin Blockchain. **/
   MAINNET = "MAINNET",
   /** A test version of the Bitcoin Blockchain, maintained by Lightspark. **/
   REGTEST = "REGTEST",
-  /** A test version of the Bitcoin Blockchain, maintained by a centralized organization. Not in use at Lightspark. **/
+  /**
+   * A test version of the Bitcoin Blockchain, maintained by a centralized
+   * organization. Not in use at Lightspark.
+   * *
+   */
   SIGNET = "SIGNET",
   /** A test version of the Bitcoin Blockchain, publicly available. **/
   TESTNET = "TESTNET",

package/src/objects/BlockchainBalance.ts

@@ -6,7 +6,10 @@ import {
   CurrencyAmountToJson,
 } from "./CurrencyAmount.js";
 
-/** This is an object representing a detailed breakdown of the balance for a Lightspark Node. **/
+/**
+ * This is an object representing a detailed breakdown of the balance for a
+ * Lightspark Node. *
+ */
 interface BlockchainBalance {
   /** The total wallet balance, including unconfirmed UTXOs. **/
   totalBalance?: CurrencyAmount | undefined;

package/src/objects/Channel.ts

@@ -16,12 +16,16 @@ import {
 import type Entity from "./Entity.js";
 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. **/
+/**
+ * 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. *
+ */
 class Channel implements 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. **/
@@ -35,38 +39,57 @@ 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. **/
+    /**
+     * 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 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,
     /** If known, the remote node of the channel. **/
     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>.
+     * 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>.
      **/
     public readonly shortChannelId?: string | undefined,
   ) {

package/src/objects/ChannelClosingTransaction.ts

@@ -8,11 +8,16 @@ import {
 } from "./CurrencyAmount.js";
 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 {
   /**
-   * 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;
 
@@ -29,8 +34,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;
 
@@ -43,22 +48,28 @@ 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,7 +6,10 @@ 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

@@ -8,11 +8,16 @@ import {
 } from "./CurrencyAmount.js";
 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 {
   /**
-   * 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;
 
@@ -29,8 +34,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;
 
@@ -43,22 +48,28 @@ 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,25 +1,50 @@
 // 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

@@ -8,26 +8,27 @@ 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).
+   * 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;
 
   /**
-   * The average fee for the transactions that transited through this channel, according to the filters
-   * and constraints of the connection.
+   * The average fee for the transactions that transited through this channel,
+   * according to the filters and constraints of the connection.
    **/
   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,8 +3,9 @@
 /** 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

@@ -39,12 +39,16 @@ 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).
+   * 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 typename of the object **/

package/src/objects/CreateApiTokenInput.ts

@@ -3,7 +3,10 @@
 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/CreateApiTokenOutput.ts

@@ -8,9 +8,9 @@ interface CreateApiTokenOutput {
   apiToken: ApiToken;
 
   /**
-   * The secret that should be used to authenticate against our API. This secret is not stored and will
-   * never be available again after this. You must keep this secret secure as it grants access to your
-   * account.
+   * The secret that should be used to authenticate against our API.
+   * This secret is not stored and will never be available again after this.
+   * You must keep this secret secure as it grants access to your account.
    **/
   clientSecret: string;
 }

package/src/objects/CreateLnurlInvoiceInput.ts

@@ -8,8 +8,9 @@ interface CreateLnurlInvoiceInput {
   amountMsats: number;
 
   /**
-   * 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.
+   * 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.
    **/
   metadataHash: string;