@lightsparkdev/lightspark-sdk 1.1.6 → 1.2.0

package/src/objects/Node.ts

@@ -1,86 +1,80 @@
 // Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
 
 import { LightsparkException, type Query } from "@lightsparkdev/core";
-import autoBind from "auto-bind";
 import type LightsparkClient from "../client.js";
+import { BalancesFromJson, BalancesToJson } from "./Balances.js";
 import BitcoinNetwork from "./BitcoinNetwork.js";
-import { BlockchainBalanceFromJson } from "./BlockchainBalance.js";
-import { CurrencyAmountFromJson } from "./CurrencyAmount.js";
-import type Entity from "./Entity.js";
+import {
+  BlockchainBalanceFromJson,
+  BlockchainBalanceToJson,
+} from "./BlockchainBalance.js";
+import {
+  CurrencyAmountFromJson,
+  CurrencyAmountToJson,
+} from "./CurrencyAmount.js";
 import GraphNode from "./GraphNode.js";
 import LightsparkNodeStatus from "./LightsparkNodeStatus.js";
 import LightsparkNodeWithOSK from "./LightsparkNodeWithOSK.js";
 import LightsparkNodeWithRemoteSigning from "./LightsparkNodeWithRemoteSigning.js";
 import type NodeAddressType from "./NodeAddressType.js";
 import type NodeToAddressesConnection from "./NodeToAddressesConnection.js";
-import { NodeToAddressesConnectionFromJson } from "./NodeToAddressesConnection.js";
-import { SecretFromJson } from "./Secret.js";
+import { SecretFromJson, SecretToJson } from "./Secret.js";
 
 /** This object is an interface representing a Lightning Node on the Lightning Network, and could either be a Lightspark node or a node managed by a third party. **/
