@lightsparkdev/lightspark-sdk 1.2.1 → 1.2.3

package/src/objects/GraphNode.ts

@@ -10,12 +10,18 @@ import type NodeAddressType from "./NodeAddressType.js";
 import type NodeToAddressesConnection from "./NodeToAddressesConnection.js";
 import { NodeToAddressesConnectionFromJson } from "./NodeToAddressesConnection.js";
 
-/** 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. **/
+/**
+ * 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.
+ * *
+ */
 class GraphNode implements 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. **/
@@ -25,31 +31,41 @@ 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, 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 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,
   ) {
     autoBind(this);

package/src/objects/Hop.ts

@@ -7,11 +7,16 @@ import {
   CurrencyAmountToJson,
 } 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 {
   /**
-   * 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;
 
@@ -36,7 +41,10 @@ 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,10 +1,14 @@
 // 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",
 

package/src/objects/IncentivesIneligibilityReason.ts

@@ -0,0 +1,48 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+/**
+ * Describes the reason for an invitation to not be eligible for incentives.
+ * *
+ */
+export enum IncentivesIneligibilityReason {
+  /**
+   * 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",
+  /**
+   * This invitation is not eligible for incentives because it has been created
+   * outside of the incentives flow. *
+   */
+  DISABLED = "DISABLED",
+  /**
+   * This invitation is not eligible for incentives because the sender is not
+   * eligible. *
+   */
+  SENDER_NOT_ELIGIBLE = "SENDER_NOT_ELIGIBLE",
+  /**
+   * This invitation is not eligible for incentives because the receiver is not
+   * eligible. *
+   */
+  RECEIVER_NOT_ELIGIBLE = "RECEIVER_NOT_ELIGIBLE",
+  /**
+   * This invitation is not eligible for incentives because the sending VASP is
+   * not part of the incentives program.
+   * *
+   */
+  SENDING_VASP_NOT_ELIGIBLE = "SENDING_VASP_NOT_ELIGIBLE",
+  /**
+   * This invitation is not eligible for incentives because the receiving VASP
+   * is not part of the incentives program.
+   * *
+   */
+  RECEIVING_VASP_NOT_ELIGIBLE = "RECEIVING_VASP_NOT_ELIGIBLE",
+  /**
+   * This invitation is not eligible for incentives because the sender and
+   * receiver are in the same region. *
+   */
+  NOT_CROSS_BORDER = "NOT_CROSS_BORDER",
+}
+
+export default IncentivesIneligibilityReason;

package/src/objects/IncentivesStatus.ts

@@ -0,0 +1,28 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+/** Describes the status of the incentives for this invitation. **/
+export enum IncentivesStatus {
+  /**
+   * 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 invitation is eligible for incentives in its current state.
+   * When it is claimed, we will reassess.
+   * *
+   */
+  PENDING = "PENDING",
+  /** The incentives have been validated. **/
+  VALIDATED = "VALIDATED",
+  /**
+   * This invitation is not eligible for incentives.
+   * A more detailed reason can be found in the
+   * `incentives_ineligibility_reason` field.
+   * *
+   */
+  INELIGIBLE = "INELIGIBLE",
+}
+
+export default IncentivesStatus;

package/src/objects/IncomingPayment.ts

@@ -21,12 +21,17 @@ import {
 import type Transaction from "./Transaction.js";
 import TransactionStatus from "./TransactionStatus.js";
 
-/** This object represents any payment sent to a Lightspark node on the Lightning Network. You can retrieve this object to receive payment related information about a specific payment received by a Lightspark node. **/
+/**
+ * This object represents any payment sent to a Lightspark node on the
+ * Lightning Network. You can retrieve this object to receive payment related
+ * information about a specific payment received by a Lightspark node.
+ * *
+ */
 class IncomingPayment 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. **/
@@ -43,14 +48,20 @@ class IncomingPayment 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,
     /**
-     * The optional payment request for this incoming payment, which will be null if the payment is sent
-     * through keysend.
+     * The optional payment request for this incoming payment,
+     * which will be null if the payment is sent through keysend.
      **/
     public readonly paymentRequestId?: string | 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,
   ) {
     autoBind(this);

package/src/objects/IncomingPaymentAttempt.ts

@@ -8,11 +8,16 @@ import {
 } from "./CurrencyAmount.js";
 import IncomingPaymentAttemptStatus from "./IncomingPaymentAttemptStatus.js";
 
-/** This object represents any attempted payment sent to a Lightspark node on the Lightning Network. You can retrieve this object to receive payment related information about a specific incoming payment attempt. **/
+/**
+ * This object represents any attempted payment sent to a Lightspark node on
+ * the Lightning Network. You can retrieve this object to receive payment
+ * related information about a specific incoming payment attempt.
+ * *
+ */
 interface IncomingPaymentAttempt {
   /**
-   * 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/IncomingPaymentAttemptStatus.ts

@@ -1,10 +1,14 @@
 // Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
 
-/** This is an enum that enumerates all potential statuses for an incoming payment attempt. **/
+/**
+ * This is an enum that enumerates all potential statuses for an incoming
+ * payment attempt. *
+ */
 export enum IncomingPaymentAttemptStatus {
   /**
-   * 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/IncomingPaymentToAttemptsConnection.ts

@@ -11,12 +11,16 @@ import { PageInfoFromJson, PageInfoToJson } from "./PageInfo.js";
 /** The connection from incoming payment to all attempts. **/
 interface IncomingPaymentToAttemptsConnection {
   /**
-   * 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 incoming payment attempts for the current page of this connection. **/

package/src/objects/Invoice.ts

@@ -13,8 +13,8 @@ import PaymentRequestStatus from "./PaymentRequestStatus.js";
 /** This object represents a BOLT #11 invoice (https://github.com/lightning/bolts/blob/master/11-payment-encoding.md) created by a Lightspark Node. You can retrieve this object to receive relevant payment information for a specific invoice generated by a Lightspark node. **/
 interface Invoice {
   /**
-   * 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/InvoiceData.ts

@@ -9,7 +9,11 @@ import {
 import type Node from "./Node.js";
 import { NodeFromJson, NodeToJson } from "./Node.js";
 
-/** This object represents the data associated with a BOLT #11 invoice. You can retrieve this object to receive the relevant data associated with a specific invoice. **/
+/**
+ * This object represents the data associated with a BOLT #11 invoice.
+ * You can retrieve this object to receive the relevant data associated with a
+ * specific invoice. *
+ */
 interface InvoiceData {
   encodedPaymentRequest: string;
 
@@ -19,8 +23,8 @@ interface InvoiceData {
   paymentHash: string;
 
   /**
-   * The requested amount in this invoice. If it is equal to 0, the sender should choose the amount to
-   * send.
+   * The requested amount in this invoice. If it is equal to 0,
+   * the sender should choose the amount to send.
    **/
   amount: CurrencyAmount;
 

package/src/objects/InvoiceType.ts

@@ -3,8 +3,9 @@
 /** This is an enum for potential invoice types. **/
 export enum InvoiceType {
   /**
-   * 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",
   /** A standard Bolt 11 invoice. **/

package/src/objects/LightningFeeEstimateForInvoiceInput.ts

@@ -8,8 +8,8 @@ interface LightningFeeEstimateForInvoiceInput {
   encodedPaymentRequest: string;
 
   /**
-   * If the invoice does not specify a payment amount, then the amount that you wish to pay, expressed
-   * in msats.
+   * If the invoice does not specify a payment amount,
+   * then the amount that you wish to pay, expressed in msats.
    **/
   amountMsats?: number | undefined;
 }

package/src/objects/LightningTransaction.ts

@@ -22,11 +22,16 @@ import type RoutingTransaction from "./RoutingTransaction.js";
 import RoutingTransactionFailureReason from "./RoutingTransactionFailureReason.js";
 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;
 
@@ -48,7 +53,10 @@ interface LightningTransaction {
   /** 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;
 }
 

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. **/