@lightsparkdev/lightspark-sdk 1.1.7 → 1.2.0

package/src/objects/UpdateNodeSharedSecretOutput.ts

@@ -1,8 +1,8 @@
 // Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
 
-type UpdateNodeSharedSecretOutput = {
+interface UpdateNodeSharedSecretOutput {
   nodeId: string;
-};
+}
 
 export const UpdateNodeSharedSecretOutputFromJson = (
   obj: any,
@@ -11,6 +11,13 @@ export const UpdateNodeSharedSecretOutputFromJson = (
     nodeId: obj["update_node_shared_secret_output_node"].id,
   } as UpdateNodeSharedSecretOutput;
 };
+export const UpdateNodeSharedSecretOutputToJson = (
+  obj: UpdateNodeSharedSecretOutput,
+): any => {
+  return {
+    update_node_shared_secret_output_node: { id: obj.nodeId },
+  };
+};
 
 export const FRAGMENT = `
 fragment UpdateNodeSharedSecretOutputFragment on UpdateNodeSharedSecretOutput {

package/src/objects/Wallet.ts

@@ -4,9 +4,10 @@ import { type Query } from "@lightsparkdev/core";
 import autoBind from "auto-bind";
 import type LightsparkClient from "../client.js";
 import type Balances from "./Balances.js";
-import { BalancesFromJson } from "./Balances.js";
+import { BalancesFromJson, BalancesToJson } from "./Balances.js";
 import type CurrencyAmount from "./CurrencyAmount.js";
 import { CurrencyAmountFromJson } from "./CurrencyAmount.js";
+import type Entity from "./Entity.js";
 import type LightsparkNodeOwner from "./LightsparkNodeOwner.js";
 import type TransactionStatus from "./TransactionStatus.js";
 import type TransactionType from "./TransactionType.js";
@@ -17,7 +18,7 @@ import type WalletToTransactionsConnection from "./WalletToTransactionsConnectio
 import { WalletToTransactionsConnectionFromJson } from "./WalletToTransactionsConnection.js";
 
 /** This object represents a Lightspark Wallet, tied to your Lightspark account. Wallets can be used to send or receive funds over the Lightning Network. You can retrieve this object to receive information about a specific wallet tied to your Lightspark account. **/
-class Wallet implements LightsparkNodeOwner {
+class Wallet implements LightsparkNodeOwner, Entity {
   constructor(
     public readonly id: string,
     public readonly createdAt: string,
@@ -25,9 +26,9 @@ class Wallet implements LightsparkNodeOwner {
     public readonly thirdPartyIdentifier: string,
     public readonly status: WalletStatus,
     public readonly typename: string,
-    public readonly lastLoginAt?: string,
-    public readonly balances?: Balances,
-    public readonly accountId?: string,
+    public readonly lastLoginAt?: string | undefined,
+    public readonly balances?: Balances | undefined,
+    public readonly accountId?: string | undefined,
   ) {
     autoBind(this);
   }
@@ -1057,6 +1058,22 @@ ${FRAGMENT}
       constructObject: (data: any) => WalletFromJson(data.entity),
     };
   }
+
+  public toJson() {
+    return {
+      __typename: "Wallet",
+      wallet_id: this.id,
+      wallet_created_at: this.createdAt,
+      wallet_updated_at: this.updatedAt,
+      wallet_last_login_at: this.lastLoginAt,
+      wallet_balances: this.balances
+        ? BalancesToJson(this.balances)
+        : undefined,
+      wallet_third_party_identifier: this.thirdPartyIdentifier,
+      wallet_account: { id: this.accountId } ?? undefined,
+      wallet_status: this.status,
+    };
+  }
 }
 
 export const WalletFromJson = (obj: any): Wallet => {

package/src/objects/WalletToPaymentRequestsConnection.ts

@@ -1,12 +1,14 @@
 // Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
 
-import type Connection from "./Connection.js";
 import type PageInfo from "./PageInfo.js";
-import { PageInfoFromJson } from "./PageInfo.js";
+import { PageInfoFromJson, PageInfoToJson } from "./PageInfo.js";
 import type PaymentRequest from "./PaymentRequest.js";
-import { PaymentRequestFromJson } from "./PaymentRequest.js";
+import {
+  PaymentRequestFromJson,
+  PaymentRequestToJson,
+} from "./PaymentRequest.js";
 
-type WalletToPaymentRequestsConnection = Connection & {
+interface WalletToPaymentRequestsConnection {
   /**
    * 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).
@@ -21,7 +23,7 @@ type WalletToPaymentRequestsConnection = Connection & {
 
   /** The typename of the object **/
   typename: string;
-};
+}
 
 export const WalletToPaymentRequestsConnectionFromJson = (
   obj: any,
@@ -37,6 +39,20 @@ export const WalletToPaymentRequestsConnectionFromJson = (
     typename: "WalletToPaymentRequestsConnection",
   } as WalletToPaymentRequestsConnection;
 };
+export const WalletToPaymentRequestsConnectionToJson = (
+  obj: WalletToPaymentRequestsConnection,
+): any => {
+  return {
+    __typename: "WalletToPaymentRequestsConnection",
+    wallet_to_payment_requests_connection_count: obj.count,
+    wallet_to_payment_requests_connection_page_info: PageInfoToJson(
+      obj.pageInfo,
+    ),
+    wallet_to_payment_requests_connection_entities: obj.entities.map((e) =>
+      PaymentRequestToJson(e),
+    ),
+  };
+};
 
 export const FRAGMENT = `
 fragment WalletToPaymentRequestsConnectionFragment on WalletToPaymentRequestsConnection {

package/src/objects/WalletToTransactionsConnection.ts

@@ -1,12 +1,11 @@
 // Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
 
-import type Connection from "./Connection.js";
 import type PageInfo from "./PageInfo.js";
-import { PageInfoFromJson } from "./PageInfo.js";
+import { PageInfoFromJson, PageInfoToJson } from "./PageInfo.js";
 import type Transaction from "./Transaction.js";
-import { TransactionFromJson } from "./Transaction.js";
+import { TransactionFromJson, TransactionToJson } from "./Transaction.js";
 
-type WalletToTransactionsConnection = Connection & {
+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).
@@ -21,7 +20,7 @@ type WalletToTransactionsConnection = Connection & {
 
   /** The typename of the object **/
   typename: string;
-};
+}
 
 export const WalletToTransactionsConnectionFromJson = (
   obj: any,
@@ -37,6 +36,18 @@ export const WalletToTransactionsConnectionFromJson = (
     typename: "WalletToTransactionsConnection",
   } as WalletToTransactionsConnection;
 };
