@lightsparkdev/lightspark-sdk 0.1.6

package/src/objects/LightsparkNode.ts

@@ -0,0 +1,377 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+import { Query } from "@lightsparkdev/core";
+import autoBind from "auto-bind";
+import LightsparkClient from "../client.js";
+import BitcoinNetwork from "./BitcoinNetwork.js";
+import BlockchainBalance, {
+  BlockchainBalanceFromJson,
+} from "./BlockchainBalance.js";
+import ChannelStatus from "./ChannelStatus.js";
+import CurrencyAmount, { CurrencyAmountFromJson } from "./CurrencyAmount.js";
+import LightsparkNodePurpose from "./LightsparkNodePurpose.js";
+import LightsparkNodeStatus from "./LightsparkNodeStatus.js";
+import LightsparkNodeToChannelsConnection, {
+  LightsparkNodeToChannelsConnectionFromJson,
+} from "./LightsparkNodeToChannelsConnection.js";
+import Node from "./Node.js";
+import NodeAddressType from "./NodeAddressType.js";
+import NodeToAddressesConnection, {
+  NodeToAddressesConnectionFromJson,
+} from "./NodeToAddressesConnection.js";
+import Secret, { SecretFromJson } from "./Secret.js";
+
+/** This is a node that is managed by Lightspark and is managed within the current connected account. It contains many details about the node configuration, state, and metadata. **/
+class LightsparkNode implements Node {
+  constructor(
+    public readonly id: string,
+    public readonly createdAt: string,
+    public readonly updatedAt: string,
+    public readonly bitcoinNetwork: BitcoinNetwork,
+    public readonly displayName: string,
+    public readonly accountId: string,
+    public readonly typename: string,
+    public readonly alias?: string,
+    public readonly color?: string,
+    public readonly conductivity?: number,
+    public readonly publicKey?: string,
+    public readonly blockchainBalance?: BlockchainBalance,
+    public readonly encryptedSigningPrivateKey?: Secret,
+    public readonly totalBalance?: CurrencyAmount,
+    public readonly totalLocalBalance?: CurrencyAmount,
+    public readonly localBalance?: CurrencyAmount,
+    public readonly purpose?: LightsparkNodePurpose,
+    public readonly remoteBalance?: CurrencyAmount,
+    public readonly status?: LightsparkNodeStatus
+  ) {
+    autoBind(this);
+  }
+
+  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 LightsparkNode {
+            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);
+      },
+    }))!;
+  }
+
+  public async getChannels(
+    client: LightsparkClient,
+    first: number | undefined = undefined,
+    statuses: ChannelStatus[] | undefined = undefined
+  ): Promise<LightsparkNodeToChannelsConnection> {
+    return (await client.executeRawQuery({
+      queryPayload: ` 
+query FetchLightsparkNodeToChannelsConnection($entity_id: ID!, $first: Int, $statuses: [ChannelStatus!]) {
+    entity(id: $entity_id) {
+        ... on LightsparkNode {
+            channels(, first: $first, statuses: $statuses) {
+                __typename
+                lightspark_node_to_channels_connection_page_info: page_info {
+                    __typename
+                    page_info_has_next_page: has_next_page
+                    page_info_has_previous_page: has_previous_page
+                    page_info_start_cursor: start_cursor
+                    page_info_end_cursor: end_cursor
+                }
+                lightspark_node_to_channels_connection_count: count
+                lightspark_node_to_channels_connection_entities: entities {
+                    __typename
+                    channel_id: id
+                    channel_created_at: created_at
+                    channel_updated_at: updated_at
+                    channel_funding_transaction: funding_transaction {
+                        id
+                    }
+                    channel_capacity: capacity {
+                        __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_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_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_remote_balance: remote_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_remote_unsettled_balance: remote_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_unsettled_balance: 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_total_balance: total_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_status: status
+                    channel_estimated_force_closure_wait_minutes: estimated_force_closure_wait_minutes
+                    channel_commit_fee: commit_fee {
+                        __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_fees: fees {
+                        __typename
+                        channel_fees_base_fee: base_fee {
+                            __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_fees_fee_rate_per_mil: fee_rate_per_mil
+                    }
+                    channel_remote_node: remote_node {
+                        id
+                    }
+                    channel_local_node: local_node {
+                        id
+                    }
+                    channel_short_channel_id: short_channel_id
+                }
+            }
+        }
+    }
+}
+`,
+      variables: { entity_id: this.id, first: first, statuses: statuses },
+      constructObject: (json) => {
+        const connection = json["entity"]["channels"];
+        return LightsparkNodeToChannelsConnectionFromJson(connection);
+      },
+    }))!;
+  }
+
+  static getLightsparkNodeQuery(id: string): Query<LightsparkNode> {
+    return {
+      queryPayload: `
+query GetLightsparkNode($id: ID!) {
+    entity(id: $id) {
+        ... on LightsparkNode {
+            ...LightsparkNodeFragment
+        }
+    }
+}
+
+${FRAGMENT}    
+`,
+      variables: { id },
+      constructObject: (data: any) => LightsparkNodeFromJson(data.entity),
+    };
+  }
+}
+
+export const LightsparkNodeFromJson = (obj: any): LightsparkNode => {
+  return new LightsparkNode(
+    obj["lightspark_node_id"],
+    obj["lightspark_node_created_at"],
+    obj["lightspark_node_updated_at"],
+    BitcoinNetwork[obj["lightspark_node_bitcoin_network"]] ??
+      BitcoinNetwork.FUTURE_VALUE,
+    obj["lightspark_node_display_name"],
+    obj["lightspark_node_account"].id,
+    "LightsparkNode",
+    obj["lightspark_node_alias"],
+    obj["lightspark_node_color"],
+    obj["lightspark_node_conductivity"],
+    obj["lightspark_node_public_key"],
+    !!obj["lightspark_node_blockchain_balance"]
+      ? BlockchainBalanceFromJson(obj["lightspark_node_blockchain_balance"])
+      : undefined,
+    !!obj["lightspark_node_encrypted_signing_private_key"]
+      ? SecretFromJson(obj["lightspark_node_encrypted_signing_private_key"])
+      : undefined,
+    !!obj["lightspark_node_total_balance"]
+      ? CurrencyAmountFromJson(obj["lightspark_node_total_balance"])
+      : undefined,
+    !!obj["lightspark_node_total_local_balance"]
+      ? CurrencyAmountFromJson(obj["lightspark_node_total_local_balance"])
+      : undefined,
+    !!obj["lightspark_node_local_balance"]
+      ? CurrencyAmountFromJson(obj["lightspark_node_local_balance"])
+      : undefined,
+    !!obj["lightspark_node_purpose"]
+      ? LightsparkNodePurpose[obj["lightspark_node_purpose"]] ??
+        LightsparkNodePurpose.FUTURE_VALUE
+      : null,
+    !!obj["lightspark_node_remote_balance"]
+      ? CurrencyAmountFromJson(obj["lightspark_node_remote_balance"])
+      : undefined,
+    !!obj["lightspark_node_status"]
+      ? LightsparkNodeStatus[obj["lightspark_node_status"]] ??
+        LightsparkNodeStatus.FUTURE_VALUE
+      : null
+  );
+};
+
+export const FRAGMENT = `
+fragment LightsparkNodeFragment on LightsparkNode {
+    __typename
+    lightspark_node_id: id
+    lightspark_node_created_at: created_at
+    lightspark_node_updated_at: updated_at
+    lightspark_node_alias: alias
+    lightspark_node_bitcoin_network: bitcoin_network
+    lightspark_node_color: color
+    lightspark_node_conductivity: conductivity
+    lightspark_node_display_name: display_name
+    lightspark_node_public_key: public_key
+    lightspark_node_account: account {
+        id
+    }
+    lightspark_node_blockchain_balance: blockchain_balance {
+        __typename
+        blockchain_balance_total_balance: total_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
+        }
+        blockchain_balance_confirmed_balance: confirmed_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
+        }
+        blockchain_balance_unconfirmed_balance: unconfirmed_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
+        }
+        blockchain_balance_locked_balance: locked_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
+        }
+        blockchain_balance_required_reserve: required_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
+        }
+        blockchain_balance_available_balance: available_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_encrypted_signing_private_key: encrypted_signing_private_key {
+        __typename
+        secret_encrypted_value: encrypted_value
+        secret_cipher: cipher
+    }
+    lightspark_node_total_balance: total_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_total_local_balance: total_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
+    }
+    lightspark_node_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
+    }
+    lightspark_node_purpose: purpose
+    lightspark_node_remote_balance: remote_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_status: status
+}`;
+
+export default LightsparkNode;

