@lightsparkdev/lightspark-sdk 1.2.1 → 1.2.3

package/src/objects/WalletToTransactionsConnection.ts

@@ -7,12 +7,16 @@ 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).
+   * 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. **/

package/src/objects/WebhookEventType.ts

@@ -1,21 +1,29 @@
 // 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",
 
   PAYMENT_FINISHED = "PAYMENT_FINISHED",
 
+  FORCE_CLOSURE = "FORCE_CLOSURE",
+
   WITHDRAWAL_FINISHED = "WITHDRAWAL_FINISHED",
 
   FUNDS_RECEIVED = "FUNDS_RECEIVED",
 
   NODE_STATUS = "NODE_STATUS",
 
+  UMA_INVITATION_CLAIMED = "UMA_INVITATION_CLAIMED",
+
   WALLET_STATUS = "WALLET_STATUS",
 
   WALLET_OUTGOING_PAYMENT_FINISHED = "WALLET_OUTGOING_PAYMENT_FINISHED",

package/src/objects/Withdrawal.ts

@@ -8,11 +8,16 @@ import {
 } from "./CurrencyAmount.js";
 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 {
   /**
-   * 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 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;
 
@@ -46,22 +51,28 @@ 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,10 +1,14 @@
 // 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

@@ -16,12 +16,18 @@ import { WithdrawalRequestToChannelClosingTransactionsConnectionFromJson } from
 import type WithdrawalRequestToChannelOpeningTransactionsConnection from "./WithdrawalRequestToChannelOpeningTransactionsConnection.js";
 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 withdrawal request made from your Lightspark account. **/
+/**
+ * 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.
+ * *
+ */
 class WithdrawalRequest 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. **/
@@ -32,15 +38,18 @@ 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,
     /** The typename of the object **/
     public readonly typename: string,
     /**
-     * If the requested amount is `-1` (i.e. everything), this field may contain an estimate of the amount
-     * for the withdrawal.
+     * If the requested amount is `-1` (i.e. everything),
+     * this field may contain an estimate of the amount for the withdrawal.
      **/
     public readonly estimatedAmount?: CurrencyAmount | undefined,
     /** The time at which this request was completed. **/

package/src/objects/WithdrawalRequestStatus.ts

@@ -3,8 +3,9 @@
 /** 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,16 +9,23 @@ 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).
+   * 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 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,16 +9,23 @@ 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).
+   * 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 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

@@ -22,10 +22,16 @@ export {
 export { default as ChannelSnapshot } from "./ChannelSnapshot.js";
 export { default as ChannelStatus } from "./ChannelStatus.js";
 export { default as ChannelToTransactionsConnection } from "./ChannelToTransactionsConnection.js";
+export { default as ClaimUmaInvitationInput } from "./ClaimUmaInvitationInput.js";
+export { default as ClaimUmaInvitationOutput } from "./ClaimUmaInvitationOutput.js";
+export { default as ClaimUmaInvitationWithIncentivesInput } from "./ClaimUmaInvitationWithIncentivesInput.js";
+export { default as ClaimUmaInvitationWithIncentivesOutput } from "./ClaimUmaInvitationWithIncentivesOutput.js";
 export { default as ComplianceProvider } from "./ComplianceProvider.js";
 export { default as Connection } from "./Connection.js";
 export { default as CreateApiTokenInput } from "./CreateApiTokenInput.js";
 export { default as CreateApiTokenOutput } from "./CreateApiTokenOutput.js";
+export { default as CreateInvitationWithIncentivesInput } from "./CreateInvitationWithIncentivesInput.js";
+export { default as CreateInvitationWithIncentivesOutput } from "./CreateInvitationWithIncentivesOutput.js";
 export { default as CreateInvoiceInput } from "./CreateInvoiceInput.js";
 export { default as CreateInvoiceOutput } from "./CreateInvoiceOutput.js";
 export { default as CreateLnurlInvoiceInput } from "./CreateLnurlInvoiceInput.js";
@@ -35,6 +41,8 @@ export { default as CreateTestModeInvoiceInput } from "./CreateTestModeInvoiceIn
 export { default as CreateTestModeInvoiceOutput } from "./CreateTestModeInvoiceOutput.js";
 export { default as CreateTestModePaymentInput } from "./CreateTestModePaymentInput.js";
 export { default as CreateTestModePaymentoutput } from "./CreateTestModePaymentoutput.js";
+export { default as CreateUmaInvitationInput } from "./CreateUmaInvitationInput.js";
+export { default as CreateUmaInvitationOutput } from "./CreateUmaInvitationOutput.js";
 export { default as CreateUmaInvoiceInput } from "./CreateUmaInvoiceInput.js";
 export { default as CurrencyAmount } from "./CurrencyAmount.js";
 export { default as CurrencyUnit } from "./CurrencyUnit.js";
@@ -51,6 +59,8 @@ export { default as GraphNode } from "./GraphNode.js";
 export { default as Hop, getHopQuery } from "./Hop.js";
 export { default as HtlcAttemptFailureCode } from "./HtlcAttemptFailureCode.js";
 export { default as IdAndSignature } from "./IdAndSignature.js";
+export { default as IncentivesIneligibilityReason } from "./IncentivesIneligibilityReason.js";
+export { default as IncentivesStatus } from "./IncentivesStatus.js";
 export { default as IncomingPayment } from "./IncomingPayment.js";
 export {
   default as IncomingPaymentAttempt,
@@ -92,12 +102,13 @@ export { default as OutgoingPayment } from "./OutgoingPayment.js";
 export { default as OutgoingPaymentAttempt } from "./OutgoingPaymentAttempt.js";
 export { default as OutgoingPaymentAttemptStatus } from "./OutgoingPaymentAttemptStatus.js";
 export { default as OutgoingPaymentAttemptToHopsConnection } from "./OutgoingPaymentAttemptToHopsConnection.js";
+export { default as OutgoingPaymentToAttemptsConnection } from "./OutgoingPaymentToAttemptsConnection.js";
 export { default as OutgoingPaymentsForInvoiceQueryInput } from "./OutgoingPaymentsForInvoiceQueryInput.js";
 export { default as OutgoingPaymentsForInvoiceQueryOutput } from "./OutgoingPaymentsForInvoiceQueryOutput.js";
-export { default as OutgoingPaymentToAttemptsConnection } from "./OutgoingPaymentToAttemptsConnection.js";
 export { default as PageInfo } from "./PageInfo.js";
 export { default as PayInvoiceInput } from "./PayInvoiceInput.js";
 export { default as PayInvoiceOutput } from "./PayInvoiceOutput.js";
+export { default as PayUmaInvoiceInput } from "./PayUmaInvoiceInput.js";
 export { default as PaymentDirection } from "./PaymentDirection.js";
 export { default as PaymentFailureReason } from "./PaymentFailureReason.js";
 export {
@@ -106,9 +117,9 @@ export {
 } from "./PaymentRequest.js";
 export { default as PaymentRequestData } from "./PaymentRequestData.js";
 export { default as PaymentRequestStatus } from "./PaymentRequestStatus.js";
-export { default as PayUmaInvoiceInput } from "./PayUmaInvoiceInput.js";
 export { default as Permission } from "./Permission.js";
 export { default as PostTransactionData } from "./PostTransactionData.js";
+export { default as RegionCode } from "./RegionCode.js";
 export { default as RegisterPaymentInput } from "./RegisterPaymentInput.js";
 export { default as RegisterPaymentOutput } from "./RegisterPaymentOutput.js";
 export { default as ReleaseChannelPerCommitmentSecretInput } from "./ReleaseChannelPerCommitmentSecretInput.js";
@@ -132,22 +143,26 @@ export { default as SendPaymentInput } from "./SendPaymentInput.js";
 export { default as SendPaymentOutput } from "./SendPaymentOutput.js";
 export { default as SetInvoicePaymentHashInput } from "./SetInvoicePaymentHashInput.js";
 export { default as SetInvoicePaymentHashOutput } from "./SetInvoicePaymentHashOutput.js";
+export { default as SignInvoiceInput } from "./SignInvoiceInput.js";
+export { default as SignInvoiceOutput } from "./SignInvoiceOutput.js";
+export { default as SignMessagesInput } from "./SignMessagesInput.js";
+export { default as SignMessagesOutput } from "./SignMessagesOutput.js";
 export { default as Signable, getSignableQuery } from "./Signable.js";
 export {
   default as SignablePayload,
   getSignablePayloadQuery,
 } from "./SignablePayload.js";
 export { default as SignablePayloadStatus } from "./SignablePayloadStatus.js";
-export { default as SignInvoiceInput } from "./SignInvoiceInput.js";
-export { default as SignInvoiceOutput } from "./SignInvoiceOutput.js";
-export { default as SignMessagesInput } from "./SignMessagesInput.js";
-export { default as SignMessagesOutput } from "./SignMessagesOutput.js";
 export { default as SingleNodeDashboard } from "./SingleNodeDashboard.js";
 export { default as Transaction, getTransactionQuery } from "./Transaction.js";
 export { default as TransactionFailures } from "./TransactionFailures.js";
 export { default as TransactionStatus } from "./TransactionStatus.js";
 export { default as TransactionType } from "./TransactionType.js";
 export { default as TransactionUpdate } from "./TransactionUpdate.js";
+export {
+  default as UmaInvitation,
+  getUmaInvitationQuery,
+} from "./UmaInvitation.js";
 export { default as UpdateChannelPerCommitmentPointInput } from "./UpdateChannelPerCommitmentPointInput.js";
 export { default as UpdateChannelPerCommitmentPointOutput } from "./UpdateChannelPerCommitmentPointOutput.js";
 export { default as UpdateNodeSharedSecretInput } from "./UpdateNodeSharedSecretInput.js";

package/src/tests/integration/constants.ts

@@ -5,9 +5,6 @@ export const INVOICE_EXPIRY = 172800; //ms
 export const TRANSACTION_WAIT_TIME = TESTS_TIMEOUT / 1000; //seconds
 export const PAGINATION_STEP = 3;
 
-export const PAY_AMOUNT = 1_000; //msats
-export const MAX_FEE = 10000000; //msats
-
 export const REGTEST_SIGNING_KEY_PASSWORD = "1234!@#$";
 export const ENCODED_REGTEST_REQUEST_FOR_TESTS =
   "lnbcrt1pjj6zu2pp50qr2p79v65u9l8w3859259yj9fe5nt79hfw5k2am424440tlj09qdq0dp5jqargv4ex2ggcqzpgxqyz5vqsp5v0z0fu99jf37xcasu88evuphx9kdrpvtupdvhu329kx7k7un59zs9qyyssqegzx986rszy96te2kmxl7prlz0p8avthpwzhsz5v220uek7xxrz54svdsjpzwn04m6utj5ua9tmtktygc5xmjmjaqey9dadt33r8gxspvcg8wv";