@lightsparkdev/lightspark-sdk 1.1.4 → 1.1.6

package/src/objects/ChannelSnapshot.ts

@@ -0,0 +1,57 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+import type CurrencyAmount from "./CurrencyAmount.js";
+import { CurrencyAmountFromJson } from "./CurrencyAmount.js";
+
+type ChannelSnapshot = {
+  localBalance?: CurrencyAmount;
+
+  localUnsettledBalance?: CurrencyAmount;
+
+  localChannelReserve?: CurrencyAmount;
+};
+
+export const ChannelSnapshotFromJson = (obj: any): ChannelSnapshot => {
+  return {
+    localBalance: !!obj["channel_snapshot_local_balance"]
+      ? CurrencyAmountFromJson(obj["channel_snapshot_local_balance"])
+      : undefined,
+    localUnsettledBalance: !!obj["channel_snapshot_local_unsettled_balance"]
+      ? CurrencyAmountFromJson(obj["channel_snapshot_local_unsettled_balance"])
+      : undefined,
+    localChannelReserve: !!obj["channel_snapshot_local_channel_reserve"]
+      ? CurrencyAmountFromJson(obj["channel_snapshot_local_channel_reserve"])
+      : undefined,
+  } as ChannelSnapshot;
+};
+
+export const FRAGMENT = `
+fragment ChannelSnapshotFragment on ChannelSnapshot {
+    __typename
+    channel_snapshot_local_balance: local_balance {
+        __typename
+        currency_amount_original_value: original_value
+        currency_amount_original_unit: original_unit
+        currency_amount_preferred_currency_unit: preferred_currency_unit
+        currency_amount_preferred_currency_value_rounded: preferred_currency_value_rounded
+        currency_amount_preferred_currency_value_approx: preferred_currency_value_approx
+    }
+    channel_snapshot_local_unsettled_balance: local_unsettled_balance {
+        __typename
+        currency_amount_original_value: original_value
+        currency_amount_original_unit: original_unit
+        currency_amount_preferred_currency_unit: preferred_currency_unit
+        currency_amount_preferred_currency_value_rounded: preferred_currency_value_rounded
+        currency_amount_preferred_currency_value_approx: preferred_currency_value_approx
+    }
+    channel_snapshot_local_channel_reserve: local_channel_reserve {
+        __typename
+        currency_amount_original_value: original_value
+        currency_amount_original_unit: original_unit
+        currency_amount_preferred_currency_unit: preferred_currency_unit
+        currency_amount_preferred_currency_value_rounded: preferred_currency_value_rounded
+        currency_amount_preferred_currency_value_approx: preferred_currency_value_approx
+    }
+}`;
+
+export default ChannelSnapshot;

package/src/objects/Entity.ts

@@ -1065,6 +1065,7 @@ fragment EntityFragment on Entity {
                 currency_amount_preferred_currency_value_approx: preferred_currency_value_approx
             }
         }
