@lightsparkdev/lightspark-sdk 0.1.7 → 0.2.1

package/dist/objects/index.js

@@ -41,7 +41,7 @@ import {
   getRoutingTransactionQuery,
   getTransactionQuery,
   getWithdrawalQuery
-} from "../chunk-3VRI7CHE.js";
+} from "../chunk-5Z7FB6OT.js";
 export {
   Account_default as Account,
   AccountToChannelsConnection_default as AccountToChannelsConnection,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lightsparkdev/lightspark-sdk",
-  "version": "0.1.7",
+  "version": "0.2.1",
   "description": "Lightspark JS SDK",
   "author": "Lightspark Inc.",
   "keywords": [
@@ -68,7 +68,7 @@
   },
   "license": "Apache-2.0",
   "dependencies": {
-    "@lightsparkdev/core": "^0.1.7",
+    "@lightsparkdev/core": "^0.2.1",
     "auto-bind": "^5.0.1",
     "crypto": "^1.0.1",
     "crypto-browserify": "^3.12.0",

package/src/client.ts

@@ -98,12 +98,13 @@ class LightsparkClient {
   constructor(
     private authProvider: AuthProvider = new StubAuthProvider(),
     private readonly serverUrl: string = "api.lightspark.com",
-    // TODO(Jeremy): Figure out a way to avoid needing this from the wallet client.
     private readonly nodeKeyCache: NodeKeyCache = new NodeKeyCache()
   ) {
+    const sdkVersion = require("../package.json").version;
     this.requester = new Requester(
       this.nodeKeyCache,
-      WALLET_SDK_ENDPOINT,
+      LIGHTSPARK_SDK_ENDPOINT,
+      `js-lightspark-sdk/${sdkVersion}`,
       authProvider,
       serverUrl
     );
@@ -118,9 +119,11 @@ class LightsparkClient {
    * @param authProvider
    */
   public async setAuthProvider(authProvider: AuthProvider) {
+    const sdkVersion = require("../package.json").version;
     this.requester = new Requester(
       this.nodeKeyCache,
-      WALLET_SDK_ENDPOINT,
+      LIGHTSPARK_SDK_ENDPOINT,
+      `js-lightspark-sdk/${sdkVersion}`,
       authProvider,
       this.serverUrl
     );
@@ -754,6 +757,6 @@ class LightsparkClient {
   }
 }
 
-const WALLET_SDK_ENDPOINT = "graphql/server/2023-04-04";
+const LIGHTSPARK_SDK_ENDPOINT = "graphql/server/2023-04-04";
 
 export default LightsparkClient;

package/src/objects/Account.ts

@@ -754,6 +754,7 @@ query FetchAccountToTransactionsConnection($first: Int, $after: String, $types:
                                 }
                                 invoice_data_created_at: created_at
                                 invoice_data_expires_at: expires_at
+                                invoice_data_memo: memo
                                 invoice_data_destination: destination {
                                     __typename
                                     ... on GraphNode {
@@ -874,7 +875,6 @@ query FetchAccountToTransactionsConnection($first: Int, $after: String, $types:
                                         lightspark_node_status: status
                                     }
                                 }
-                                invoice_data_memo: memo
                             }
                         }
                         outgoing_payment_failure_reason: failure_reason
@@ -1021,6 +1021,7 @@ query FetchAccountToPaymentRequestsConnection($first: Int, $after: String, $afte
                             }
                             invoice_data_created_at: created_at
                             invoice_data_expires_at: expires_at
+                            invoice_data_memo: memo
                             invoice_data_destination: destination {
                                 __typename
                                 ... on GraphNode {
@@ -1141,7 +1142,6 @@ query FetchAccountToPaymentRequestsConnection($first: Int, $after: String, $afte
                                     lightspark_node_status: status
                                 }
                             }
-                            invoice_data_memo: memo
                         }
                         invoice_status: status
                         invoice_amount_paid: amount_paid {

package/src/objects/Entity.ts

@@ -332,6 +332,7 @@ fragment EntityFragment on Entity {
             }
             invoice_data_created_at: created_at
             invoice_data_expires_at: expires_at
+            invoice_data_memo: memo
             invoice_data_destination: destination {
                 __typename
                 ... on GraphNode {
@@ -452,7 +453,6 @@ fragment EntityFragment on Entity {
                     lightspark_node_status: status
                 }
             }
-            invoice_data_memo: memo
         }
         invoice_status: status
         invoice_amount_paid: amount_paid {
@@ -616,6 +616,7 @@ fragment EntityFragment on Entity {
                 }
                 invoice_data_created_at: created_at
                 invoice_data_expires_at: expires_at
+                invoice_data_memo: memo
                 invoice_data_destination: destination {
                     __typename
                     ... on GraphNode {
@@ -736,7 +737,6 @@ fragment EntityFragment on Entity {
                         lightspark_node_status: status
                     }
                 }
-                invoice_data_memo: memo
             }
         }
         outgoing_payment_failure_reason: failure_reason
@@ -855,6 +855,14 @@ fragment EntityFragment on Entity {
             currency_amount_preferred_currency_value_rounded: preferred_currency_value_rounded
             currency_amount_preferred_currency_value_approx: preferred_currency_value_approx
         }
+        withdrawal_request_estimated_amount: estimated_amount {
+            __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
+        }
         withdrawal_request_bitcoin_address: bitcoin_address
         withdrawal_request_withdrawal_mode: withdrawal_mode
         withdrawal_request_status: status

package/src/objects/Invoice.ts

@@ -72,6 +72,7 @@ fragment InvoiceFragment on Invoice {
         }
         invoice_data_created_at: created_at
         invoice_data_expires_at: expires_at
+        invoice_data_memo: memo
         invoice_data_destination: destination {
             __typename
             ... on GraphNode {
@@ -192,7 +193,6 @@ fragment InvoiceFragment on Invoice {
                 lightspark_node_status: status
             }
         }
-        invoice_data_memo: memo
     }
     invoice_status: status
     invoice_amount_paid: amount_paid {

package/src/objects/InvoiceData.ts

@@ -11,19 +11,28 @@ type InvoiceData = PaymentRequestData & {
 
   bitcoinNetwork: BitcoinNetwork;
 
+  /** The payment hash of this invoice. **/
   paymentHash: string;
 
+  /**
+   * The requested amount in this invoice. If it is equal to 0, the sender should choose the amount to
+   * send.
+   **/
   amount: CurrencyAmount;
 
+  /** The date and time when this invoice was created. **/
   createdAt: string;
 
+  /** The date and time when this invoice will expire. **/
   expiresAt: string;
 
+  /** The lightning node that will be paid when fulfilling this invoice. **/
   destination: Node;
 
   /** The typename of the object **/
   typename: string;
 
+  /** A short, UTF-8 encoded, description of the purpose of this invoice. **/
   memo?: string;
 };
 
@@ -59,6 +68,7 @@ fragment InvoiceDataFragment on InvoiceData {
     }
     invoice_data_created_at: created_at
     invoice_data_expires_at: expires_at
+    invoice_data_memo: memo
     invoice_data_destination: destination {
         __typename
         ... on GraphNode {
@@ -179,7 +189,6 @@ fragment InvoiceDataFragment on InvoiceData {
             lightspark_node_status: status
         }
     }
-    invoice_data_memo: memo
 }`;
 
 export default InvoiceData;

package/src/objects/LightningTransaction.ts

@@ -203,6 +203,7 @@ fragment LightningTransactionFragment on LightningTransaction {
                 }
                 invoice_data_created_at: created_at
                 invoice_data_expires_at: expires_at
+                invoice_data_memo: memo
                 invoice_data_destination: destination {
                     __typename
                     ... on GraphNode {
@@ -323,7 +324,6 @@ fragment LightningTransactionFragment on LightningTransaction {
                         lightspark_node_status: status
                     }
                 }
-                invoice_data_memo: memo
             }
         }
         outgoing_payment_failure_reason: failure_reason

package/src/objects/LightsparkNodeStatus.ts

@@ -21,6 +21,8 @@ export enum LightsparkNodeStatus {
 
   TERMINATED = "TERMINATED",
 
+  TERMINATING = "TERMINATING",
+
   WALLET_LOCKED = "WALLET_LOCKED",
 
   FAILED_TO_DEPLOY = "FAILED_TO_DEPLOY",

package/src/objects/OutgoingPayment.ts

@@ -186,6 +186,7 @@ fragment OutgoingPaymentFragment on OutgoingPayment {
             }
             invoice_data_created_at: created_at
             invoice_data_expires_at: expires_at
+            invoice_data_memo: memo
             invoice_data_destination: destination {
                 __typename
                 ... on GraphNode {
@@ -306,7 +307,6 @@ fragment OutgoingPaymentFragment on OutgoingPayment {
                     lightspark_node_status: status
                 }
             }
-            invoice_data_memo: memo
         }
     }
     outgoing_payment_failure_reason: failure_reason

package/src/objects/PaymentRequest.ts

@@ -76,6 +76,7 @@ fragment PaymentRequestFragment on PaymentRequest {
             }
             invoice_data_created_at: created_at
             invoice_data_expires_at: expires_at
+            invoice_data_memo: memo
             invoice_data_destination: destination {
                 __typename
                 ... on GraphNode {
@@ -196,7 +197,6 @@ fragment PaymentRequestFragment on PaymentRequest {
                     lightspark_node_status: status
                 }
             }
-            invoice_data_memo: memo
         }
         invoice_status: status
         invoice_amount_paid: amount_paid {

package/src/objects/PaymentRequestData.ts

@@ -56,6 +56,7 @@ fragment PaymentRequestDataFragment on PaymentRequestData {
         }
         invoice_data_created_at: created_at
         invoice_data_expires_at: expires_at
+        invoice_data_memo: memo
         invoice_data_destination: destination {
             __typename
             ... on GraphNode {
@@ -176,7 +177,6 @@ fragment PaymentRequestDataFragment on PaymentRequestData {
                 lightspark_node_status: status
             }
         }
-        invoice_data_memo: memo
     }
 }`;
 

package/src/objects/Transaction.ts

@@ -389,6 +389,7 @@ fragment TransactionFragment on Transaction {
                 }
                 invoice_data_created_at: created_at
                 invoice_data_expires_at: expires_at
+                invoice_data_memo: memo
                 invoice_data_destination: destination {
                     __typename
                     ... on GraphNode {
@@ -509,7 +510,6 @@ fragment TransactionFragment on Transaction {
                         lightspark_node_status: status
                     }
                 }
-                invoice_data_memo: memo
             }
         }
         outgoing_payment_failure_reason: failure_reason

package/src/objects/WebhookEventType.ts

@@ -10,6 +10,16 @@ export enum WebhookEventType {
   PAYMENT_FINISHED = "PAYMENT_FINISHED",
 
   NODE_STATUS = "NODE_STATUS",
+
+  WALLET_STATUS = "WALLET_STATUS",
+
+  WALLET_OUTGOING_PAYMENT_FINISHED = "WALLET_OUTGOING_PAYMENT_FINISHED",
+
+  WALLET_INCOMING_PAYMENT_FINISHED = "WALLET_INCOMING_PAYMENT_FINISHED",
+
+  WALLET_WITHDRAWAL_FINISHED = "WALLET_WITHDRAWAL_FINISHED",
+
+  WALLET_FUNDS_RECEIVED = "WALLET_FUNDS_RECEIVED",
 }
 
 export default WebhookEventType;

package/src/objects/WithdrawalRequest.ts

@@ -24,6 +24,7 @@ class WithdrawalRequest implements Entity {
     public readonly withdrawalMode: WithdrawalMode,
     public readonly status: WithdrawalRequestStatus,
     public readonly typename: string,
+    public readonly estimatedAmount?: CurrencyAmount,
     public readonly completedAt?: string,
     public readonly withdrawalId?: string
   ) {
@@ -193,6 +194,9 @@ export const WithdrawalRequestFromJson = (obj: any): WithdrawalRequest => {
     WithdrawalRequestStatus[obj["withdrawal_request_status"]] ??
       WithdrawalRequestStatus.FUTURE_VALUE,
     "WithdrawalRequest",
+    !!obj["withdrawal_request_estimated_amount"]
+      ? CurrencyAmountFromJson(obj["withdrawal_request_estimated_amount"])
+      : undefined,
     obj["withdrawal_request_completed_at"],
     obj["withdrawal_request_withdrawal"]?.id ?? undefined
   );
@@ -212,6 +216,14 @@ fragment WithdrawalRequestFragment on WithdrawalRequest {
         currency_amount_preferred_currency_value_rounded: preferred_currency_value_rounded
         currency_amount_preferred_currency_value_approx: preferred_currency_value_approx
     }
+    withdrawal_request_estimated_amount: estimated_amount {
+        __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
+    }
     withdrawal_request_bitcoin_address: bitcoin_address
     withdrawal_request_withdrawal_mode: withdrawal_mode
     withdrawal_request_status: status