@lightsparkdev/lightspark-sdk 1.2.3 → 1.3.0

package/src/objects/RoutingTransactionFailureReason.ts

@@ -1,15 +1,13 @@
 // Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
 
 /**
- * This is an enum of the potential reasons that an attempted routed
- * transaction through a Lightspark node may have failed.
- * *
+ * This is an enum of the potential reasons that an attempted routed transaction through a
+ * Lightspark node may have failed. *
  */
 export enum RoutingTransactionFailureReason {
   /**
-   * 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/ScreenNodeInput.ts

@@ -5,8 +5,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.
+   * 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/SendPaymentInput.ts

@@ -14,8 +14,8 @@ interface SendPaymentInput {
   amountMsats: number;
 
   /**
-   * The maximum amount of fees that you want to pay for this payment to be
-   * sent, expressed in msats. *
+   * The maximum amount of fees that you want to pay for this payment to be sent, expressed in
+   * msats. *
    */
   maximumFeesMsats: number;
 }

package/src/objects/SetInvoicePaymentHashInput.ts

@@ -9,8 +9,8 @@ interface SetInvoicePaymentHashInput {
 
   /**
    * 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.
+   * It will later be included in RELEASE_PAYMENT_PREIMAGE webhook to help recover the raw
+   * preimage.
    **/
   preimageNonce?: string | undefined;
 }

package/src/objects/SignablePayload.ts