+        outgoing_payment_payment_preimage: payment_preimage
     }
     ... on OutgoingPaymentAttempt {
         __typename
@@ -1094,6 +1095,33 @@ fragment EntityFragment on Entity {
         outgoing_payment_attempt_outgoing_payment: outgoing_payment {
             id
         }
+        outgoing_payment_attempt_channel_snapshot: channel_snapshot {
+            __typename
+            channel_snapshot_local_balance: local_balance {
+                __typename
+                currency_amount_original_value: original_value
+                currency_amount_original_unit: original_unit
+                currency_amount_preferred_currency_unit: preferred_currency_unit
+                currency_amount_preferred_currency_value_rounded: preferred_currency_value_rounded
+                currency_amount_preferred_currency_value_approx: preferred_currency_value_approx
+            }
+            channel_snapshot_local_unsettled_balance: local_unsettled_balance {
+                __typename
+                currency_amount_original_value: original_value
+                currency_amount_original_unit: original_unit
+                currency_amount_preferred_currency_unit: preferred_currency_unit
+                currency_amount_preferred_currency_value_rounded: preferred_currency_value_rounded
+                currency_amount_preferred_currency_value_approx: preferred_currency_value_approx
+            }
+            channel_snapshot_local_channel_reserve: local_channel_reserve {
+                __typename
+                currency_amount_original_value: original_value
+                currency_amount_original_unit: original_unit
+                currency_amount_preferred_currency_unit: preferred_currency_unit
+                currency_amount_preferred_currency_value_rounded: preferred_currency_value_rounded
+                currency_amount_preferred_currency_value_approx: preferred_currency_value_approx
+            }
+        }
     }
     ... on RoutingTransaction {
         __typename

package/src/objects/IdAndSignature.ts

@@ -1,8 +1,10 @@
 // Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
 
 type IdAndSignature = {
+  /** The id of the message. **/
   id: string;
 
+  /** The signature of the message. **/
   signature: string;
 };
 

package/src/objects/LightningTransaction.ts

@@ -98,6 +98,7 @@ export const LightningTransactionFromJson = (
       obj["outgoing_payment_uma_post_transaction_data"]?.map((e) =>
         PostTransactionDataFromJson(e),
       ),
+      obj["outgoing_payment_payment_preimage"],
     );
   }
   if (obj["__typename"] == "RoutingTransaction") {
@@ -460,6 +461,7 @@ fragment LightningTransactionFragment on LightningTransaction {
                 currency_amount_preferred_currency_value_approx: preferred_currency_value_approx
             }
         }
+        outgoing_payment_payment_preimage: payment_preimage
     }
     ... on RoutingTransaction {
         __typename

package/src/objects/OutgoingPayment.ts

@@ -35,6 +35,7 @@ class OutgoingPayment implements LightningTransaction {
     public readonly failureReason?: PaymentFailureReason,
     public readonly failureMessage?: RichText,
     public readonly umaPostTransactionData?: PostTransactionData[],
+    public readonly paymentPreimage?: string,
   ) {
     autoBind(this);
   }
@@ -87,6 +88,33 @@ query FetchOutgoingPaymentToAttemptsConnection($entity_id: ID!, $first: Int, $af
                     outgoing_payment_attempt_outgoing_payment: outgoing_payment {
                         id
                     }
+                    outgoing_payment_attempt_channel_snapshot: channel_snapshot {
+                        __typename
+                        channel_snapshot_local_balance: local_balance {
+                            __typename
+                            currency_amount_original_value: original_value
+                            currency_amount_original_unit: original_unit
+                            currency_amount_preferred_currency_unit: preferred_currency_unit
+                            currency_amount_preferred_currency_value_rounded: preferred_currency_value_rounded
+                            currency_amount_preferred_currency_value_approx: preferred_currency_value_approx
+                        }
+                        channel_snapshot_local_unsettled_balance: local_unsettled_balance {
+                            __typename
+                            currency_amount_original_value: original_value
+                            currency_amount_original_unit: original_unit
+                            currency_amount_preferred_currency_unit: preferred_currency_unit
+                            currency_amount_preferred_currency_value_rounded: preferred_currency_value_rounded
+                            currency_amount_preferred_currency_value_approx: preferred_currency_value_approx
+                        }
+                        channel_snapshot_local_channel_reserve: local_channel_reserve {
+                            __typename
+                            currency_amount_original_value: original_value
+                            currency_amount_original_unit: original_unit
+                            currency_amount_preferred_currency_unit: preferred_currency_unit
+                            currency_amount_preferred_currency_value_rounded: preferred_currency_value_rounded
+                            currency_amount_preferred_currency_value_approx: preferred_currency_value_approx
+                        }
+                    }
                 }
             }
         }
@@ -149,6 +177,7 @@ export const OutgoingPaymentFromJson = (obj: any): OutgoingPayment => {
     obj["outgoing_payment_uma_post_transaction_data"]?.map((e) =>
       PostTransactionDataFromJson(e),
     ),
+    obj["outgoing_payment_payment_preimage"],
   );
 };
 
@@ -440,6 +469,7 @@ fragment OutgoingPaymentFragment on OutgoingPayment {
             currency_amount_preferred_currency_value_approx: preferred_currency_value_approx
         }
     }
