@lightsparkdev/lightspark-sdk 0.1.6

package/src/objects/Node.ts

@@ -0,0 +1,273 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+import { LightsparkException, Query } from "@lightsparkdev/core";
+import autoBind from "auto-bind";
+import LightsparkClient from "../client.js";
+import BitcoinNetwork from "./BitcoinNetwork.js";
+import { BlockchainBalanceFromJson } from "./BlockchainBalance.js";
+import { CurrencyAmountFromJson } from "./CurrencyAmount.js";
+import Entity from "./Entity.js";
+import GraphNode from "./GraphNode.js";
+import LightsparkNode from "./LightsparkNode.js";
+import LightsparkNodePurpose from "./LightsparkNodePurpose.js";
+import LightsparkNodeStatus from "./LightsparkNodeStatus.js";
+import NodeAddressType from "./NodeAddressType.js";
+import NodeToAddressesConnection, {
+  NodeToAddressesConnectionFromJson,
+} from "./NodeToAddressesConnection.js";
+import { SecretFromJson } from "./Secret.js";
+
+/** This interface represents a lightning node that can be connected to the Lightning Network to send and receive transactions. **/
+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);
+  }
+
+  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);
+      },
+    }))!;
+  }
+
+  static 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 const NodeFromJson = (obj: any): Node => {
+  if (obj["__typename"] == "GraphNode") {
+    return new GraphNode(
+      obj["graph_node_id"],
+      obj["graph_node_created_at"],
+      obj["graph_node_updated_at"],
+      BitcoinNetwork[obj["graph_node_bitcoin_network"]] ??
+        BitcoinNetwork.FUTURE_VALUE,
+      obj["graph_node_display_name"],
+      "GraphNode",
+      obj["graph_node_alias"],
+      obj["graph_node_color"],
+      obj["graph_node_conductivity"],
+      obj["graph_node_public_key"]
+    );
+  }
+  if (obj["__typename"] == "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
+    );
+  }
+  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 {
+    __typename
+    ... on GraphNode {
+        __typename
+        graph_node_id: id
+        graph_node_created_at: created_at
+        graph_node_updated_at: updated_at
+        graph_node_alias: alias
+        graph_node_bitcoin_network: bitcoin_network
+        graph_node_color: color
+        graph_node_conductivity: conductivity
+        graph_node_display_name: display_name
+        graph_node_public_key: public_key
+    }
+    ... 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 Node;

package/src/objects/NodeAddress.ts

@@ -0,0 +1,29 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+import NodeAddressType from "./NodeAddressType.js";
+
+/** An object that represents the address of a node on the Lightning Network. **/
+type 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 {
+    address: obj["node_address_address"],
+    type:
+      NodeAddressType[obj["node_address_type"]] ?? NodeAddressType.FUTURE_VALUE,
+  } as NodeAddress;
+};
+
+export const FRAGMENT = `
+fragment NodeAddressFragment on NodeAddress {
+    __typename
+    node_address_address: address
+    node_address_type: type
+}`;
+
+export default NodeAddress;

package/src/objects/NodeAddressType.ts

