@lightsparkdev/lightspark-sdk 0.1.6

package/src/objects/Channel.ts

@@ -0,0 +1,283 @@
+// 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 ChannelFees, { ChannelFeesFromJson } from "./ChannelFees.js";
+import ChannelStatus from "./ChannelStatus.js";
+import ChannelToTransactionsConnection, {
+  ChannelToTransactionsConnectionFromJson,
+} from "./ChannelToTransactionsConnection.js";
+import CurrencyAmount, { CurrencyAmountFromJson } from "./CurrencyAmount.js";
+import Entity from "./Entity.js";
+import TransactionType from "./TransactionType.js";
+
+/** An object that represents a payment channel between two nodes in the Lightning Network. **/
+class Channel implements Entity {
+  constructor(
+    public readonly id: string,
+    public readonly createdAt: string,
+    public readonly updatedAt: string,
+    public readonly localNodeId: string,
+    public readonly typename: string,
+    public readonly fundingTransactionId?: string,
+    public readonly capacity?: CurrencyAmount,
+    public readonly localBalance?: CurrencyAmount,
+    public readonly localUnsettledBalance?: CurrencyAmount,
+    public readonly remoteBalance?: CurrencyAmount,
+    public readonly remoteUnsettledBalance?: CurrencyAmount,
+    public readonly unsettledBalance?: CurrencyAmount,
+    public readonly totalBalance?: CurrencyAmount,
+    public readonly status?: ChannelStatus,
+    public readonly estimatedForceClosureWaitMinutes?: number,
+    public readonly commitFee?: CurrencyAmount,
+    public readonly fees?: ChannelFees,
+    public readonly remoteNodeId?: string,
+    public readonly shortChannelId?: string
+  ) {
+    autoBind(this);
+  }
+
+  public async getUptimePercentage(
+    client: LightsparkClient,
+    afterDate: string | undefined = undefined,
+    beforeDate: string | undefined = undefined
+  ): Promise<number> {
+    return await client.executeRawQuery({
+      queryPayload: ` 
+query FetchChannelUptimePercentage($entity_id: ID!, $after_date: DateTime, $before_date: DateTime) {
+    entity(id: $entity_id) {
+        ... on Channel {
+            uptime_percentage(, after_date: $after_date, before_date: $before_date)
+        }
+    }
+}
+`,
+      variables: {
+        entity_id: this.id,
+        after_date: afterDate,
+        before_date: beforeDate,
+      },
+      constructObject: (json) => {
+        const connection = json["entity"]["uptime_percentage"];
+        return connection;
+      },
+    });
+  }
+
+  public async getTransactions(
+    client: LightsparkClient,
+    types: TransactionType[] | undefined = undefined,
+    afterDate: string | undefined = undefined,
+    beforeDate: string | undefined = undefined
+  ): Promise<ChannelToTransactionsConnection> {
+    return (await client.executeRawQuery({
+      queryPayload: ` 
+query FetchChannelToTransactionsConnection($entity_id: ID!, $types: [TransactionType!], $after_date: DateTime, $before_date: DateTime) {
+    entity(id: $entity_id) {
+        ... on Channel {
+            transactions(, types: $types, after_date: $after_date, before_date: $before_date) {
+                __typename
+                channel_to_transactions_connection_count: count
+                channel_to_transactions_connection_average_fee: average_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_to_transactions_connection_total_amount_transacted: total_amount_transacted {
+                    __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_to_transactions_connection_total_fees: total_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
+                }
+            }
+        }
+    }
+}
+`,
+      variables: {
+        entity_id: this.id,
+        types: types,
+        after_date: afterDate,
+        before_date: beforeDate,
+      },
+      constructObject: (json) => {
+        const connection = json["entity"]["transactions"];
+        return ChannelToTransactionsConnectionFromJson(connection);
+      },
+    }))!;
+  }
+
+  static getChannelQuery(id: string): Query<Channel> {
+    return {
+      queryPayload: `
+query GetChannel($id: ID!) {
+    entity(id: $id) {
+        ... on Channel {
+            ...ChannelFragment
+        }
+    }
+}
+
+${FRAGMENT}    
+`,
+      variables: { id },
+      constructObject: (data: any) => ChannelFromJson(data.entity),
+    };
+  }
+}
+
+export const ChannelFromJson = (obj: any): Channel => {
+  return new Channel(
+    obj["channel_id"],
+    obj["channel_created_at"],
+    obj["channel_updated_at"],
+    obj["channel_local_node"].id,
+    "Channel",
+    obj["channel_funding_transaction"]?.id ?? undefined,
+    !!obj["channel_capacity"]
+      ? CurrencyAmountFromJson(obj["channel_capacity"])
+      : undefined,
+    !!obj["channel_local_balance"]
+      ? CurrencyAmountFromJson(obj["channel_local_balance"])
+      : undefined,
+    !!obj["channel_local_unsettled_balance"]
+      ? CurrencyAmountFromJson(obj["channel_local_unsettled_balance"])
+      : undefined,
+    !!obj["channel_remote_balance"]
+      ? CurrencyAmountFromJson(obj["channel_remote_balance"])
+      : undefined,
+    !!obj["channel_remote_unsettled_balance"]
+      ? CurrencyAmountFromJson(obj["channel_remote_unsettled_balance"])
+      : undefined,
+    !!obj["channel_unsettled_balance"]
+      ? CurrencyAmountFromJson(obj["channel_unsettled_balance"])
+      : undefined,
+    !!obj["channel_total_balance"]
+      ? CurrencyAmountFromJson(obj["channel_total_balance"])
+      : undefined,
+    !!obj["channel_status"]
+      ? ChannelStatus[obj["channel_status"]] ?? ChannelStatus.FUTURE_VALUE
+      : null,
+    obj["channel_estimated_force_closure_wait_minutes"],
+    !!obj["channel_commit_fee"]
+      ? CurrencyAmountFromJson(obj["channel_commit_fee"])
+      : undefined,
+    !!obj["channel_fees"]
+      ? ChannelFeesFromJson(obj["channel_fees"])
+      : undefined,
+    obj["channel_remote_node"]?.id ?? undefined,
+    obj["channel_short_channel_id"]
+  );
+};
+
+export const FRAGMENT = `
+fragment ChannelFragment on Channel {
+    __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
+}`;
+
+export default Channel;