+    outgoing_payment_payment_preimage: payment_preimage
 }`;
 
 export default OutgoingPayment;

package/src/objects/OutgoingPaymentAttempt.ts

@@ -3,6 +3,8 @@
 import { type Query } from "@lightsparkdev/core";
 import autoBind from "auto-bind";
 import type LightsparkClient from "../client.js";
+import type ChannelSnapshot from "./ChannelSnapshot.js";
+import { ChannelSnapshotFromJson } from "./ChannelSnapshot.js";
 import type CurrencyAmount from "./CurrencyAmount.js";
 import { CurrencyAmountFromJson } from "./CurrencyAmount.js";
 import type Entity from "./Entity.js";
@@ -25,6 +27,7 @@ class OutgoingPaymentAttempt implements Entity {
     public readonly resolvedAt?: string,
     public readonly amount?: CurrencyAmount,
     public readonly fees?: CurrencyAmount,
+    public readonly channelSnapshot?: ChannelSnapshot,
   ) {
     autoBind(this);
   }
@@ -135,6 +138,11 @@ export const OutgoingPaymentAttemptFromJson = (
     !!obj["outgoing_payment_attempt_fees"]
       ? CurrencyAmountFromJson(obj["outgoing_payment_attempt_fees"])
       : undefined,
+    !!obj["outgoing_payment_attempt_channel_snapshot"]
+      ? ChannelSnapshotFromJson(
+          obj["outgoing_payment_attempt_channel_snapshot"],
+        )
+      : undefined,
   );
 };
 
@@ -167,6 +175,33 @@ fragment OutgoingPaymentAttemptFragment on OutgoingPaymentAttempt {
     outgoing_payment_attempt_outgoing_payment: outgoing_payment {
         id
     }
+    outgoing_payment_attempt_channel_snapshot: channel_snapshot {
+        __typename
+        channel_snapshot_local_balance: local_balance {
+            __typename
+            currency_amount_original_value: original_value
+            currency_amount_original_unit: original_unit
+            currency_amount_preferred_currency_unit: preferred_currency_unit
+            currency_amount_preferred_currency_value_rounded: preferred_currency_value_rounded
+            currency_amount_preferred_currency_value_approx: preferred_currency_value_approx
+        }
+        channel_snapshot_local_unsettled_balance: local_unsettled_balance {
+            __typename
+            currency_amount_original_value: original_value
+            currency_amount_original_unit: original_unit
+            currency_amount_preferred_currency_unit: preferred_currency_unit
+            currency_amount_preferred_currency_value_rounded: preferred_currency_value_rounded
+            currency_amount_preferred_currency_value_approx: preferred_currency_value_approx
+        }
+        channel_snapshot_local_channel_reserve: local_channel_reserve {
+            __typename
+            currency_amount_original_value: original_value
+            currency_amount_original_unit: original_unit
+            currency_amount_preferred_currency_unit: preferred_currency_unit
+            currency_amount_preferred_currency_value_rounded: preferred_currency_value_rounded
+            currency_amount_preferred_currency_value_approx: preferred_currency_value_approx
+        }
+    }
 }`;
 
 export default OutgoingPaymentAttempt;

package/src/objects/RegisterPaymentInput.ts

@@ -4,12 +4,26 @@ import ComplianceProvider from "./ComplianceProvider.js";
 import PaymentDirection from "./PaymentDirection.js";
 
 type RegisterPaymentInput = {
+  /**
+   * 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.
+   **/
   provider: ComplianceProvider;
 
+  /**
+   * The Lightspark ID of the lightning payment you want to register. It can be the id of either an
+   * OutgoingPayment or an IncomingPayment.
+   **/
   paymentId: string;
 
+  /**
+   * The public key of the counterparty lightning node, which would be the public key of the recipient
+   * node if it is to register an outgoing payment, or the public key of the sender node if it is to
+   * register an incoming payment.
+   **/
   nodePubkey: string;
 
+  /** Indicates whether this payment is an OutgoingPayment or an IncomingPayment. **/
   direction: PaymentDirection;
 };
 

package/src/objects/ReleaseChannelPerCommitmentSecretInput.ts

@@ -1,10 +1,13 @@
 // Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
 
 type ReleaseChannelPerCommitmentSecretInput = {
+  /** The unique identifier of the channel. **/
   channelId: string;
 
+  /** The per-commitment secret to be released. **/
   perCommitmentSecret: string;
 
+  /** The index associated with the per-commitment secret. **/
   perCommitmentIndex: number;
 };
 

package/src/objects/ReleaseChannelPerCommitmentSecretOutput.ts

@@ -1,6 +1,7 @@
 // Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
 
 type ReleaseChannelPerCommitmentSecretOutput = {
+  /** The channel object after the per-commitment secret release operation. **/
   channelId: string;
 };
 

package/src/objects/ReleasePaymentPreimageOutput.ts

@@ -1,6 +1,7 @@
 // Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
 
 type ReleasePaymentPreimageOutput = {
+  /** The invoice of the transaction. **/
   invoiceId: string;
 };
 

package/src/objects/RemoteSigningSubEventType.ts

@@ -21,6 +21,8 @@ export enum RemoteSigningSubEventType {
   RELEASE_PAYMENT_PREIMAGE = "RELEASE_PAYMENT_PREIMAGE",
 
   REQUEST_INVOICE_PAYMENT_HASH = "REQUEST_INVOICE_PAYMENT_HASH",
+
+  REVEAL_COUNTERPARTY_PER_COMMITMENT_SECRET = "REVEAL_COUNTERPARTY_PER_COMMITMENT_SECRET",
 }
 
 export default RemoteSigningSubEventType;

package/src/objects/ScreenNodeInput.ts

@@ -3,8 +3,13 @@
 import ComplianceProvider from "./ComplianceProvider.js";
 
 type 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.
+   **/
   provider: ComplianceProvider;
 
+  /** The public key of the lightning node that needs to be screened. **/
   nodePubkey: string;
 };
 

package/src/objects/SetInvoicePaymentHashInput.ts