+export const WalletToTransactionsConnectionToJson = (
+  obj: WalletToTransactionsConnection,
+): any => {
+  return {
+    __typename: "WalletToTransactionsConnection",
+    wallet_to_transactions_connection_count: obj.count,
+    wallet_to_transactions_connection_page_info: PageInfoToJson(obj.pageInfo),
+    wallet_to_transactions_connection_entities: obj.entities.map((e) =>
+      TransactionToJson(e),
+    ),
+  };
+};
 
 export const FRAGMENT = `
 fragment WalletToTransactionsConnectionFragment on WalletToTransactionsConnection {

package/src/objects/Withdrawal.ts

@@ -2,70 +2,68 @@
 
 import { type Query } from "@lightsparkdev/core";
 import type CurrencyAmount from "./CurrencyAmount.js";
-import { CurrencyAmountFromJson } from "./CurrencyAmount.js";
-import type Entity from "./Entity.js";
-import type OnChainTransaction from "./OnChainTransaction.js";
-import type Transaction from "./Transaction.js";
+import {
+  CurrencyAmountFromJson,
+  CurrencyAmountToJson,
+} 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. **/
-type Withdrawal = OnChainTransaction &
-  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 height of the block that included this transaction. This will be zero for unconfirmed
-     * transactions.
-     **/
-    blockHeight: number;
-
-    /** The Bitcoin blockchain addresses this transaction was sent to. **/
-    destinationAddresses: string[];
-
-    /** The Lightspark node this withdrawal originated from. **/
-    originId: string;
-
-    /** 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;
-
-    /**
-     * The fees that were paid by the wallet sending the transaction to commit it to the Bitcoin
-     * blockchain.
-     **/
-    fees?: CurrencyAmount;
-
-    /**
-     * The hash of the block that included this transaction. This will be null for unconfirmed
-     * transactions.
-     **/
-    blockHash?: string;
-
-    /** The number of blockchain confirmations for this transaction in real time. **/
-    numConfirmations?: number;
-  };
+interface Withdrawal {
+  /**
+   * 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 height of the block that included this transaction. This will be zero for unconfirmed
+   * transactions.
+   **/
+  blockHeight: number;
+
+  /** The Bitcoin blockchain addresses this transaction was sent to. **/
+  destinationAddresses: string[];
+
+  /** The Lightspark node this withdrawal originated from. **/
+  originId: string;
+
+  /** The typename of the object **/
+  typename: string;
+
+  /** 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. **/
+  transactionHash?: string | undefined;
+
+  /**
+   * 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.
+   **/
+  blockHash?: string | undefined;
+
+  /** The number of blockchain confirmations for this transaction in real time. **/
+  numConfirmations?: number | undefined;
+}
 
 export const WithdrawalFromJson = (obj: any): Withdrawal => {
   return {
@@ -89,6 +87,24 @@ export const WithdrawalFromJson = (obj: any): Withdrawal => {
     numConfirmations: obj["withdrawal_num_confirmations"],
   } as Withdrawal;
 };
+export const WithdrawalToJson = (obj: Withdrawal): any => {
+  return {
+    __typename: "Withdrawal",
+    withdrawal_id: obj.id,
+    withdrawal_created_at: obj.createdAt,
+    withdrawal_updated_at: obj.updatedAt,
+    withdrawal_status: obj.status,
+    withdrawal_resolved_at: obj.resolvedAt,
+    withdrawal_amount: CurrencyAmountToJson(obj.amount),
+    withdrawal_transaction_hash: obj.transactionHash,
+    withdrawal_fees: obj.fees ? CurrencyAmountToJson(obj.fees) : undefined,
+    withdrawal_block_hash: obj.blockHash,
+    withdrawal_block_height: obj.blockHeight,
+    withdrawal_destination_addresses: obj.destinationAddresses,
+    withdrawal_num_confirmations: obj.numConfirmations,
+    withdrawal_origin: { id: obj.originId },
+  };
+};
 
 export const FRAGMENT = `
 fragment WithdrawalFragment on Withdrawal {

package/src/objects/WithdrawalRequest.ts

@@ -4,7 +4,10 @@ import { type Query } from "@lightsparkdev/core";
 import autoBind from "auto-bind";
 import type LightsparkClient from "../client.js";
 import type CurrencyAmount from "./CurrencyAmount.js";
-import { CurrencyAmountFromJson } from "./CurrencyAmount.js";
+import {
+  CurrencyAmountFromJson,
+  CurrencyAmountToJson,
+} from "./CurrencyAmount.js";
 import type Entity from "./Entity.js";
 import WithdrawalMode from "./WithdrawalMode.js";
 import WithdrawalRequestStatus from "./WithdrawalRequestStatus.js";
@@ -24,9 +27,9 @@ 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,
+    public readonly estimatedAmount?: CurrencyAmount | undefined,
+    public readonly completedAt?: string | undefined,
+    public readonly withdrawalId?: string | undefined,
   ) {
     autoBind(this);
   }
