@lightsparkdev/lightspark-sdk 1.0.7 → 1.1.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @lightsparkdev/lightspark-sdk
 
+## 1.1.0
+
+### Minor Changes
+
+- c4926df: Change createTestModePayment to return an IncomingPayment
+
 ## 1.0.7
 
 ### Patch Changes

package/dist/{chunk-K2ZU5YQL.js → chunk-AXCZMV2D.js}

@@ -8823,32 +8823,34 @@ export {
   InvoiceFromJson,
   FRAGMENT24 as FRAGMENT5,
   getInvoiceQuery,
+  IncomingPaymentAttemptStatus_default,
+  getIncomingPaymentAttemptQuery,
+  TransactionStatus_default,
+  IncomingPaymentFromJson,
+  FRAGMENT12 as FRAGMENT6,
+  IncomingPayment_default,
+  FRAGMENT25 as FRAGMENT7,
   HtlcAttemptFailureCode_default,
   OutgoingPaymentAttemptStatus_default,
   getHopQuery,
   OutgoingPaymentAttempt_default,
   PaymentFailureReason_default,
-  TransactionStatus_default,
   OutgoingPaymentFromJson,
-  FRAGMENT15 as FRAGMENT6,
+  FRAGMENT15 as FRAGMENT8,
   OutgoingPayment_default,
-  FRAGMENT25 as FRAGMENT7,
   WithdrawalMode_default,
   WithdrawalRequestStatus_default,
   getChannelClosingTransactionQuery,
   getChannelOpeningTransactionQuery,
   WithdrawalRequestFromJson,
-  FRAGMENT33 as FRAGMENT8,
+  FRAGMENT33 as FRAGMENT9,
   WithdrawalRequest_default,
-  IncomingPaymentAttemptStatus_default,
-  getIncomingPaymentAttemptQuery,
-  IncomingPayment_default,
   RoutingTransactionFailureReason_default,
   TransactionFromJson,
-  FRAGMENT16 as FRAGMENT9,
+  FRAGMENT16 as FRAGMENT10,
   getTransactionQuery,
   TransactionUpdateFromJson,
-  FRAGMENT31 as FRAGMENT10,
+  FRAGMENT31 as FRAGMENT11,
   AccountToChannelsConnection_default,
   LightsparkNode_default,
   getPaymentRequestQuery,

package/dist/{index-dbf06298.d.ts → index-bddc6d51.d.ts}

@@ -760,6 +760,111 @@ type FeeEstimate = {
     feeMin: CurrencyAmount;
 };
 
+/** This is an enum that enumerates all potential statuses for an incoming payment attempt. **/
+declare 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.
+     */
+    FUTURE_VALUE = "FUTURE_VALUE",
+    ACCEPTED = "ACCEPTED",
+    SETTLED = "SETTLED",
+    CANCELED = "CANCELED",
+    UNKNOWN = "UNKNOWN"
+}
+
+/** 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. **/
+type IncomingPaymentAttempt = Entity & {
+    /**
+     * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
+     * string.
+     **/
+    id: string;
+    /** The date and time when the entity was first created. **/
+    createdAt: string;
+    /** The date and time when the entity was last updated. **/
+    updatedAt: string;
+    /** The status of the incoming payment attempt. **/
+    status: IncomingPaymentAttemptStatus;
+    /** The total amount of that was attempted to send. **/
+    amount: CurrencyAmount;
+    /** The channel this attempt was made on. **/
+    channelId: string;
+    /** The typename of the object **/
+    typename: string;
+    /** The time the incoming payment attempt failed or succeeded. **/
+    resolvedAt?: string;
+};
+declare const getIncomingPaymentAttemptQuery: (id: string) => Query<IncomingPaymentAttempt>;
+
+/** The connection from incoming payment to all attempts. **/
+type IncomingPaymentToAttemptsConnection = Connection & {
+    /**
+     * 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. **/
+    pageInfo: PageInfo;
+    /** The incoming payment attempts for the current page of this connection. **/
+    entities: IncomingPaymentAttempt[];
+    /** The typename of the object **/
+    typename: string;
+};
+
+/** 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. **/
+type LightningTransaction = Transaction & Entity & {
+    /**
+     * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
+     * string.
+     **/
+    id: string;
+    /** The date and time when this transaction was initiated. **/
+    createdAt: string;
+    /** The date and time when the entity was last updated. **/
+    updatedAt: string;
+    /** The current status of this transaction. **/
+    status: TransactionStatus;
+    /** The amount of money involved in this transaction. **/
+    amount: CurrencyAmount;
+    /** The typename of the object **/
+    typename: string;
+    /** The date and time when this transaction was completed or failed. **/
+    resolvedAt?: string;
+    /** The hash of this transaction, so it can be uniquely identified on the Lightning Network. **/
+    transactionHash?: string;
+};
+declare const getLightningTransactionQuery: (id: string) => Query<LightningTransaction>;
+
+/** This object represents post-transaction data that could be used to register payment for KYT. **/
+type PostTransactionData = {
+    /**
+     * The utxo of the channel over which the payment went through in the format of
+     * <transaction_hash>:<output_index>.
+     **/
+    utxo: string;
+    /** The amount of funds transferred in the payment. **/
+    amount: CurrencyAmount;
+};
+
+/** 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. **/
+declare class IncomingPayment implements LightningTransaction {
+    readonly id: string;
+    readonly createdAt: string;
+    readonly updatedAt: string;
+    readonly status: TransactionStatus;
+    readonly amount: CurrencyAmount;
+    readonly destinationId: string;
+    readonly typename: string;
+    readonly resolvedAt?: string | undefined;
+    readonly transactionHash?: string | undefined;
+    readonly paymentRequestId?: string | undefined;
+    readonly umaPostTransactionData?: PostTransactionData[] | undefined;
+    constructor(id: string, createdAt: string, updatedAt: string, status: TransactionStatus, amount: CurrencyAmount, destinationId: string, typename: string, resolvedAt?: string | undefined, transactionHash?: string | undefined, paymentRequestId?: string | undefined, umaPostTransactionData?: PostTransactionData[] | undefined);
+    getAttempts(client: LightsparkClient, first?: number | undefined, statuses?: IncomingPaymentAttemptStatus[] | undefined, after?: string | undefined): Promise<IncomingPaymentToAttemptsConnection>;
+    static getIncomingPaymentQuery(id: string): Query<IncomingPayment>;
+}
+
 /** 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. **/
 type InvoiceData = PaymentRequestData & {
     encodedPaymentRequest: string;
@@ -818,30 +923,6 @@ declare enum InvoiceType {
     AMP = "AMP"
 }
 
-/** 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. **/
-type LightningTransaction = Transaction & Entity & {
-    /**
-     * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
-     * string.
-     **/
-    id: string;
-    /** The date and time when this transaction was initiated. **/
-    createdAt: string;
-    /** The date and time when the entity was last updated. **/
-    updatedAt: string;
-    /** The current status of this transaction. **/
-    status: TransactionStatus;
-    /** The amount of money involved in this transaction. **/
-    amount: CurrencyAmount;
-    /** The typename of the object **/
-    typename: string;
-    /** The date and time when this transaction was completed or failed. **/
-    resolvedAt?: string;
-    /** The hash of this transaction, so it can be uniquely identified on the Lightning Network. **/
-    transactionHash?: string;
-};
-declare const getLightningTransactionQuery: (id: string) => Query<LightningTransaction>;
-
 /** This is an enum representing a particular reason why an htlc sent over the Lightning Network may have failed. **/
 declare enum HtlcAttemptFailureCode {
     /**
@@ -966,17 +1047,6 @@ type OutgoingPaymentToAttemptsConnection = Connection & {
     typename: string;
 };
 
-/** This object represents post-transaction data that could be used to register payment for KYT. **/
-type PostTransactionData = {
-    /**
-     * The utxo of the channel over which the payment went through in the format of
-     * <transaction_hash>:<output_index>.
-     **/
-    utxo: string;
-    /** The amount of funds transferred in the payment. **/
-    amount: CurrencyAmount;
-};
-
 type RichText = {
     text: string;
 };
@@ -1577,7 +1647,7 @@ declare class LightsparkClient {
      * @param amountMsats The amount to pay in milli-satoshis for 0-amount invoices. This should be null for non-zero
      *     amount invoices.
      */
-    createTestModePayment(localNodeId: string, encodedInvoice: string, amountMsats?: number | undefined): Promise<OutgoingPayment | null>;
+    createTestModePayment(localNodeId: string, encodedInvoice: string, amountMsats?: number | undefined): Promise<IncomingPayment | null>;
     /**
      * Executes a raw `Query` against the Lightspark API.
      *
@@ -1818,76 +1888,6 @@ type IdAndSignature = {
     signature: string;
 };
 
-/** This is an enum that enumerates all potential statuses for an incoming payment attempt. **/
-declare 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.
-     */
-    FUTURE_VALUE = "FUTURE_VALUE",
-    ACCEPTED = "ACCEPTED",
-    SETTLED = "SETTLED",
-    CANCELED = "CANCELED",
-    UNKNOWN = "UNKNOWN"
-}
-
-/** 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. **/
-type IncomingPaymentAttempt = Entity & {
-    /**
-     * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
-     * string.
-     **/
-    id: string;
-    /** The date and time when the entity was first created. **/
-    createdAt: string;
-    /** The date and time when the entity was last updated. **/
-    updatedAt: string;
-    /** The status of the incoming payment attempt. **/
-    status: IncomingPaymentAttemptStatus;
-    /** The total amount of that was attempted to send. **/
-    amount: CurrencyAmount;
-    /** The channel this attempt was made on. **/
-    channelId: string;
-    /** The typename of the object **/
-    typename: string;
-    /** The time the incoming payment attempt failed or succeeded. **/
-    resolvedAt?: string;
-};
-declare const getIncomingPaymentAttemptQuery: (id: string) => Query<IncomingPaymentAttempt>;
-
-/** The connection from incoming payment to all attempts. **/
-type IncomingPaymentToAttemptsConnection = Connection & {
-    /**
-     * 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. **/
-    pageInfo: PageInfo;
-    /** The incoming payment attempts for the current page of this connection. **/
-    entities: IncomingPaymentAttempt[];
-    /** The typename of the object **/
-    typename: string;
-};
-
-/** 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. **/
-declare class IncomingPayment implements LightningTransaction {
-    readonly id: string;
-    readonly createdAt: string;
-    readonly updatedAt: string;
-    readonly status: TransactionStatus;
-    readonly amount: CurrencyAmount;
-    readonly destinationId: string;
-    readonly typename: string;
-    readonly resolvedAt?: string | undefined;
-    readonly transactionHash?: string | undefined;
-    readonly paymentRequestId?: string | undefined;
-    readonly umaPostTransactionData?: PostTransactionData[] | undefined;
-    constructor(id: string, createdAt: string, updatedAt: string, status: TransactionStatus, amount: CurrencyAmount, destinationId: string, typename: string, resolvedAt?: string | undefined, transactionHash?: string | undefined, paymentRequestId?: string | undefined, umaPostTransactionData?: PostTransactionData[] | undefined);
-    getAttempts(client: LightsparkClient, first?: number | undefined, statuses?: IncomingPaymentAttemptStatus[] | undefined, after?: string | undefined): Promise<IncomingPaymentToAttemptsConnection>;
-    static getIncomingPaymentQuery(id: string): Query<IncomingPayment>;
-}
-
 type LightningFeeEstimateForInvoiceInput = {
     /** The node from where you want to send the payment. **/
     nodeId: string;