package/src/objects/LightsparkNodePurpose.ts

@@ -0,0 +1,17 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+export enum LightsparkNodePurpose {
+  /**
+   * 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",
+
+  SEND = "SEND",
+
+  RECEIVE = "RECEIVE",
+
+  ROUTING = "ROUTING",
+}
+
+export default LightsparkNodePurpose;

package/src/objects/LightsparkNodeStatus.ts

@@ -0,0 +1,29 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+export enum LightsparkNodeStatus {
+  /**
+   * 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",
+
+  CREATED = "CREATED",
+
+  DEPLOYED = "DEPLOYED",
+
+  STARTED = "STARTED",
+
+  SYNCING = "SYNCING",
+
+  READY = "READY",
+
+  STOPPED = "STOPPED",
+
+  TERMINATED = "TERMINATED",
+
+  WALLET_LOCKED = "WALLET_LOCKED",
+
+  FAILED_TO_DEPLOY = "FAILED_TO_DEPLOY",
+}
+
+export default LightsparkNodeStatus;

package/src/objects/LightsparkNodeToChannelsConnection.ts

@@ -0,0 +1,50 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+import Channel, { ChannelFromJson } from "./Channel.js";
+import PageInfo, { PageInfoFromJson } from "./PageInfo.js";
+
+type LightsparkNodeToChannelsConnection = {
+  /** An object that holds pagination information about the objects in this connection. **/
+  pageInfo: PageInfo;
+
+  /**
+   * 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;
+
+  /** The channels for the current page of this connection. **/
+  entities: Channel[];
+};
+
+export const LightsparkNodeToChannelsConnectionFromJson = (
+  obj: any
+): LightsparkNodeToChannelsConnection => {
+  return {
+    pageInfo: PageInfoFromJson(
+      obj["lightspark_node_to_channels_connection_page_info"]
+    ),
+    count: obj["lightspark_node_to_channels_connection_count"],
+    entities: obj["lightspark_node_to_channels_connection_entities"].map((e) =>
+      ChannelFromJson(e)
+    ),
+  } as LightsparkNodeToChannelsConnection;
+};
+
+export const FRAGMENT = `
+fragment LightsparkNodeToChannelsConnectionFragment on LightsparkNodeToChannelsConnection {
+    __typename
+    lightspark_node_to_channels_connection_page_info: page_info {
+        __typename
+        page_info_has_next_page: has_next_page
+        page_info_has_previous_page: has_previous_page
+        page_info_start_cursor: start_cursor
+        page_info_end_cursor: end_cursor
+    }
+    lightspark_node_to_channels_connection_count: count
+    lightspark_node_to_channels_connection_entities: entities {
+        id
+    }
+}`;
+
+export default LightsparkNodeToChannelsConnection;