@@ -180,6 +183,24 @@ ${FRAGMENT}
       constructObject: (data: any) => WithdrawalRequestFromJson(data.entity),
     };
   }
+
+  public toJson() {
+    return {
+      __typename: "WithdrawalRequest",
+      withdrawal_request_id: this.id,
+      withdrawal_request_created_at: this.createdAt,
+      withdrawal_request_updated_at: this.updatedAt,
+      withdrawal_request_amount: CurrencyAmountToJson(this.amount),
+      withdrawal_request_estimated_amount: this.estimatedAmount
+        ? CurrencyAmountToJson(this.estimatedAmount)
+        : undefined,
+      withdrawal_request_bitcoin_address: this.bitcoinAddress,
+      withdrawal_request_withdrawal_mode: this.withdrawalMode,
+      withdrawal_request_status: this.status,
+      withdrawal_request_completed_at: this.completedAt,
+      withdrawal_request_withdrawal: { id: this.withdrawalId } ?? undefined,
+    };
+  }
 }
 
 export const WithdrawalRequestFromJson = (obj: any): WithdrawalRequest => {

package/src/objects/WithdrawalRequestToChannelClosingTransactionsConnection.ts

@@ -1,11 +1,14 @@
 // Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
 
 import type ChannelClosingTransaction from "./ChannelClosingTransaction.js";
-import { ChannelClosingTransactionFromJson } from "./ChannelClosingTransaction.js";
+import {
+  ChannelClosingTransactionFromJson,
+  ChannelClosingTransactionToJson,
+} from "./ChannelClosingTransaction.js";
 import type PageInfo from "./PageInfo.js";
-import { PageInfoFromJson } from "./PageInfo.js";
+import { PageInfoFromJson, PageInfoToJson } from "./PageInfo.js";
 
-type WithdrawalRequestToChannelClosingTransactionsConnection = {
+interface WithdrawalRequestToChannelClosingTransactionsConnection {
   /** An object that holds pagination information about the objects in this connection. **/
   pageInfo: PageInfo;
 
@@ -17,7 +20,7 @@ type WithdrawalRequestToChannelClosingTransactionsConnection = {
 
   /** The channel closing transactions for the current page of this connection. **/
   entities: ChannelClosingTransaction[];
-};
+}
 
 export const WithdrawalRequestToChannelClosingTransactionsConnectionFromJson = (
   obj: any,
@@ -37,6 +40,18 @@ export const WithdrawalRequestToChannelClosingTransactionsConnectionFromJson = (
     ].map((e) => ChannelClosingTransactionFromJson(e)),
   } as WithdrawalRequestToChannelClosingTransactionsConnection;
 };
+export const WithdrawalRequestToChannelClosingTransactionsConnectionToJson = (
+  obj: WithdrawalRequestToChannelClosingTransactionsConnection,
+): any => {
+  return {
+    withdrawal_request_to_channel_closing_transactions_connection_page_info:
+      PageInfoToJson(obj.pageInfo),
+    withdrawal_request_to_channel_closing_transactions_connection_count:
+      obj.count,
+    withdrawal_request_to_channel_closing_transactions_connection_entities:
+      obj.entities.map((e) => ChannelClosingTransactionToJson(e)),
+  };
+};
 
 export const FRAGMENT = `
 fragment WithdrawalRequestToChannelClosingTransactionsConnectionFragment on WithdrawalRequestToChannelClosingTransactionsConnection {

package/src/objects/WithdrawalRequestToChannelOpeningTransactionsConnection.ts

@@ -1,11 +1,14 @@
 // Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
 
 import type ChannelOpeningTransaction from "./ChannelOpeningTransaction.js";
-import { ChannelOpeningTransactionFromJson } from "./ChannelOpeningTransaction.js";
+import {
+  ChannelOpeningTransactionFromJson,
+  ChannelOpeningTransactionToJson,
+} from "./ChannelOpeningTransaction.js";
 import type PageInfo from "./PageInfo.js";
-import { PageInfoFromJson } from "./PageInfo.js";
+import { PageInfoFromJson, PageInfoToJson } from "./PageInfo.js";
 
-type WithdrawalRequestToChannelOpeningTransactionsConnection = {
+interface WithdrawalRequestToChannelOpeningTransactionsConnection {
   /** An object that holds pagination information about the objects in this connection. **/
   pageInfo: PageInfo;
 
@@ -17,7 +20,7 @@ type WithdrawalRequestToChannelOpeningTransactionsConnection = {
 
   /** The channel opening transactions for the current page of this connection. **/
   entities: ChannelOpeningTransaction[];
-};
+}
 
 export const WithdrawalRequestToChannelOpeningTransactionsConnectionFromJson = (
   obj: any,
@@ -37,6 +40,18 @@ export const WithdrawalRequestToChannelOpeningTransactionsConnectionFromJson = (
     ].map((e) => ChannelOpeningTransactionFromJson(e)),
   } as WithdrawalRequestToChannelOpeningTransactionsConnection;
 };
+export const WithdrawalRequestToChannelOpeningTransactionsConnectionToJson = (
+  obj: WithdrawalRequestToChannelOpeningTransactionsConnection,
+): any => {
+  return {
+    withdrawal_request_to_channel_opening_transactions_connection_page_info:
+      PageInfoToJson(obj.pageInfo),
+    withdrawal_request_to_channel_opening_transactions_connection_count:
+      obj.count,
+    withdrawal_request_to_channel_opening_transactions_connection_entities:
+      obj.entities.map((e) => ChannelOpeningTransactionToJson(e)),
+  };
+};
 
 export const FRAGMENT = `
 fragment WithdrawalRequestToChannelOpeningTransactionsConnectionFragment on WithdrawalRequestToChannelOpeningTransactionsConnection {

package/src/objects/index.ts

@@ -68,7 +68,10 @@ export {
   default as LightningTransaction,
   getLightningTransactionQuery,
 } from "./LightningTransaction.js";
-export { default as LightsparkNode } from "./LightsparkNode.js";
+export {
+  default as LightsparkNode,
+  getLightsparkNodeQuery,
+} from "./LightsparkNode.js";
 export {
   default as LightsparkNodeOwner,
   getLightsparkNodeOwnerQuery,
@@ -77,7 +80,7 @@ export { default as LightsparkNodeStatus } from "./LightsparkNodeStatus.js";
 export { default as LightsparkNodeToChannelsConnection } from "./LightsparkNodeToChannelsConnection.js";
 export { default as LightsparkNodeWithOSK } from "./LightsparkNodeWithOSK.js";
 export { default as LightsparkNodeWithRemoteSigning } from "./LightsparkNodeWithRemoteSigning.js";
-export { default as Node } from "./Node.js";
+export { default as Node, getNodeQuery } from "./Node.js";
 export { default as NodeAddress } from "./NodeAddress.js";
 export { default as NodeAddressType } from "./NodeAddressType.js";
 export { default as NodeToAddressesConnection } from "./NodeToAddressesConnection.js";

package/src/tests/serialization.test.ts

@@ -0,0 +1,18 @@
+import {
+  InvoiceDataFromJson,
+  InvoiceDataToJson,
+} from "../objects/InvoiceData.js";
+
+describe("Serialization", () => {
+  test("should serialize and deserialize InvoiceData to the same object", async () => {
+    const serialized = `{"__typename": "InvoiceData", "invoice_data_encoded_payment_request":"lnbcrt34170n1pj5vdn4pp56jhw0672v566u4rvl333v8hwwuvavvu9gx4a2mqag4pkrvm0hwkqhp5xaz278y6cejcvpqnndl4wfq3slgthjduwlfksg778aevn23v2pdscqzpgxqyz5vqsp5ee5jezfvjqvvz7hfwta3ekk8hs6dq36szkgp40qh7twa8upquxlq9qyyssqjg2slc95falxf2t67y0wu2w43qwfcvfflwl8tn4ppqw9tumwqxk36qkfct9p2w8c3yy2ld7c6nacy4ssv2gl6qyqfpmhl4jmarnjf8cpvjlxek","invoice_data_bitcoin_network":"REGTEST","invoice_data_payment_hash":"d4aee7ebca6535ae546cfc63161eee7719d6338541abd56c1d454361b36fbbac","invoice_data_amount":{"currency_amount_original_value":3417,"currency_amount_original_unit":"SATOSHI","currency_amount_preferred_currency_unit":"USD","currency_amount_preferred_currency_value_rounded":118,"currency_amount_preferred_currency_value_approx":118.89352818371607},"invoice_data_created_at":"2023-11-04T12:17:57Z","invoice_data_expires_at":"2023-11-05T12:17:57Z","invoice_data_memo":null,"invoice_data_destination":{"graph_node_id":"GraphNode:0189a572-6dba-cf00-0000-ac0908d34ea6","graph_node_created_at":"2023-07-30T06:18:07.162759Z","graph_node_updated_at":"2023-11-04T12:01:04.015414Z","graph_node_alias":"ls_test_vSViIQitob_SE","graph_node_bitcoin_network":"REGTEST","graph_node_color":"#3399ff","graph_node_conductivity":null,"graph_node_display_name":"ls_test_vSViIQitob_SE","graph_node_public_key":"02253935a5703a6f0429081e08d2defce0faa15f4d75305302284751d53a4e0608", "__typename":"GraphNode"}}`;
+    const deserialized = InvoiceDataFromJson(JSON.parse(serialized));
+    const reserialized = InvoiceDataToJson(deserialized);
+    expect(reserialized).toEqual(JSON.parse(serialized));
+
+    const deserializedAgain = InvoiceDataFromJson(reserialized);
+    expect(JSON.stringify(deserializedAgain)).toEqual(
+      JSON.stringify(deserialized),
+    );
+  });
+});