@lightsparkdev/lightspark-sdk 1.2.3 → 1.3.1

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 () => {