@@ -0,0 +1,18 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+/** An enum that enumerates all possible types of addresses of a node on the Lightning Network. **/
+export enum NodeAddressType {
+  /**
+   * 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",
+
+  IPV4 = "IPV4",
+
+  IPV6 = "IPV6",
+
+  TOR = "TOR",
+}
+
+export default NodeAddressType;

package/src/objects/NodeToAddressesConnection.ts

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

package/src/objects/OnChainTransaction.ts

@@ -0,0 +1,318 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+import { LightsparkException, Query } from "@lightsparkdev/core";
+import ChannelClosingTransaction from "./ChannelClosingTransaction.js";
+import ChannelOpeningTransaction from "./ChannelOpeningTransaction.js";
+import CurrencyAmount, { CurrencyAmountFromJson } from "./CurrencyAmount.js";
+import Deposit from "./Deposit.js";
+import Entity from "./Entity.js";
+import Transaction from "./Transaction.js";
+import TransactionStatus from "./TransactionStatus.js";
+import Withdrawal from "./Withdrawal.js";
+
+/** Transaction happened on Bitcoin blockchain. **/
+type 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 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;
+  };
+
+export const OnChainTransactionFromJson = (obj: any): OnChainTransaction => {
+  if (obj["__typename"] == "ChannelClosingTransaction") {
+    return {
+      id: obj["channel_closing_transaction_id"],
+      createdAt: obj["channel_closing_transaction_created_at"],
+      updatedAt: obj["channel_closing_transaction_updated_at"],
+      status:
+        TransactionStatus[obj["channel_closing_transaction_status"]] ??
+        TransactionStatus.FUTURE_VALUE,
+      amount: CurrencyAmountFromJson(obj["channel_closing_transaction_amount"]),
+      blockHeight: obj["channel_closing_transaction_block_height"],
+      destinationAddresses:
+        obj["channel_closing_transaction_destination_addresses"],
+      typename: "ChannelClosingTransaction",
+      resolvedAt: obj["channel_closing_transaction_resolved_at"],
+      transactionHash: obj["channel_closing_transaction_transaction_hash"],
+      fees: !!obj["channel_closing_transaction_fees"]
+        ? CurrencyAmountFromJson(obj["channel_closing_transaction_fees"])
+        : undefined,
+      blockHash: obj["channel_closing_transaction_block_hash"],
+      numConfirmations: obj["channel_closing_transaction_num_confirmations"],
+      channelId: obj["channel_closing_transaction_channel"]?.id ?? undefined,
+    } as ChannelClosingTransaction;
+  }
+  if (obj["__typename"] == "ChannelOpeningTransaction") {
+    return {
+      id: obj["channel_opening_transaction_id"],
+      createdAt: obj["channel_opening_transaction_created_at"],
+      updatedAt: obj["channel_opening_transaction_updated_at"],
+      status:
+        TransactionStatus[obj["channel_opening_transaction_status"]] ??
+        TransactionStatus.FUTURE_VALUE,
+      amount: CurrencyAmountFromJson(obj["channel_opening_transaction_amount"]),
+      blockHeight: obj["channel_opening_transaction_block_height"],
+      destinationAddresses:
+        obj["channel_opening_transaction_destination_addresses"],
+      typename: "ChannelOpeningTransaction",
+      resolvedAt: obj["channel_opening_transaction_resolved_at"],
+      transactionHash: obj["channel_opening_transaction_transaction_hash"],
+      fees: !!obj["channel_opening_transaction_fees"]
+        ? CurrencyAmountFromJson(obj["channel_opening_transaction_fees"])
+        : undefined,
+      blockHash: obj["channel_opening_transaction_block_hash"],
+      numConfirmations: obj["channel_opening_transaction_num_confirmations"],
+      channelId: obj["channel_opening_transaction_channel"]?.id ?? undefined,
+    } as ChannelOpeningTransaction;
+  }
+  if (obj["__typename"] == "Deposit") {
+    return {
+      id: obj["deposit_id"],
+      createdAt: obj["deposit_created_at"],
+      updatedAt: obj["deposit_updated_at"],
+      status:
+        TransactionStatus[obj["deposit_status"]] ??
+        TransactionStatus.FUTURE_VALUE,
+      amount: CurrencyAmountFromJson(obj["deposit_amount"]),
+      blockHeight: obj["deposit_block_height"],
+      destinationAddresses: obj["deposit_destination_addresses"],
+      destinationId: obj["deposit_destination"].id,
+      typename: "Deposit",
+      resolvedAt: obj["deposit_resolved_at"],
+      transactionHash: obj["deposit_transaction_hash"],
+      fees: !!obj["deposit_fees"]
+        ? CurrencyAmountFromJson(obj["deposit_fees"])
+        : undefined,
+      blockHash: obj["deposit_block_hash"],
+      numConfirmations: obj["deposit_num_confirmations"],
+    } as Deposit;
+  }
+  if (obj["__typename"] == "Withdrawal") {
+    return {
+      id: obj["withdrawal_id"],
+      createdAt: obj["withdrawal_created_at"],
+      updatedAt: obj["withdrawal_updated_at"],
+      status:
+        TransactionStatus[obj["withdrawal_status"]] ??
+        TransactionStatus.FUTURE_VALUE,
+      amount: CurrencyAmountFromJson(obj["withdrawal_amount"]),
+      blockHeight: obj["withdrawal_block_height"],
+      destinationAddresses: obj["withdrawal_destination_addresses"],
+      originId: obj["withdrawal_origin"].id,
+      typename: "Withdrawal",
+      resolvedAt: obj["withdrawal_resolved_at"],
+      transactionHash: obj["withdrawal_transaction_hash"],
+      fees: !!obj["withdrawal_fees"]
+        ? CurrencyAmountFromJson(obj["withdrawal_fees"])
+        : undefined,
+      blockHash: obj["withdrawal_block_hash"],
+      numConfirmations: obj["withdrawal_num_confirmations"],
+    } as Withdrawal;
+  }
+  throw new LightsparkException(
+    "DeserializationError",
+    `Couldn't find a concrete type for interface OnChainTransaction corresponding to the typename=${obj["__typename"]}`
+  );
+};
+
+export const FRAGMENT = `
+fragment OnChainTransactionFragment on OnChainTransaction {
+    __typename
+    ... on ChannelClosingTransaction {
+        __typename
+        channel_closing_transaction_id: id
+        channel_closing_transaction_created_at: created_at
+        channel_closing_transaction_updated_at: updated_at
+        channel_closing_transaction_status: status
+        channel_closing_transaction_resolved_at: resolved_at
+        channel_closing_transaction_amount: 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
+        }
+        channel_closing_transaction_transaction_hash: transaction_hash
+        channel_closing_transaction_fees: fees {
+            __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_closing_transaction_block_hash: block_hash
+        channel_closing_transaction_block_height: block_height
+        channel_closing_transaction_destination_addresses: destination_addresses
+        channel_closing_transaction_num_confirmations: num_confirmations
+        channel_closing_transaction_channel: channel {
+            id
+        }
+    }
+    ... on ChannelOpeningTransaction {
+        __typename
+        channel_opening_transaction_id: id
+        channel_opening_transaction_created_at: created_at
+        channel_opening_transaction_updated_at: updated_at
+        channel_opening_transaction_status: status
+        channel_opening_transaction_resolved_at: resolved_at
+        channel_opening_transaction_amount: 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
+        }
+        channel_opening_transaction_transaction_hash: transaction_hash
+        channel_opening_transaction_fees: fees {
+            __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_opening_transaction_block_hash: block_hash
+        channel_opening_transaction_block_height: block_height
+        channel_opening_transaction_destination_addresses: destination_addresses
+        channel_opening_transaction_num_confirmations: num_confirmations
+        channel_opening_transaction_channel: channel {
+            id
+        }
+    }
+    ... on Deposit {
+        __typename
+        deposit_id: id
+        deposit_created_at: created_at
+        deposit_updated_at: updated_at
+        deposit_status: status
+        deposit_resolved_at: resolved_at
+        deposit_amount: 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
+        }
+        deposit_transaction_hash: transaction_hash
+        deposit_fees: fees {
+            __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
+        }
+        deposit_block_hash: block_hash
+        deposit_block_height: block_height
+        deposit_destination_addresses: destination_addresses
+        deposit_num_confirmations: num_confirmations
+        deposit_destination: destination {
+            id
+        }
+    }
+    ... on Withdrawal {
+        __typename
+        withdrawal_id: id
+        withdrawal_created_at: created_at
+        withdrawal_updated_at: updated_at
+        withdrawal_status: status
+        withdrawal_resolved_at: resolved_at
+        withdrawal_amount: 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_transaction_hash: transaction_hash
+        withdrawal_fees: fees {
+            __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_block_hash: block_hash
+        withdrawal_block_height: block_height
+        withdrawal_destination_addresses: destination_addresses
+        withdrawal_num_confirmations: num_confirmations
+        withdrawal_origin: origin {
+            id
+        }
+    }
+}`;
+
+export const getOnChainTransactionQuery = (
+  id: string
+): Query<OnChainTransaction> => {
+  return {
+    queryPayload: `
+query GetOnChainTransaction($id: ID!) {
+    entity(id: $id) {
+        ... on OnChainTransaction {
+            ...OnChainTransactionFragment
+        }
+    }
+}
+
+${FRAGMENT}    
+`,
+    variables: { id },
+    constructObject: (data: any) => OnChainTransactionFromJson(data.entity),
+  };
+};
+
+export default OnChainTransaction;