@lightsparkdev/lightspark-sdk 1.1.7 → 1.2.1

package/src/objects/BlockchainBalance.ts

@@ -1,28 +1,31 @@
 // Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
 
 import type CurrencyAmount from "./CurrencyAmount.js";
-import { CurrencyAmountFromJson } from "./CurrencyAmount.js";
+import {
+  CurrencyAmountFromJson,
+  CurrencyAmountToJson,
+} from "./CurrencyAmount.js";
 
 /** This is an object representing a detailed breakdown of the balance for a Lightspark Node. **/
-type BlockchainBalance = {
+interface BlockchainBalance {
   /** The total wallet balance, including unconfirmed UTXOs. **/
-  totalBalance?: CurrencyAmount;
+  totalBalance?: CurrencyAmount | undefined;
 
   /** The balance of confirmed UTXOs in the wallet. **/
-  confirmedBalance?: CurrencyAmount;
+  confirmedBalance?: CurrencyAmount | undefined;
 
   /** The balance of unconfirmed UTXOs in the wallet. **/
-  unconfirmedBalance?: CurrencyAmount;
+  unconfirmedBalance?: CurrencyAmount | undefined;
 
   /** The balance that's locked by an on-chain transaction. **/
-  lockedBalance?: CurrencyAmount;
+  lockedBalance?: CurrencyAmount | undefined;
 
   /** Funds required to be held in reserve for channel bumping. **/
-  requiredReserve?: CurrencyAmount;
+  requiredReserve?: CurrencyAmount | undefined;
 
   /** Funds available for creating channels or withdrawing. **/
-  availableBalance?: CurrencyAmount;
-};
+  availableBalance?: CurrencyAmount | undefined;
+}
 
 export const BlockchainBalanceFromJson = (obj: any): BlockchainBalance => {
   return {
@@ -46,6 +49,28 @@ export const BlockchainBalanceFromJson = (obj: any): BlockchainBalance => {
       : undefined,
   } as BlockchainBalance;
 };
+export const BlockchainBalanceToJson = (obj: BlockchainBalance): any => {
+  return {
+    blockchain_balance_total_balance: obj.totalBalance
+      ? CurrencyAmountToJson(obj.totalBalance)
+      : undefined,
+    blockchain_balance_confirmed_balance: obj.confirmedBalance
+      ? CurrencyAmountToJson(obj.confirmedBalance)
+      : undefined,
+    blockchain_balance_unconfirmed_balance: obj.unconfirmedBalance
+      ? CurrencyAmountToJson(obj.unconfirmedBalance)
+      : undefined,
+    blockchain_balance_locked_balance: obj.lockedBalance
+      ? CurrencyAmountToJson(obj.lockedBalance)
+      : undefined,
+    blockchain_balance_required_reserve: obj.requiredReserve
+      ? CurrencyAmountToJson(obj.requiredReserve)
+      : undefined,
+    blockchain_balance_available_balance: obj.availableBalance
+      ? CurrencyAmountToJson(obj.availableBalance)
+      : undefined,
+  };
+};
 
 export const FRAGMENT = `
 fragment BlockchainBalanceFragment on BlockchainBalance {

package/src/objects/Channel.ts

@@ -4,37 +4,71 @@ import { type Query } from "@lightsparkdev/core";
 import autoBind from "auto-bind";
 import type LightsparkClient from "../client.js";
 import type ChannelFees from "./ChannelFees.js";
-import { ChannelFeesFromJson } from "./ChannelFees.js";
+import { ChannelFeesFromJson, ChannelFeesToJson } from "./ChannelFees.js";
 import ChannelStatus from "./ChannelStatus.js";
 import type ChannelToTransactionsConnection from "./ChannelToTransactionsConnection.js";
 import { ChannelToTransactionsConnectionFromJson } from "./ChannelToTransactionsConnection.js";
 import type CurrencyAmount from "./CurrencyAmount.js";
-import { CurrencyAmountFromJson } from "./CurrencyAmount.js";
+import {
+  CurrencyAmountFromJson,
+  CurrencyAmountToJson,
+} from "./CurrencyAmount.js";
 import type Entity from "./Entity.js";
 import type TransactionType from "./TransactionType.js";
 
 /** This is an object representing a channel on the Lightning Network. You can retrieve this object to get detailed information on a specific Lightning Network channel. **/
 class Channel implements Entity {
   constructor(
+    /**
+     * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
+     * string.
+     **/
     public readonly id: string,
+    /** The date and time when the entity was first created. **/
     public readonly createdAt: string,
+    /** The date and time when the entity was last updated. **/
     public readonly updatedAt: string,
+    /** The local Lightspark node of the channel. **/
     public readonly localNodeId: string,
+    /** The typename of the object **/
     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,
+    /** The transaction that funded the channel upon channel opening. **/
+    public readonly fundingTransactionId?: string | undefined,
+    /**
+     * The total amount of funds in this channel, including the channel balance on the local node, the
+     * channel balance on the remote node and the on-chain fees to close the channel.
+     **/
+    public readonly capacity?: CurrencyAmount | undefined,
+    /** The channel balance on the local node. **/
+    public readonly localBalance?: CurrencyAmount | undefined,
+    /** The channel balance on the local node that is currently allocated to in-progress payments. **/
+    public readonly localUnsettledBalance?: CurrencyAmount | undefined,
+    /** The channel balance on the remote node. **/
+    public readonly remoteBalance?: CurrencyAmount | undefined,
+    /** The channel balance on the remote node that is currently allocated to in-progress payments. **/
+    public readonly remoteUnsettledBalance?: CurrencyAmount | undefined,
+    /** The channel balance that is currently allocated to in-progress payments. **/
+    public readonly unsettledBalance?: CurrencyAmount | undefined,
+    /** The total balance in this channel, including the channel balance on both local and remote nodes. **/
+    public readonly totalBalance?: CurrencyAmount | undefined,
+    /** The current status of this channel. **/
+    public readonly status?: ChannelStatus | undefined,
+    /**
+     * The estimated time to wait for the channel's hash timelock contract to expire when force closing
+     * the channel. It is in unit of minutes.
+     **/
+    public readonly estimatedForceClosureWaitMinutes?: number | undefined,
+    /** The amount to be paid in fees for the current set of commitment transactions. **/
+    public readonly commitFee?: CurrencyAmount | undefined,
+    /** The fees charged for routing payments through this channel. **/
+    public readonly fees?: ChannelFees | undefined,
+    /** If known, the remote node of the channel. **/
+    public readonly remoteNodeId?: string | undefined,
+    /**
+     * The unique identifier of the channel on Lightning Network, which is the location in the chain that
+     * the channel was confirmed. The format is <block-height>:<tx-index>:<tx-output>.
+     **/
+    public readonly shortChannelId?: string | undefined,
   ) {
     autoBind(this);
   }
@@ -139,6 +173,48 @@ ${FRAGMENT}
       constructObject: (data: any) => ChannelFromJson(data.entity),
     };
   }
+
+  public toJson() {
+    return {
+      __typename: "Channel",
+      channel_id: this.id,
+      channel_created_at: this.createdAt,
+      channel_updated_at: this.updatedAt,
+      channel_funding_transaction:
+        { id: this.fundingTransactionId } ?? undefined,
+      channel_capacity: this.capacity
+        ? CurrencyAmountToJson(this.capacity)
+        : undefined,
+      channel_local_balance: this.localBalance
+        ? CurrencyAmountToJson(this.localBalance)
+        : undefined,
+      channel_local_unsettled_balance: this.localUnsettledBalance
+        ? CurrencyAmountToJson(this.localUnsettledBalance)
+        : undefined,
+      channel_remote_balance: this.remoteBalance
+        ? CurrencyAmountToJson(this.remoteBalance)
+        : undefined,
+      channel_remote_unsettled_balance: this.remoteUnsettledBalance
+        ? CurrencyAmountToJson(this.remoteUnsettledBalance)
+        : undefined,
+      channel_unsettled_balance: this.unsettledBalance
+        ? CurrencyAmountToJson(this.unsettledBalance)
+        : undefined,
+      channel_total_balance: this.totalBalance
+        ? CurrencyAmountToJson(this.totalBalance)
+        : undefined,
+      channel_status: this.status,
+      channel_estimated_force_closure_wait_minutes:
+        this.estimatedForceClosureWaitMinutes,
+      channel_commit_fee: this.commitFee
+        ? CurrencyAmountToJson(this.commitFee)
+        : undefined,
+      channel_fees: this.fees ? ChannelFeesToJson(this.fees) : undefined,
+      channel_remote_node: { id: this.remoteNodeId } ?? undefined,
+      channel_local_node: { id: this.localNodeId },
+      channel_short_channel_id: this.shortChannelId,
+    };
+  }
 }
 
 export const ChannelFromJson = (obj: any): Channel => {

package/src/objects/ChannelClosingTransaction.ts

@@ -2,70 +2,68 @@
 
 import { type Query } from "@lightsparkdev/core";
 import type CurrencyAmount from "./CurrencyAmount.js";
-import { CurrencyAmountFromJson } from "./CurrencyAmount.js";
-import type Entity from "./Entity.js";
-import type OnChainTransaction from "./OnChainTransaction.js";
-import type Transaction from "./Transaction.js";
+import {
+  CurrencyAmountFromJson,
+  CurrencyAmountToJson,
+} from "./CurrencyAmount.js";
 import TransactionStatus from "./TransactionStatus.js";
 
 /** This is an object representing a transaction which closes a channel on the Lightning Network. This operation allocates balances back to the 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;
-  };
+interface ChannelClosingTransaction {
+  /**
+   * 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 | undefined;
+
+  /** The hash of this transaction, so it can be uniquely identified on the Lightning Network. **/
+  transactionHash?: string | undefined;
+
+  /**
+   * The fees that were paid by the wallet sending the transaction to commit it to the Bitcoin
+   * blockchain.
+   **/
+  fees?: CurrencyAmount | undefined;
+
+  /**
+   * The hash of the block that included this transaction. This will be null for unconfirmed
+   * transactions.
+   **/
+  blockHash?: string | undefined;
+
+  /** The number of blockchain confirmations for this transaction in real time. **/
+  numConfirmations?: number | undefined;
+
+  /** If known, the channel this transaction is closing. **/
+  channelId?: string | undefined;
+}
 
 export const ChannelClosingTransactionFromJson = (
   obj: any,
@@ -92,6 +90,28 @@ export const ChannelClosingTransactionFromJson = (
     channelId: obj["channel_closing_transaction_channel"]?.id ?? undefined,
   } as ChannelClosingTransaction;
 };
+export const ChannelClosingTransactionToJson = (
+  obj: ChannelClosingTransaction,
+): any => {
+  return {
+    __typename: "ChannelClosingTransaction",
+    channel_closing_transaction_id: obj.id,
+    channel_closing_transaction_created_at: obj.createdAt,
+    channel_closing_transaction_updated_at: obj.updatedAt,
+    channel_closing_transaction_status: obj.status,
+    channel_closing_transaction_resolved_at: obj.resolvedAt,
+    channel_closing_transaction_amount: CurrencyAmountToJson(obj.amount),
+    channel_closing_transaction_transaction_hash: obj.transactionHash,
+    channel_closing_transaction_fees: obj.fees
+      ? CurrencyAmountToJson(obj.fees)
+      : undefined,
+    channel_closing_transaction_block_hash: obj.blockHash,
+    channel_closing_transaction_block_height: obj.blockHeight,
+    channel_closing_transaction_destination_addresses: obj.destinationAddresses,
+    channel_closing_transaction_num_confirmations: obj.numConfirmations,
+    channel_closing_transaction_channel: { id: obj.channelId } ?? undefined,
+  };
+};
 
 export const FRAGMENT = `
 fragment ChannelClosingTransactionFragment on ChannelClosingTransaction {

package/src/objects/ChannelFees.ts

@@ -1,14 +1,17 @@
 // Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
 
 import type CurrencyAmount from "./CurrencyAmount.js";
-import { CurrencyAmountFromJson } from "./CurrencyAmount.js";
+import {
+  CurrencyAmountFromJson,
+  CurrencyAmountToJson,
+} from "./CurrencyAmount.js";
 
 /** This represents the fee policies set for a channel on the Lightning Network. **/
-type ChannelFees = {
-  baseFee?: CurrencyAmount;
+interface ChannelFees {
+  baseFee?: CurrencyAmount | undefined;
 
-  feeRatePerMil?: number;
-};
+  feeRatePerMil?: number | undefined;
+}
 
 export const ChannelFeesFromJson = (obj: any): ChannelFees => {
   return {
@@ -18,6 +21,14 @@ export const ChannelFeesFromJson = (obj: any): ChannelFees => {
     feeRatePerMil: obj["channel_fees_fee_rate_per_mil"],
   } as ChannelFees;
 };
+export const ChannelFeesToJson = (obj: ChannelFees): any => {
+  return {
+    channel_fees_base_fee: obj.baseFee
+      ? CurrencyAmountToJson(obj.baseFee)
+      : undefined,
+    channel_fees_fee_rate_per_mil: obj.feeRatePerMil,
+  };
+};
 
 export const FRAGMENT = `
 fragment ChannelFeesFragment on ChannelFees {

package/src/objects/ChannelOpeningTransaction.ts

@@ -2,70 +2,68 @@
 
 import { type Query } from "@lightsparkdev/core";
 import type CurrencyAmount from "./CurrencyAmount.js";
-import { CurrencyAmountFromJson } from "./CurrencyAmount.js";
-import type Entity from "./Entity.js";
-import type OnChainTransaction from "./OnChainTransaction.js";
-import type Transaction from "./Transaction.js";
+import {
+  CurrencyAmountFromJson,
+  CurrencyAmountToJson,
+} from "./CurrencyAmount.js";
 import TransactionStatus from "./TransactionStatus.js";
 
 /** This is an object representing a transaction which opens a channel on the Lightning Network. This object occurs only for channels 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;
-  };
+interface ChannelOpeningTransaction {
+  /**
+   * 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 | undefined;
+
+  /** The hash of this transaction, so it can be uniquely identified on the Lightning Network. **/
+  transactionHash?: string | undefined;
+
+  /**
+   * The fees that were paid by the wallet sending the transaction to commit it to the Bitcoin
+   * blockchain.
+   **/
+  fees?: CurrencyAmount | undefined;
+
+  /**
+   * The hash of the block that included this transaction. This will be null for unconfirmed
+   * transactions.
+   **/
+  blockHash?: string | undefined;
+
+  /** The number of blockchain confirmations for this transaction in real time. **/
+  numConfirmations?: number | undefined;
+
+  /** If known, the channel this transaction is opening. **/
+  channelId?: string | undefined;
+}
 
 export const ChannelOpeningTransactionFromJson = (
   obj: any,
@@ -92,6 +90,28 @@ export const ChannelOpeningTransactionFromJson = (
     channelId: obj["channel_opening_transaction_channel"]?.id ?? undefined,
   } as ChannelOpeningTransaction;
 };
+export const ChannelOpeningTransactionToJson = (
+  obj: ChannelOpeningTransaction,
+): any => {
+  return {
+    __typename: "ChannelOpeningTransaction",
+    channel_opening_transaction_id: obj.id,
+    channel_opening_transaction_created_at: obj.createdAt,
+    channel_opening_transaction_updated_at: obj.updatedAt,
+    channel_opening_transaction_status: obj.status,
+    channel_opening_transaction_resolved_at: obj.resolvedAt,
+    channel_opening_transaction_amount: CurrencyAmountToJson(obj.amount),
+    channel_opening_transaction_transaction_hash: obj.transactionHash,
+    channel_opening_transaction_fees: obj.fees
+      ? CurrencyAmountToJson(obj.fees)
+      : undefined,
+    channel_opening_transaction_block_hash: obj.blockHash,
+    channel_opening_transaction_block_height: obj.blockHeight,
+    channel_opening_transaction_destination_addresses: obj.destinationAddresses,
+    channel_opening_transaction_num_confirmations: obj.numConfirmations,
+    channel_opening_transaction_channel: { id: obj.channelId } ?? undefined,
+  };
+};
 
 export const FRAGMENT = `
 fragment ChannelOpeningTransactionFragment on ChannelOpeningTransaction {

package/src/objects/ChannelSnapshot.ts

@@ -1,23 +1,26 @@
 // Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
 
 import type CurrencyAmount from "./CurrencyAmount.js";
-import { CurrencyAmountFromJson } from "./CurrencyAmount.js";
+import {
+  CurrencyAmountFromJson,
+  CurrencyAmountToJson,
+} from "./CurrencyAmount.js";
 
-type ChannelSnapshot = {
+interface ChannelSnapshot {
   channelId: string;
 
   timestamp: string;
 
-  localBalance?: CurrencyAmount;
+  localBalance?: CurrencyAmount | undefined;
 
-  localUnsettledBalance?: CurrencyAmount;
+  localUnsettledBalance?: CurrencyAmount | undefined;
 
-  localChannelReserve?: CurrencyAmount;
+  localChannelReserve?: CurrencyAmount | undefined;
 
-  remoteBalance?: CurrencyAmount;
+  remoteBalance?: CurrencyAmount | undefined;
 
-  remoteUnsettledBalance?: CurrencyAmount;
-};
+  remoteUnsettledBalance?: CurrencyAmount | undefined;
+}
 
 export const ChannelSnapshotFromJson = (obj: any): ChannelSnapshot => {
   return {
@@ -40,6 +43,27 @@ export const ChannelSnapshotFromJson = (obj: any): ChannelSnapshot => {
       : undefined,
   } as ChannelSnapshot;
 };
+export const ChannelSnapshotToJson = (obj: ChannelSnapshot): any => {
+  return {
+    channel_snapshot_channel: { id: obj.channelId },
+    channel_snapshot_timestamp: obj.timestamp,
+    channel_snapshot_local_balance: obj.localBalance
+      ? CurrencyAmountToJson(obj.localBalance)
+      : undefined,
+    channel_snapshot_local_unsettled_balance: obj.localUnsettledBalance
+      ? CurrencyAmountToJson(obj.localUnsettledBalance)
+      : undefined,
+    channel_snapshot_local_channel_reserve: obj.localChannelReserve
+      ? CurrencyAmountToJson(obj.localChannelReserve)
+      : undefined,
+    channel_snapshot_remote_balance: obj.remoteBalance
+      ? CurrencyAmountToJson(obj.remoteBalance)
+      : undefined,
+    channel_snapshot_remote_unsettled_balance: obj.remoteUnsettledBalance
+      ? CurrencyAmountToJson(obj.remoteUnsettledBalance)
+      : undefined,
+  };
+};
 
 export const FRAGMENT = `
 fragment ChannelSnapshotFragment on ChannelSnapshot {