package/src/objects/ChannelClosingTransaction.ts

@@ -0,0 +1,150 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+import { Query } from "@lightsparkdev/core";
+import CurrencyAmount, { CurrencyAmountFromJson } from "./CurrencyAmount.js";
+import Entity from "./Entity.js";
+import OnChainTransaction from "./OnChainTransaction.js";
+import Transaction from "./Transaction.js";
+import TransactionStatus from "./TransactionStatus.js";
+
+/** The transaction on Bitcoin blockchain to close a channel on Lightning Network where the balances are allocated back to local and remote nodes. **/
+type ChannelClosingTransaction = 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;
+
+    /** If known, the channel this transaction is closing. **/
+    channelId?: string;
+  };
+
+export const ChannelClosingTransactionFromJson = (
+  obj: any
+): 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;
+};
+
+export const FRAGMENT = `
+fragment ChannelClosingTransactionFragment 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
+    }
+}`;
+
+export const getChannelClosingTransactionQuery = (
+  id: string
+): Query<ChannelClosingTransaction> => {
+  return {
+    queryPayload: `
+query GetChannelClosingTransaction($id: ID!) {
+    entity(id: $id) {
+        ... on ChannelClosingTransaction {
+            ...ChannelClosingTransactionFragment
+        }
+    }
+}
+
+${FRAGMENT}    
+`,
+    variables: { id },
+    constructObject: (data: any) =>
+      ChannelClosingTransactionFromJson(data.entity),
+  };
+};
+
+export default ChannelClosingTransaction;

package/src/objects/ChannelFees.ts

@@ -0,0 +1,34 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+import CurrencyAmount, { CurrencyAmountFromJson } from "./CurrencyAmount.js";
+
+type ChannelFees = {
+  baseFee?: CurrencyAmount;
+
+  feeRatePerMil?: number;
+};
+
+export const ChannelFeesFromJson = (obj: any): ChannelFees => {
+  return {
+    baseFee: !!obj["channel_fees_base_fee"]
+      ? CurrencyAmountFromJson(obj["channel_fees_base_fee"])
+      : undefined,
+    feeRatePerMil: obj["channel_fees_fee_rate_per_mil"],
+  } as ChannelFees;
+};
+
+export const FRAGMENT = `
+fragment ChannelFeesFragment on ChannelFees {
+    __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
+}`;
+
+export default ChannelFees;

package/src/objects/ChannelOpeningTransaction.ts

@@ -0,0 +1,150 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+import { Query } from "@lightsparkdev/core";
+import CurrencyAmount, { CurrencyAmountFromJson } from "./CurrencyAmount.js";
+import Entity from "./Entity.js";
+import OnChainTransaction from "./OnChainTransaction.js";
+import Transaction from "./Transaction.js";
+import TransactionStatus from "./TransactionStatus.js";
+
+/** The transaction on Bitcoin blockchain to open a channel on Lightning Network funded by the local Lightspark node. **/
+type ChannelOpeningTransaction = 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;
+
+    /** If known, the channel this transaction is opening. **/
+    channelId?: string;
+  };
+
+export const ChannelOpeningTransactionFromJson = (
+  obj: any
+): 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;
+};
+
+export const FRAGMENT = `
+fragment ChannelOpeningTransactionFragment 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
+    }
+}`;
+
+export const getChannelOpeningTransactionQuery = (
+  id: string
+): Query<ChannelOpeningTransaction> => {
+  return {
+    queryPayload: `
+query GetChannelOpeningTransaction($id: ID!) {
+    entity(id: $id) {
+        ... on ChannelOpeningTransaction {
+            ...ChannelOpeningTransactionFragment
+        }
+    }
+}
+
+${FRAGMENT}    
+`,
+    variables: { id },
+    constructObject: (data: any) =>
+      ChannelOpeningTransactionFromJson(data.entity),
+  };
+};
+
+export default ChannelOpeningTransaction;

package/src/objects/ChannelStatus.ts

@@ -0,0 +1,25 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+export enum ChannelStatus {
+  /**
+   * 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",
+  /** The channel is online and ready to send and receive funds. **/
+  OK = "OK",
+  /** The channel has been created, but the Bitcoin transaction that initiates it still needs to be confirmed on the Bitcoin blockchain. **/
+  PENDING = "PENDING",
+  /** The channel is not available, likely because the peer is not online. **/
+  OFFLINE = "OFFLINE",
+  /** The channel is behaving properly, but its remote balance is much higher than its local balance so it is not balanced properly for sending funds out. **/
+  UNBALANCED_FOR_SEND = "UNBALANCED_FOR_SEND",
+  /** The channel is behaving properly, but its remote balance is much lower than its local balance so it is not balanced properly for receiving funds. **/
+  UNBALANCED_FOR_RECEIVE = "UNBALANCED_FOR_RECEIVE",
+  /** The channel has been closed. Information about the channel is still available for historical purposes but the channel cannot be used anymore. **/
+  CLOSED = "CLOSED",
+  /** Something unexpected happened and we cannot determine the status of this channel. Please try again later or contact the support. **/
+  ERROR = "ERROR",
+}
+
+export default ChannelStatus;