@@ -7,8 +7,11 @@ type SetInvoicePaymentHashInput = {
   /** The 32-byte hash of the payment preimage. **/
   paymentHash: string;
 
-  /** The 32-byte nonce used to generate the invoice preimage. **/
-  preimageNonce: string;
+  /**
+   * 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.
+   **/
+  preimageNonce?: string;
 };
 
 export const SetInvoicePaymentHashInputFromJson = (

package/src/objects/SignInvoiceInput.ts

@@ -1,10 +1,13 @@
 // Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
 
 type SignInvoiceInput = {
+  /** The unique identifier of the invoice to be signed. **/
   invoiceId: string;
 
+  /** The cryptographic signature for the invoice. **/
   signature: string;
 
+  /** The recovery identifier for the signature. **/
   recoveryId: number;
 };
 

package/src/objects/SignInvoiceOutput.ts

@@ -1,6 +1,7 @@
 // Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
 
 type SignInvoiceOutput = {
+  /** The signed invoice object. **/
   invoiceId: string;
 };
 

package/src/objects/SignMessagesInput.ts

@@ -4,6 +4,7 @@ import type IdAndSignature from "./IdAndSignature.js";
 import { IdAndSignatureFromJson } from "./IdAndSignature.js";
 
 type SignMessagesInput = {
+  /** The list of the message ids and signatures. **/
   signatures: IdAndSignature[];
 };
 

package/src/objects/SignMessagesOutput.ts

@@ -4,6 +4,7 @@ import type SignablePayload from "./SignablePayload.js";
 import { SignablePayloadFromJson } from "./SignablePayload.js";
 
 type SignMessagesOutput = {
+  /** The list of signed payloads. **/
   signedPayloads: SignablePayload[];
 };
 

package/src/objects/SignablePayloadStatus.ts

@@ -12,6 +12,8 @@ export enum SignablePayloadStatus {
   SIGNED = "SIGNED",
 
   VALIDATION_FAILED = "VALIDATION_FAILED",
+
+  INVALID_SIGNATURE = "INVALID_SIGNATURE",
 }
 
 export default SignablePayloadStatus;

package/src/objects/Transaction.ts

@@ -166,6 +166,7 @@ export const TransactionFromJson = (obj: any): Transaction => {
       obj["outgoing_payment_uma_post_transaction_data"]?.map((e) =>
         PostTransactionDataFromJson(e),
       ),
+      obj["outgoing_payment_payment_preimage"],
     );
   }
   if (obj["__typename"] == "RoutingTransaction") {
@@ -646,6 +647,7 @@ fragment TransactionFragment on Transaction {
                 currency_amount_preferred_currency_value_approx: preferred_currency_value_approx
             }
         }
+        outgoing_payment_payment_preimage: payment_preimage
     }
     ... on RoutingTransaction {
         __typename

package/src/objects/Wallet.ts

@@ -476,6 +476,7 @@ query FetchWalletToTransactionsConnection($entity_id: ID!, $first: Int, $after:
                                 currency_amount_preferred_currency_value_approx: preferred_currency_value_approx
                             }
                         }
+                        outgoing_payment_payment_preimage: payment_preimage
                     }
                     ... on RoutingTransaction {
                         __typename

package/src/objects/WebhookEventType.ts

@@ -10,6 +10,10 @@ export enum WebhookEventType {
 
   PAYMENT_FINISHED = "PAYMENT_FINISHED",
 
+  WITHDRAWAL_FINISHED = "WITHDRAWAL_FINISHED",
+
+  FUNDS_RECEIVED = "FUNDS_RECEIVED",
+
   NODE_STATUS = "NODE_STATUS",
 
   WALLET_STATUS = "WALLET_STATUS",
@@ -23,6 +27,8 @@ export enum WebhookEventType {
   WALLET_FUNDS_RECEIVED = "WALLET_FUNDS_RECEIVED",
 
   REMOTE_SIGNING = "REMOTE_SIGNING",
+
+  LOW_BALANCE = "LOW_BALANCE",
 }
 
 export default WebhookEventType;

package/src/objects/WithdrawalRequestStatus.ts

@@ -8,6 +8,8 @@ export enum WithdrawalRequestStatus {
    */
   FUTURE_VALUE = "FUTURE_VALUE",
 
+  CREATED = "CREATED",
+
   FAILED = "FAILED",
 
   IN_PROGRESS = "IN_PROGRESS",

package/src/objects/index.ts

@@ -19,6 +19,7 @@ export {
   default as ChannelOpeningTransaction,
   getChannelOpeningTransactionQuery,
 } from "./ChannelOpeningTransaction.js";
+export { default as ChannelSnapshot } from "./ChannelSnapshot.js";
 export { default as ChannelStatus } from "./ChannelStatus.js";
 export { default as ChannelToTransactionsConnection } from "./ChannelToTransactionsConnection.js";
 export { default as ComplianceProvider } from "./ComplianceProvider.js";