@@ -20,8 +20,8 @@ interface SignablePayload {
   payload: string;
 
   /**
-   * The consistent method for generating the same set of accounts and wallets
-   * for a given private key *
+   * The consistent method for generating the same set of accounts and wallets for a given
+   * private key *
    */
   derivationPath: string;
 

package/src/objects/SignablePayloadStatus.ts

@@ -2,9 +2,8 @@
 
 export enum SignablePayloadStatus {
   /**
-   * 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/Transaction.ts

@@ -27,11 +27,9 @@ import TransactionStatus from "./TransactionStatus.js";
 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.
+ * 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.
  * *
  */
 interface Transaction {
@@ -59,10 +57,7 @@ interface Transaction {
   /** 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/TransactionFailures.ts

@@ -3,10 +3,7 @@
 import PaymentFailureReason from "./PaymentFailureReason.js";
 import RoutingTransactionFailureReason from "./RoutingTransactionFailureReason.js";
 
-/**
- * This object represents payment failures associated with your Lightspark
- * Node. *
- */
+/** This object represents payment failures associated with your Lightspark Node. **/
 interface TransactionFailures {
   paymentFailures?: PaymentFailureReason[] | undefined;
 

package/src/objects/TransactionStatus.ts

@@ -1,14 +1,13 @@
 // Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
 
 /**
- * This is an enum of the potential statuses a transaction associated with your
- * Lightspark Node can take. *
+ * This is an enum of the potential statuses a transaction associated with your Lightspark Node can
+ * take. *
  */
 export enum TransactionStatus {
   /**
-   * 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",
   /** Transaction succeeded.. **/
@@ -18,15 +17,11 @@ 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.
-   * *
-   */
+  /** For transaction type PAYMENT_REQUEST only. A payment request has expired. **/
   EXPIRED = "EXPIRED",
   /** For transaction type PAYMENT_REQUEST only. **/
   CANCELLED = "CANCELLED",

package/src/objects/TransactionType.ts

@@ -1,53 +1,43 @@
 // Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
 
 /**
- * This is an enum of the potential types of transactions that can be
- * associated with your Lightspark Node.
- * *
+ * This is an enum of the potential types of transactions that can be associated with your
+ * Lightspark Node. *
  */
 export enum TransactionType {
   /**
-   * 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",
   /** Transactions initiated from a Lightspark node on Lightning Network. **/
   OUTGOING_PAYMENT = "OUTGOING_PAYMENT",
   /** Transactions received by a Lightspark node on Lightning Network. **/
   INCOMING_PAYMENT = "INCOMING_PAYMENT",
-  /**
-   * Transactions that forwarded payments through Lightspark nodes on Lightning
-   * Network. *
-   */
+  /** Transactions that forwarded payments through Lightspark nodes on Lightning Network. **/
   ROUTED = "ROUTED",
   /**
-   * Transactions on the Bitcoin blockchain to withdraw funds from a Lightspark
-   * node to a Bitcoin wallet. *
+   * Transactions on the Bitcoin blockchain to withdraw funds from a Lightspark node to a Bitcoin
+   * wallet. *
    */
   L1_WITHDRAW = "L1_WITHDRAW",
   /** Transactions on Bitcoin blockchain to fund a Lightspark node's wallet. **/
   L1_DEPOSIT = "L1_DEPOSIT",
   /**
-   * Transactions on Bitcoin blockchain to open a channel on Lightning Network
-   * funded by the local Lightspark node.
-   * *
+   * Transactions on Bitcoin blockchain to open a channel on Lightning Network funded by the local
+   * Lightspark node. *
    */
   CHANNEL_OPEN = "CHANNEL_OPEN",
   /**
-   * Transactions on Bitcoin blockchain to close a channel on Lightning Network
-   * where the balances are allocated back to local and remote nodes.
-   * *
+   * Transactions on Bitcoin blockchain to close a channel on Lightning Network where the balances
+   * are allocated back to local and remote nodes. *
    */
   CHANNEL_CLOSE = "CHANNEL_CLOSE",
   /** Transactions initiated from a Lightspark node on Lightning Network. **/
   PAYMENT = "PAYMENT",
   /** Payment requests from a Lightspark node on Lightning Network **/
   PAYMENT_REQUEST = "PAYMENT_REQUEST",
-  /**
-   * Transactions that forwarded payments through Lightspark nodes on Lightning
-   * Network. *
-   */
+  /** Transactions that forwarded payments through Lightspark nodes on Lightning Network. **/
   ROUTE = "ROUTE",
 }
 

package/src/objects/UmaInvitation.ts

@@ -27,10 +27,7 @@ interface UmaInvitation {
   /** The UMA of the user who created the invitation. **/
   inviterUma: string;
 
-  /**
-   * The current status of the incentives that may be tied to this invitation.
-   * *
-   */
+  /** The current status of the incentives that may be tied to this invitation. **/
   incentivesStatus: IncentivesStatus;
 
   /** The typename of the object **/
@@ -39,10 +36,7 @@ interface UmaInvitation {
   /** The UMA of the user who claimed the invitation. **/
   inviteeUma?: string | undefined;
 
-  /**
-   * The reason why the invitation is not eligible for incentives, if
-   * applicable. *
-   */
+  /** The reason why the invitation is not eligible for incentives, if applicable. **/
   incentivesIneligibilityReason?: IncentivesIneligibilityReason | undefined;
 }
 

package/src/objects/Wallet.ts

@@ -20,8 +20,8 @@ import { WalletToTransactionsConnectionFromJson } from "./WalletToTransactionsCo
 /**
  * This object represents a Lightspark Wallet, tied to your Lightspark account.
  * Wallets can be used to send or receive funds over the Lightning Network.
- * You can retrieve this object to receive information about a specific wallet
- * tied to your Lightspark account. *
+ * You can retrieve this object to receive information about a specific wallet tied to your
+ * Lightspark account. *
  */
 class Wallet implements LightsparkNodeOwner, Entity {
   constructor(
@@ -35,8 +35,7 @@ class Wallet implements LightsparkNodeOwner, Entity {
     /** The date and time when the entity was last updated. **/
     public readonly updatedAt: string,
     /**
-     * The unique identifier of this wallet,
-     * as provided by the Lightspark Customer during login.
+     * The unique identifier of this wallet, as provided by the Lightspark Customer during login.
      * *
      */
     public readonly thirdPartyIdentifier: string,

package/src/objects/WalletStatus.ts

@@ -1,14 +1,10 @@
 // Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
 
-/**
- * This is an enum of the potential statuses that your Lightspark wallet can
- * take.  *
- */
+/** This is an enum of the potential statuses that your Lightspark wallet can take.  **/
 export enum WalletStatus {
   /**
-   * 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",
   /**
@@ -17,39 +13,30 @@ export enum WalletStatus {
    * *
    */
   NOT_SETUP = "NOT_SETUP",
-  /**
-   * The wallet is currently being deployed in the Lightspark infrastructure.
-   * *
-   */
+  /** The wallet is currently being deployed in the Lightspark infrastructure. **/
   DEPLOYING = "DEPLOYING",
   /**
-   * The wallet has been deployed in the Lightspark infrastructure and is ready
-   * to be initialized. *
+   * The wallet has been deployed in the Lightspark infrastructure and is ready to be initialized.
+   * *
    */
   DEPLOYED = "DEPLOYED",
   /** The wallet is currently being initialized. **/
   INITIALIZING = "INITIALIZING",
   /** The wallet is available and ready to be used. **/
   READY = "READY",
-  /**
-   * The wallet is temporarily available,
-   * due to a transient issue or a scheduled maintenance.
-   * *
-   */
+  /** The wallet is temporarily available, due to a transient issue or a scheduled maintenance. **/
   UNAVAILABLE = "UNAVAILABLE",
   /**
-   * The wallet had an unrecoverable failure.
-   * This status is not expected to happend and will be investigated by the
-   * Lightspark team. *
+   * The wallet had an unrecoverable failure. This status is not expected to happend and will be
+   * investigated by the Lightspark team. *
    */
   FAILED = "FAILED",
   /** The wallet is being terminated. **/
   TERMINATING = "TERMINATING",
   /**
-   * The wallet has been terminated and is not available in the Lightspark
-   * infrastructure anymore. It is not connected to the Lightning network and
-   * its funds can only be accessed using the Funds Recovery flow.
-   * *
+   * The wallet has been terminated and is not available in the Lightspark infrastructure anymore.
+   * It is not connected to the Lightning network and its funds can only be accessed using the Funds
+   * Recovery flow. *
    */
   TERMINATED = "TERMINATED",
 }

package/src/objects/WalletToPaymentRequestsConnection.ts

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

package/src/objects/WalletToTransactionsConnection.ts

@@ -8,15 +8,12 @@ import { TransactionFromJson, TransactionToJson } from "./Transaction.js";
 interface WalletToTransactionsConnection {
   /**
    * 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 transactions for the current page of this connection. **/

package/src/objects/WebhookEventType.ts

@@ -1,14 +1,13 @@
 // Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
 
 /**
- * This is an enum of the potential event types that can be associated with
- * your Lightspark wallets. *
+ * This is an enum of the potential event types that can be associated with your Lightspark
+ * wallets. *
  */
 export enum WebhookEventType {
   /**
-   * 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/Withdrawal.ts

@@ -9,10 +9,9 @@ import {
 import TransactionStatus from "./TransactionStatus.js";
 
 /**
- * This object represents an L1 withdrawal from your Lightspark Node to any
- * Bitcoin wallet. You can retrieve this object to receive detailed information
- * about any L1 withdrawal associated with your Lightspark Node or account.
- * *
+ * This object represents an L1 withdrawal from your Lightspark Node to any Bitcoin wallet.
+ * You can retrieve this object to receive detailed information about any L1 withdrawal associated
+ * with your Lightspark Node or account. *
  */
 interface Withdrawal {
   /**
@@ -34,8 +33,8 @@ interface Withdrawal {
   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 +50,22 @@ interface Withdrawal {
   /** 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/WithdrawalMode.ts

@@ -1,14 +1,10 @@
 // Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
 
-/**
- * This is an enum of the potential modes that your Bitcoin withdrawal can
- * take. *
- */
+/** This is an enum of the potential modes that your Bitcoin withdrawal can take. **/
 export enum WithdrawalMode {
   /**
-   * 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/WithdrawalRequest.ts

@@ -17,9 +17,8 @@ import type WithdrawalRequestToChannelOpeningTransactionsConnection from "./With
 import { WithdrawalRequestToChannelOpeningTransactionsConnectionFromJson } from "./WithdrawalRequestToChannelOpeningTransactionsConnection.js";
 
 /**
- * This object represents a request made for an L1 withdrawal from your
- * Lightspark Node to any Bitcoin wallet.
- * You can retrieve this object to receive detailed information about any
+ * This object represents a request made for an L1 withdrawal from your Lightspark Node to any
+ * Bitcoin wallet. You can retrieve this object to receive detailed information about any
  * withdrawal request made from your Lightspark account.
  * *
  */
@@ -38,10 +37,7 @@ class WithdrawalRequest implements Entity {
     public readonly amount: CurrencyAmount,
     /** The bitcoin address where the funds should be sent. **/
     public readonly bitcoinAddress: string,
-    /**
-     * The strategy that should be used to withdraw the funds from the account.
-     * *
-     */
+    /** The strategy that should be used to withdraw the funds from the account. **/
     public readonly withdrawalMode: WithdrawalMode,
     /** The current status of this withdrawal request. **/
     public readonly status: WithdrawalRequestStatus,

package/src/objects/WithdrawalRequestStatus.ts

@@ -3,9 +3,8 @@
 /** This is an enum of the potential statuses that a Withdrawal can take. **/
 export enum WithdrawalRequestStatus {
   /**
-   * 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/WithdrawalRequestToChannelClosingTransactionsConnection.ts

@@ -9,23 +9,17 @@ import type PageInfo from "./PageInfo.js";
 import { PageInfoFromJson, PageInfoToJson } from "./PageInfo.js";
 
 interface WithdrawalRequestToChannelClosingTransactionsConnection {
-  /**
-   * 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 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;
 
-  /**
-   * The channel closing transactions for the current page of this connection.
-   * *
-   */
+  /** The channel closing transactions for the current page of this connection. **/
   entities: ChannelClosingTransaction[];
 }
 

package/src/objects/WithdrawalRequestToChannelOpeningTransactionsConnection.ts

@@ -9,23 +9,17 @@ import type PageInfo from "./PageInfo.js";
 import { PageInfoFromJson, PageInfoToJson } from "./PageInfo.js";
 
 interface WithdrawalRequestToChannelOpeningTransactionsConnection {
-  /**
-   * 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 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;
 
-  /**
-   * The channel opening transactions for the current page of this connection.
-   * *
-   */
+  /** The channel opening transactions for the current page of this connection. **/
   entities: ChannelOpeningTransaction[];
 }
 

package/src/objects/index.ts

@@ -9,6 +9,8 @@ export { default as ApiToken, getApiTokenQuery } from "./ApiToken.js";
 export { default as Balances } from "./Balances.js";
 export { default as BitcoinNetwork } from "./BitcoinNetwork.js";
 export { default as BlockchainBalance } from "./BlockchainBalance.js";
+export { default as CancelInvoiceInput } from "./CancelInvoiceInput.js";
+export { default as CancelInvoiceOutput } from "./CancelInvoiceOutput.js";
 export { default as Channel } from "./Channel.js";
 export {
   default as ChannelClosingTransaction,

package/src/tests/integration/general-regtest.test.ts

@@ -485,6 +485,20 @@ describe(p1SuiteName, () => {
     TESTS_TIMEOUT,
   );
 
+  test("Should create and cancel uma invoice", async () => {
+    const umaInvoice = await lightsparkClient.createUmaInvoice(
+      getRegtestNodeId(),
+      10_000,
+      "hi there!",
+    );
+    expect(umaInvoice).toBeDefined();
+    const cancelledInvoice = await lightsparkClient.cancelInvoice(
+      umaInvoice!.id,
+    );
+    expect(cancelledInvoice).toBeDefined();
+    expect(cancelledInvoice?.id).toBe(umaInvoice?.id);
+  });
+
   test(
     "Should create STANDARD a test mode invoice",
     async () => {