-class Node implements Entity {
-  constructor(
-    public readonly id: string,
-    public readonly createdAt: string,
-    public readonly updatedAt: string,
-    public readonly bitcoinNetwork: BitcoinNetwork,
-    public readonly displayName: string,
-    public readonly typename: string,
-    public readonly alias?: string,
-    public readonly color?: string,
-    public readonly conductivity?: number,
-    public readonly publicKey?: string,
-  ) {
-    autoBind(this);
-  }
+interface Node {
+  /**
+   * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
+   * string.
+   **/
+  id: string;
 
-  public async getAddresses(
-    client: LightsparkClient,
-    first: number | undefined = undefined,
-    types: NodeAddressType[] | undefined = undefined,
-  ): Promise<NodeToAddressesConnection> {
-    return (await client.executeRawQuery({
-      queryPayload: ` 
-query FetchNodeToAddressesConnection($entity_id: ID!, $first: Int, $types: [NodeAddressType!]) {
-    entity(id: $entity_id) {
-        ... on Node {
-            addresses(, first: $first, types: $types) {
-                __typename
-                node_to_addresses_connection_count: count
-                node_to_addresses_connection_entities: entities {
-                    __typename
-                    node_address_address: address
-                    node_address_type: type
-                }
-            }
-        }
-    }
-}
-`,
-      variables: { entity_id: this.id, first: first, types: types },
-      constructObject: (json) => {
-        const connection = json["entity"]["addresses"];
-        return NodeToAddressesConnectionFromJson(connection);
-      },
-    }))!;
-  }
+  /** The date and time when the entity was first created. **/
+  createdAt: string;
 
-  static getNodeQuery(id: string): Query<Node> {
-    return {
-      queryPayload: `
-query GetNode($id: ID!) {
-    entity(id: $id) {
-        ... on Node {
-            ...NodeFragment
-        }
-    }
-}
+  /** The date and time when the entity was last updated. **/
+  updatedAt: string;
 
-${FRAGMENT}    
-`,
-      variables: { id },
-      constructObject: (data: any) => NodeFromJson(data.entity),
-    };
-  }
+  /** The Bitcoin Network this node is deployed in. **/
+  bitcoinNetwork: BitcoinNetwork;
+
+  /**
+   * The name of this node in the network. It will be the most human-readable option possible, depending
+   * on the data available for this node.
+   **/
+  displayName: string;
+
+  /** The typename of the object **/
+  typename: string;
+
+  /**
+   * A name that identifies the node. It has no importance in terms of operating the node, it is just a
+   * way to identify and search for commercial services or popular nodes. This alias can be changed at
+   * any time by the node operator.
+   **/
+  alias?: string | undefined;
+
+  /**
+   * A hexadecimal string that describes a color. For example "#000000" is black, "#FFFFFF" is white. It
+   * has no importance in terms of operating the node, it is just a way to visually differentiate nodes.
+   * That color can be changed at any time by the node operator.
+   **/
+  color?: string | undefined;
+
+  /**
+   * A summary metric used to capture how well positioned a node is to send, receive, or route
+   * transactions efficiently. Maximizing a node's conductivity helps a node’s transactions to be
+   * capital efficient. The value is an integer ranging between 0 and 10 (bounds included).
+   **/
+  conductivity?: number | undefined;
+
+  /** The public key of this node. It acts as a unique identifier of this node in the Lightning Network. **/
+  publicKey?: string | undefined;
+
+  getAddresses(
+    client: LightsparkClient,
+    first?: number | undefined,
+    types?: NodeAddressType[] | undefined,
+  ): Promise<NodeToAddressesConnection>;
 }
 
 export const NodeFromJson = (obj: any): Node => {
@@ -143,6 +137,9 @@ export const NodeFromJson = (obj: any): Node => {
             obj["lightspark_node_with_o_s_k_blockchain_balance"],
           )
         : undefined,
+      !!obj["lightspark_node_with_o_s_k_balances"]
+        ? BalancesFromJson(obj["lightspark_node_with_o_s_k_balances"])
+        : undefined,
       !!obj["lightspark_node_with_o_s_k_encrypted_signing_private_key"]
         ? SecretFromJson(
             obj["lightspark_node_with_o_s_k_encrypted_signing_private_key"],
@@ -196,6 +193,9 @@ export const NodeFromJson = (obj: any): Node => {
             obj["lightspark_node_with_remote_signing_blockchain_balance"],
           )
         : undefined,
+      !!obj["lightspark_node_with_remote_signing_balances"]
+        ? BalancesFromJson(obj["lightspark_node_with_remote_signing_balances"])
+        : undefined,
     );
   }
   throw new LightsparkException(
@@ -203,6 +203,136 @@ export const NodeFromJson = (obj: any): Node => {
     `Couldn't find a concrete type for interface Node corresponding to the typename=${obj["__typename"]}`,
   );
 };
+export const NodeToJson = (obj: Node): any => {
+  if (obj.typename == "GraphNode") {
+    const graphNode = obj as GraphNode;
+    return {
+      __typename: "GraphNode",
+      graph_node_id: graphNode.id,
+      graph_node_created_at: graphNode.createdAt,
+      graph_node_updated_at: graphNode.updatedAt,
+      graph_node_alias: graphNode.alias,
+      graph_node_bitcoin_network: graphNode.bitcoinNetwork,
+      graph_node_color: graphNode.color,
+      graph_node_conductivity: graphNode.conductivity,
+      graph_node_display_name: graphNode.displayName,
+      graph_node_public_key: graphNode.publicKey,
+    };
+  }
+  if (obj.typename == "LightsparkNodeWithOSK") {
+    const lightsparkNodeWithOSK = obj as LightsparkNodeWithOSK;
+    return {
+      __typename: "LightsparkNodeWithOSK",
+      lightspark_node_with_o_s_k_id: lightsparkNodeWithOSK.id,
+      lightspark_node_with_o_s_k_created_at: lightsparkNodeWithOSK.createdAt,
+      lightspark_node_with_o_s_k_updated_at: lightsparkNodeWithOSK.updatedAt,
+      lightspark_node_with_o_s_k_alias: lightsparkNodeWithOSK.alias,
+      lightspark_node_with_o_s_k_bitcoin_network:
+        lightsparkNodeWithOSK.bitcoinNetwork,
+      lightspark_node_with_o_s_k_color: lightsparkNodeWithOSK.color,
+      lightspark_node_with_o_s_k_conductivity:
+        lightsparkNodeWithOSK.conductivity,
+      lightspark_node_with_o_s_k_display_name:
+        lightsparkNodeWithOSK.displayName,
+      lightspark_node_with_o_s_k_public_key: lightsparkNodeWithOSK.publicKey,
+      lightspark_node_with_o_s_k_owner: { id: lightsparkNodeWithOSK.ownerId },
+      lightspark_node_with_o_s_k_status: lightsparkNodeWithOSK.status,
+      lightspark_node_with_o_s_k_total_balance:
+        lightsparkNodeWithOSK.totalBalance
+          ? CurrencyAmountToJson(lightsparkNodeWithOSK.totalBalance)
+          : undefined,
+      lightspark_node_with_o_s_k_total_local_balance:
+        lightsparkNodeWithOSK.totalLocalBalance
+          ? CurrencyAmountToJson(lightsparkNodeWithOSK.totalLocalBalance)
+          : undefined,
+      lightspark_node_with_o_s_k_local_balance:
+        lightsparkNodeWithOSK.localBalance
+          ? CurrencyAmountToJson(lightsparkNodeWithOSK.localBalance)
+          : undefined,
+      lightspark_node_with_o_s_k_remote_balance:
+        lightsparkNodeWithOSK.remoteBalance
+          ? CurrencyAmountToJson(lightsparkNodeWithOSK.remoteBalance)
+          : undefined,
+      lightspark_node_with_o_s_k_blockchain_balance:
+        lightsparkNodeWithOSK.blockchainBalance
+          ? BlockchainBalanceToJson(lightsparkNodeWithOSK.blockchainBalance)
+          : undefined,
+      lightspark_node_with_o_s_k_uma_prescreening_utxos:
+        lightsparkNodeWithOSK.umaPrescreeningUtxos,
+      lightspark_node_with_o_s_k_balances: lightsparkNodeWithOSK.balances
+        ? BalancesToJson(lightsparkNodeWithOSK.balances)
+        : undefined,
+      lightspark_node_with_o_s_k_encrypted_signing_private_key:
+        lightsparkNodeWithOSK.encryptedSigningPrivateKey
+          ? SecretToJson(lightsparkNodeWithOSK.encryptedSigningPrivateKey)
+          : undefined,
+    };
+  }
+  if (obj.typename == "LightsparkNodeWithRemoteSigning") {
+    const lightsparkNodeWithRemoteSigning =
+      obj as LightsparkNodeWithRemoteSigning;
+    return {
+      __typename: "LightsparkNodeWithRemoteSigning",
+      lightspark_node_with_remote_signing_id:
+        lightsparkNodeWithRemoteSigning.id,
+      lightspark_node_with_remote_signing_created_at:
+        lightsparkNodeWithRemoteSigning.createdAt,
+      lightspark_node_with_remote_signing_updated_at:
+        lightsparkNodeWithRemoteSigning.updatedAt,
+      lightspark_node_with_remote_signing_alias:
+        lightsparkNodeWithRemoteSigning.alias,
+      lightspark_node_with_remote_signing_bitcoin_network:
+        lightsparkNodeWithRemoteSigning.bitcoinNetwork,
+      lightspark_node_with_remote_signing_color:
+        lightsparkNodeWithRemoteSigning.color,
+      lightspark_node_with_remote_signing_conductivity:
+        lightsparkNodeWithRemoteSigning.conductivity,
+      lightspark_node_with_remote_signing_display_name:
+        lightsparkNodeWithRemoteSigning.displayName,
+      lightspark_node_with_remote_signing_public_key:
+        lightsparkNodeWithRemoteSigning.publicKey,
+      lightspark_node_with_remote_signing_owner: {
+        id: lightsparkNodeWithRemoteSigning.ownerId,
+      },
+      lightspark_node_with_remote_signing_status:
+        lightsparkNodeWithRemoteSigning.status,
+      lightspark_node_with_remote_signing_total_balance:
+        lightsparkNodeWithRemoteSigning.totalBalance
+          ? CurrencyAmountToJson(lightsparkNodeWithRemoteSigning.totalBalance)
+          : undefined,
+      lightspark_node_with_remote_signing_total_local_balance:
+        lightsparkNodeWithRemoteSigning.totalLocalBalance
+          ? CurrencyAmountToJson(
+              lightsparkNodeWithRemoteSigning.totalLocalBalance,
+            )
+          : undefined,
+      lightspark_node_with_remote_signing_local_balance:
+        lightsparkNodeWithRemoteSigning.localBalance
+          ? CurrencyAmountToJson(lightsparkNodeWithRemoteSigning.localBalance)
+          : undefined,
+      lightspark_node_with_remote_signing_remote_balance:
+        lightsparkNodeWithRemoteSigning.remoteBalance
+          ? CurrencyAmountToJson(lightsparkNodeWithRemoteSigning.remoteBalance)
+          : undefined,
+      lightspark_node_with_remote_signing_blockchain_balance:
+        lightsparkNodeWithRemoteSigning.blockchainBalance
+          ? BlockchainBalanceToJson(
+              lightsparkNodeWithRemoteSigning.blockchainBalance,
+            )
+          : undefined,
+      lightspark_node_with_remote_signing_uma_prescreening_utxos:
+        lightsparkNodeWithRemoteSigning.umaPrescreeningUtxos,
+      lightspark_node_with_remote_signing_balances:
+        lightsparkNodeWithRemoteSigning.balances
+          ? BalancesToJson(lightsparkNodeWithRemoteSigning.balances)
+          : undefined,
+    };
+  }
+  throw new LightsparkException(
+    "DeserializationError",
+    `Couldn't find a concrete type for interface Node corresponding to the typename=${obj.typename}`,
+  );
+};
 
 export const FRAGMENT = `
 fragment NodeFragment on Node {
@@ -318,6 +448,33 @@ fragment NodeFragment on Node {
             }
         }
         lightspark_node_with_o_s_k_uma_prescreening_utxos: uma_prescreening_utxos
+        lightspark_node_with_o_s_k_balances: balances {
+            __typename
+            balances_owned_balance: owned_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
+            }
+            balances_available_to_send_balance: available_to_send_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
+            }
+            balances_available_to_withdraw_balance: available_to_withdraw_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
+            }
+        }
         lightspark_node_with_o_s_k_encrypted_signing_private_key: encrypted_signing_private_key {
             __typename
             secret_encrypted_value: encrypted_value
@@ -423,7 +580,52 @@ fragment NodeFragment on Node {
             }
         }
         lightspark_node_with_remote_signing_uma_prescreening_utxos: uma_prescreening_utxos
+        lightspark_node_with_remote_signing_balances: balances {
+            __typename
+            balances_owned_balance: owned_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
+            }
+            balances_available_to_send_balance: available_to_send_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
+            }
+            balances_available_to_withdraw_balance: available_to_withdraw_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
+            }
+        }
     }
 }`;
 
+export const getNodeQuery = (id: string): Query<Node> => {
+  return {
+    queryPayload: `
+query GetNode($id: ID!) {
+    entity(id: $id) {
+        ... on Node {
+            ...NodeFragment
+        }
+    }
+}
+
+${FRAGMENT}    
+`,
+    variables: { id },
+    constructObject: (data: any) => NodeFromJson(data.entity),
+  };
+};
+
 export default Node;

package/src/objects/NodeAddress.ts

@@ -3,13 +3,13 @@
 import NodeAddressType from "./NodeAddressType.js";
 
 /** This object represents the address of a node on the Lightning Network. **/
-type NodeAddress = {
+interface NodeAddress {
   /** The string representation of the address. **/
   address: string;
 
   /** The type, or protocol, of this address. **/
   type: NodeAddressType;
-};
+}
 
 export const NodeAddressFromJson = (obj: any): NodeAddress => {
   return {
@@ -18,6 +18,12 @@ export const NodeAddressFromJson = (obj: any): NodeAddress => {
       NodeAddressType[obj["node_address_type"]] ?? NodeAddressType.FUTURE_VALUE,
   } as NodeAddress;
 };
+export const NodeAddressToJson = (obj: NodeAddress): any => {
+  return {
+    node_address_address: obj.address,
+    node_address_type: obj.type,
+  };
+};
 
 export const FRAGMENT = `
 fragment NodeAddressFragment on NodeAddress {

package/src/objects/NodeToAddressesConnection.ts

@@ -1,10 +1,10 @@
 // Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
 
 import type NodeAddress from "./NodeAddress.js";
-import { NodeAddressFromJson } from "./NodeAddress.js";
+import { NodeAddressFromJson, NodeAddressToJson } from "./NodeAddress.js";
 
 /** A connection between a node and the addresses it has announced for itself on Lightning Network. **/
-type NodeToAddressesConnection = {
+interface NodeToAddressesConnection {
   /**
    * 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).
@@ -13,7 +13,7 @@ type NodeToAddressesConnection = {
 
   /** The addresses for the current page of this connection. **/
   entities: NodeAddress[];
-};
+}
 
 export const NodeToAddressesConnectionFromJson = (
   obj: any,
@@ -25,6 +25,16 @@ export const NodeToAddressesConnectionFromJson = (
     ),
   } as NodeToAddressesConnection;
 };
+export const NodeToAddressesConnectionToJson = (
+  obj: NodeToAddressesConnection,
+): any => {
+  return {
+    node_to_addresses_connection_count: obj.count,
+    node_to_addresses_connection_entities: obj.entities.map((e) =>
+      NodeAddressToJson(e),
+    ),
+  };
+};
 
 export const FRAGMENT = `
 fragment NodeToAddressesConnectionFragment on NodeToAddressesConnection {