@lightsparkdev/lightspark-sdk 1.3.1 → 1.4.0

package/src/objects/LightningTransaction.ts

@@ -23,14 +23,14 @@ import RoutingTransactionFailureReason from "./RoutingTransactionFailureReason.j
 import TransactionStatus from "./TransactionStatus.js";
 
 /**
- * This is an object representing a transaction made over the Lightning Network.
- * You can retrieve this object to receive information about a specific transaction made over
- * Lightning for a Lightspark node. *
+ * This is an object representing a transaction made over the Lightning Network. You can retrieve
+ * this object to receive information about a specific transaction made over Lightning for a
+ * Lightspark node. *
  */
 interface LightningTransaction {
   /**
-   * 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/LightsparkNode.ts

@@ -26,13 +26,12 @@ 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.
- * *
+ * 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;
 
@@ -64,17 +63,16 @@ 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.
-   * That color can be changed at any time by the node operator.
+   * 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;
 

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/LightsparkNodeToChannelsConnection.ts

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

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. **/
@@ -58,16 +58,15 @@ class LightsparkNodeWithOSK implements LightsparkNode, Node, Entity {
     /** 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.
-     * That color can be changed at any time by the node operator.
+     * 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,
     /**

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. **/
@@ -56,16 +56,15 @@ class LightsparkNodeWithRemoteSigning implements LightsparkNode, Node, Entity {
     /** 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.
-     * That color can be changed at any time by the node operator.
+     * 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,
     /**

package/src/objects/Node.ts

@@ -21,14 +21,13 @@ 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;
 
@@ -51,17 +50,16 @@ 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.
-   * That color can be changed at any time by the node operator.
+   * 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;
 

package/src/objects/NodeToAddressesConnection.ts

@@ -9,9 +9,8 @@ import { NodeAddressFromJson, NodeAddressToJson } from "./NodeAddress.js";
  */
 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

@@ -13,15 +13,14 @@ 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;
 

package/src/objects/OutgoingPayment.ts

@@ -29,16 +29,15 @@ 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. **/

package/src/objects/OutgoingPaymentAttempt.ts

@@ -20,17 +20,16 @@ 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,
- * including any potential reasons the payment may have failed.
- * *
+ * 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. *
  */
 class OutgoingPaymentAttempt 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. **/
@@ -55,16 +54,15 @@ class OutgoingPaymentAttempt implements Entity {
     /** The time the outgoing payment attempt failed or succeeded. **/
     public readonly resolvedAt?: string | undefined,
     /**
-     * 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 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.
      **/
     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.
+     * 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.
      **/
     public readonly fees?: CurrencyAmount | undefined,
     /** The channel snapshot at the time the outgoing payment attempt was made. **/

package/src/objects/OutgoingPaymentAttemptToHopsConnection.ts

@@ -11,9 +11,8 @@ import { PageInfoFromJson, PageInfoToJson } from "./PageInfo.js";
  */
 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).
+   * 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/OutgoingPaymentToAttemptsConnection.ts

@@ -8,9 +8,8 @@ import { PageInfoFromJson, PageInfoToJson } from "./PageInfo.js";
 /** The connection from outgoing payment to all attempts. **/
 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).
+   * 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/PageInfo.ts

@@ -1,9 +1,9 @@
 // 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
- * about its usage. *
+ * 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 {
   hasNextPage?: boolean | undefined;

package/src/objects/PaymentRequest.ts

@@ -17,8 +17,8 @@ import PaymentRequestStatus from "./PaymentRequestStatus.js";
  */
 interface PaymentRequest {
   /**
-   * 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/PaymentRequestData.ts

@@ -11,8 +11,7 @@ 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.
- * *
+ * Invoice). It contains data related to parsing the payment details of a Lightning Invoice. *
  */
 interface PaymentRequestData {
   encodedPaymentRequest: string;

package/src/objects/RegisterPaymentInput.ts

@@ -5,22 +5,21 @@ import PaymentDirection from "./PaymentDirection.js";
 
 interface RegisterPaymentInput {
   /**
-   * The compliance provider that is going to screen the node.
-   * You need to be a customer of the selected provider and store the API key on the Lightspark
-   * account setting page.
+   * The compliance provider that is going to screen the node. You need to be a customer of the
+   * selected provider and store the API key on the Lightspark account setting page.
    **/
   provider: ComplianceProvider;
 
   /**
-   * The Lightspark ID of the lightning payment you want to register.
-   * It can be the id of either an OutgoingPayment or an IncomingPayment.
+   * The Lightspark ID of the lightning payment you want to register. It can be the id of either
+   * an OutgoingPayment or an IncomingPayment.
    **/
   paymentId: string;
 
   /**
-   * The public key of the counterparty lightning node,
-   * which would be the public key of the recipient node if it is to register an outgoing
-   * payment, or the public key of the sender node if it is to register an incoming payment.
+   * The public key of the counterparty lightning node, which would be the public key of the
+   * recipient node if it is to register an outgoing payment, or the public key of the sender
+   * node if it is to register an incoming payment.
    **/
   nodePubkey: string;
 

package/src/objects/RequestWithdrawalInput.ts

@@ -10,8 +10,8 @@ interface RequestWithdrawalInput {
   bitcoinAddress: string;
 
   /**
-   * The amount you want to withdraw from this node in Satoshis.
-   * Use the special value -1 to withdrawal all funds from this node.
+   * The amount you want to withdraw from this node in Satoshis. Use the special value -1 to
+   * withdrawal all funds from this node.
    **/
   amountSats: number;
 

package/src/objects/RiskRating.ts

@@ -2,8 +2,7 @@
 
 /**
  * This is an enum of the potential risk ratings related to a transaction made over the Lightning
- * Network. These risk ratings are returned from the CryptoSanctionScreeningProvider.
- * *
+ * Network. These risk ratings are returned from the CryptoSanctionScreeningProvider. *
  */
 export enum RiskRating {
   /**

package/src/objects/RoutingTransaction.ts

@@ -13,14 +13,13 @@ import TransactionStatus from "./TransactionStatus.js";
 
 /**
  * This object represents a transaction that was forwarded through a Lightspark node on the
- * Lightning Network, i.e., a routed transaction.
- * You can retrieve this object to receive information about any transaction routed through your
- * Lightspark Node. *
+ * Lightning Network, i.e., a routed transaction. You can retrieve this object to receive
+ * information about any transaction routed through your Lightspark Node. *
  */
 interface RoutingTransaction {
   /**
-   * 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;
 
@@ -52,9 +51,8 @@ interface RoutingTransaction {
   outgoingChannelId?: string | undefined;
 
   /**
-   * The fees collected by the node when routing this transaction.
-   * We subtract the outgoing amount to the incoming amount to determine how much fees were
-   * collected.
+   * The fees collected by the node when routing this transaction. We subtract the outgoing
+   * amount to the incoming amount to determine how much fees were collected.
    **/
   fees?: CurrencyAmount | undefined;
 

package/src/objects/ScreenNodeInput.ts

@@ -4,9 +4,8 @@ import ComplianceProvider from "./ComplianceProvider.js";
 
 interface ScreenNodeInput {
   /**
-   * The compliance provider that is going to screen the node.
-   * You need to be a customer of the selected provider and store the API key on the Lightspark
-   * account setting page.
+   * The compliance provider that is going to screen the node. You need to be a customer of the
+   * selected provider and store the API key on the Lightspark account setting page.
    **/
   provider: ComplianceProvider;
 

package/src/objects/SetInvoicePaymentHashInput.ts

@@ -8,9 +8,8 @@ interface SetInvoicePaymentHashInput {
   paymentHash: string;
 
   /**
-   * The 32-byte nonce used to generate the invoice preimage if applicable.
-   * It will later be included in RELEASE_PAYMENT_PREIMAGE webhook to help recover the raw
-   * preimage.
+   * The 32-byte nonce used to generate the invoice preimage if applicable. It will later be
+   * included in RELEASE_PAYMENT_PREIMAGE webhook to help recover the raw preimage.
    **/
   preimageNonce?: string | undefined;
 }

package/src/objects/Signable.ts

@@ -4,8 +4,8 @@ import { type Query } from "@lightsparkdev/core";
 
 interface Signable {
   /**
-   * 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/SignablePayload.ts

@@ -5,8 +5,8 @@ import SignablePayloadStatus from "./SignablePayloadStatus.js";
 
 interface SignablePayload {
   /**
-   * 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/Transaction.ts

@@ -29,13 +29,12 @@ import type Withdrawal from "./Withdrawal.js";
 /**
  * This object represents a payment transaction. The transaction can occur either on a Bitcoin
  * Network, or over the Lightning Network. You can retrieve this object to receive specific
- * information about a particular transaction tied to your Lightspark Node.
- * *
+ * information about a particular transaction tied to your Lightspark Node. *
  */
 interface Transaction {
   /**
-   * 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/TransactionStatus.ts

@@ -17,8 +17,7 @@ export enum TransactionStatus {
   /** Transaction has been initiated and is currently in-flight. **/
   PENDING = "PENDING",
   /**
-   * For transaction type PAYMENT_REQUEST only. No payments have been made to a payment request.
-   * *
+   * For transaction type PAYMENT_REQUEST only. No payments have been made to a payment request. *
    */
   NOT_STARTED = "NOT_STARTED",
   /** For transaction type PAYMENT_REQUEST only. A payment request has expired. **/

package/src/objects/UmaInvitation.ts

@@ -7,8 +7,8 @@ import IncentivesStatus from "./IncentivesStatus.js";
 /** This is an object representing an UMA.ME invitation. **/
 interface UmaInvitation {
   /**
-   * 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;