@lightsparkdev/lightspark-sdk 1.1.7 → 1.2.1

package/src/objects/CreateUmaInvoiceInput.ts

@@ -1,14 +1,14 @@
 // Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
 
-type CreateUmaInvoiceInput = {
+interface CreateUmaInvoiceInput {
   nodeId: string;
 
   amountMsats: number;
 
   metadataHash: string;
 
-  expirySecs?: number;
-};
+  expirySecs?: number | undefined;
+}
 
 export const CreateUmaInvoiceInputFromJson = (
   obj: any,
@@ -20,5 +20,15 @@ export const CreateUmaInvoiceInputFromJson = (
     expirySecs: obj["create_uma_invoice_input_expiry_secs"],
   } as CreateUmaInvoiceInput;
 };
+export const CreateUmaInvoiceInputToJson = (
+  obj: CreateUmaInvoiceInput,
+): any => {
+  return {
+    create_uma_invoice_input_node_id: obj.nodeId,
+    create_uma_invoice_input_amount_msats: obj.amountMsats,
+    create_uma_invoice_input_metadata_hash: obj.metadataHash,
+    create_uma_invoice_input_expiry_secs: obj.expirySecs,
+  };
+};
 
 export default CreateUmaInvoiceInput;

package/src/objects/CurrencyAmount.ts

@@ -3,7 +3,7 @@
 import CurrencyUnit from "./CurrencyUnit.js";
 
 /** This object represents the value and unit for an amount of currency. **/
-type CurrencyAmount = {
+interface CurrencyAmount {
   /** The original numeric value for this CurrencyAmount. **/
   originalValue: number;
 
@@ -24,7 +24,7 @@ type CurrencyAmount = {
    * currency. For example, for USD, the value will be in cents.
    **/
   preferredCurrencyValueApprox: number;
-};
+}
 
 export const CurrencyAmountFromJson = (obj: any): CurrencyAmount => {
   return {
@@ -41,6 +41,17 @@ export const CurrencyAmountFromJson = (obj: any): CurrencyAmount => {
       obj["currency_amount_preferred_currency_value_approx"],
   } as CurrencyAmount;
 };
+export const CurrencyAmountToJson = (obj: CurrencyAmount): any => {
+  return {
+    currency_amount_original_value: obj.originalValue,
+    currency_amount_original_unit: obj.originalUnit,
+    currency_amount_preferred_currency_unit: obj.preferredCurrencyUnit,
+    currency_amount_preferred_currency_value_rounded:
+      obj.preferredCurrencyValueRounded,
+    currency_amount_preferred_currency_value_approx:
+      obj.preferredCurrencyValueApprox,
+  };
+};
 
 export const FRAGMENT = `
 fragment CurrencyAmountFragment on CurrencyAmount {

package/src/objects/DeclineToSignMessagesInput.ts

@@ -1,9 +1,9 @@
 // Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
 
-type DeclineToSignMessagesInput = {
+interface DeclineToSignMessagesInput {
   /** List of payload ids to decline to sign because validation failed. **/
   payloadIds: string[];
-};
+}
 
 export const DeclineToSignMessagesInputFromJson = (
   obj: any,
@@ -12,5 +12,12 @@ export const DeclineToSignMessagesInputFromJson = (
     payloadIds: obj["decline_to_sign_messages_input_payload_ids"],
   } as DeclineToSignMessagesInput;
 };
+export const DeclineToSignMessagesInputToJson = (
+  obj: DeclineToSignMessagesInput,
+): any => {
+  return {
+    decline_to_sign_messages_input_payload_ids: obj.payloadIds,
+  };
+};
 
 export default DeclineToSignMessagesInput;

package/src/objects/DeclineToSignMessagesOutput.ts

@@ -1,11 +1,14 @@
 // Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
 
 import type SignablePayload from "./SignablePayload.js";
-import { SignablePayloadFromJson } from "./SignablePayload.js";
+import {
+  SignablePayloadFromJson,
+  SignablePayloadToJson,
+} from "./SignablePayload.js";
 
-type DeclineToSignMessagesOutput = {
+interface DeclineToSignMessagesOutput {
   declinedPayloads: SignablePayload[];
-};
+}
 
 export const DeclineToSignMessagesOutputFromJson = (
   obj: any,
@@ -16,6 +19,15 @@ export const DeclineToSignMessagesOutputFromJson = (
     ].map((e) => SignablePayloadFromJson(e)),
   } as DeclineToSignMessagesOutput;
 };
+export const DeclineToSignMessagesOutputToJson = (
+  obj: DeclineToSignMessagesOutput,
+): any => {
+  return {
+    decline_to_sign_messages_output_declined_payloads: obj.declinedPayloads.map(
+      (e) => SignablePayloadToJson(e),
+    ),
+  };
+};
 
 export const FRAGMENT = `
 fragment DeclineToSignMessagesOutputFragment on DeclineToSignMessagesOutput {

package/src/objects/DeleteApiTokenInput.ts

@@ -1,13 +1,18 @@
 // Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
 
-type DeleteApiTokenInput = {
+interface DeleteApiTokenInput {
   apiTokenId: string;
-};
+}
 
 export const DeleteApiTokenInputFromJson = (obj: any): DeleteApiTokenInput => {
   return {
     apiTokenId: obj["delete_api_token_input_api_token_id"],
   } as DeleteApiTokenInput;
 };
+export const DeleteApiTokenInputToJson = (obj: DeleteApiTokenInput): any => {
+  return {
+    delete_api_token_input_api_token_id: obj.apiTokenId,
+  };
+};
 
 export default DeleteApiTokenInput;

package/src/objects/DeleteApiTokenOutput.ts

@@ -1,8 +1,8 @@
 // Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
 
-type DeleteApiTokenOutput = {
+interface DeleteApiTokenOutput {
   accountId: string;
-};
+}
 
 export const DeleteApiTokenOutputFromJson = (
   obj: any,
@@ -11,6 +11,11 @@ export const DeleteApiTokenOutputFromJson = (
     accountId: obj["delete_api_token_output_account"].id,
   } as DeleteApiTokenOutput;
 };
+export const DeleteApiTokenOutputToJson = (obj: DeleteApiTokenOutput): any => {
+  return {
+    delete_api_token_output_account: { id: obj.accountId },
+  };
+};
 
 export const FRAGMENT = `
 fragment DeleteApiTokenOutputFragment on DeleteApiTokenOutput {

package/src/objects/Deposit.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 object represents a Deposit made to a Lightspark node wallet. This operation occurs for any L1 funding transaction to the wallet. You can retrieve this object to receive detailed information about the deposit. **/
-type Deposit = 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 recipient Lightspark node this deposit was sent to. **/
-    destinationId: 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;
-  };
+interface Deposit {
+  /**
+   * 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 recipient Lightspark node this deposit was sent to. **/
+  destinationId: 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;
+}
 
 export const DepositFromJson = (obj: any): Deposit => {
   return {
@@ -89,6 +87,24 @@ export const DepositFromJson = (obj: any): Deposit => {
     numConfirmations: obj["deposit_num_confirmations"],
   } as Deposit;
 };
+export const DepositToJson = (obj: Deposit): any => {
+  return {
+    __typename: "Deposit",
+    deposit_id: obj.id,
+    deposit_created_at: obj.createdAt,
+    deposit_updated_at: obj.updatedAt,
+    deposit_status: obj.status,
+    deposit_resolved_at: obj.resolvedAt,
+    deposit_amount: CurrencyAmountToJson(obj.amount),
+    deposit_transaction_hash: obj.transactionHash,
+    deposit_fees: obj.fees ? CurrencyAmountToJson(obj.fees) : undefined,
+    deposit_block_hash: obj.blockHash,
+    deposit_block_height: obj.blockHeight,
+    deposit_destination_addresses: obj.destinationAddresses,
+    deposit_num_confirmations: obj.numConfirmations,
+    deposit_destination: { id: obj.destinationId },
+  };
+};
 
 export const FRAGMENT = `
 fragment DepositFragment on Deposit {

package/src/objects/Entity.ts

@@ -1,7 +1,7 @@
 // Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
 
 /** This interface is used by all the entities in the Lightspark system. It defines a few core fields that are available everywhere. Any object that implements this interface can be queried using the `entity` query and its ID. **/
-type Entity = {
+interface Entity {
   /**
    * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
    * string.
@@ -16,7 +16,7 @@ type Entity = {
 
   /** The typename of the object **/
   typename: string;
-};
+}
 
 export const FRAGMENT = `
 fragment EntityFragment on Entity {

package/src/objects/FeeEstimate.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 object represents the estimated L1 transaction fees for the Bitcoin network. Fee estimates are separated by potential confirmation speeds for settlement. **/
-type FeeEstimate = {
+interface FeeEstimate {
   feeFast: CurrencyAmount;
 
   feeMin: CurrencyAmount;
-};
+}
 
 export const FeeEstimateFromJson = (obj: any): FeeEstimate => {
   return {
@@ -16,6 +19,12 @@ export const FeeEstimateFromJson = (obj: any): FeeEstimate => {
     feeMin: CurrencyAmountFromJson(obj["fee_estimate_fee_min"]),
   } as FeeEstimate;
 };
+export const FeeEstimateToJson = (obj: FeeEstimate): any => {
+  return {
+    fee_estimate_fee_fast: CurrencyAmountToJson(obj.feeFast),
+    fee_estimate_fee_min: CurrencyAmountToJson(obj.feeMin),
+  };
+};
 
 export const FRAGMENT = `
 fragment FeeEstimateFragment on FeeEstimate {

package/src/objects/FundNodeInput.ts

@@ -1,10 +1,10 @@
 // Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
 
-type FundNodeInput = {
+interface FundNodeInput {
   nodeId: string;
 
-  amountSats?: number;
-};
+  amountSats?: number | undefined;
+}
 
 export const FundNodeInputFromJson = (obj: any): FundNodeInput => {
   return {
@@ -12,5 +12,11 @@ export const FundNodeInputFromJson = (obj: any): FundNodeInput => {
     amountSats: obj["fund_node_input_amount_sats"],
   } as FundNodeInput;
 };
+export const FundNodeInputToJson = (obj: FundNodeInput): any => {
+  return {
+    fund_node_input_node_id: obj.nodeId,
+    fund_node_input_amount_sats: obj.amountSats,
+  };
+};
 
 export default FundNodeInput;

package/src/objects/FundNodeOutput.ts

@@ -1,17 +1,25 @@
 // 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 FundNodeOutput = {
+interface FundNodeOutput {
   amount: CurrencyAmount;
-};
+}
 
 export const FundNodeOutputFromJson = (obj: any): FundNodeOutput => {
   return {
     amount: CurrencyAmountFromJson(obj["fund_node_output_amount"]),
   } as FundNodeOutput;
 };
+export const FundNodeOutputToJson = (obj: FundNodeOutput): any => {
+  return {
+    fund_node_output_amount: CurrencyAmountToJson(obj.amount),
+  };
+};
 
 export const FRAGMENT = `
 fragment FundNodeOutputFragment on FundNodeOutput {

package/src/objects/GraphNode.ts

@@ -4,24 +4,53 @@ import { type Query } from "@lightsparkdev/core";
 import autoBind from "auto-bind";
 import type LightsparkClient from "../client.js";
 import BitcoinNetwork from "./BitcoinNetwork.js";
+import type Entity from "./Entity.js";
 import type Node from "./Node.js";
 import type NodeAddressType from "./NodeAddressType.js";
 import type NodeToAddressesConnection from "./NodeToAddressesConnection.js";
 import { NodeToAddressesConnectionFromJson } from "./NodeToAddressesConnection.js";
 
 /** This object represents a node that exists on the Lightning Network, including nodes not managed by Lightspark. You can retrieve this object to get publicly available information about any node on the Lightning Network. **/
-class GraphNode implements Node {
+class GraphNode implements Node, 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 Bitcoin Network this node is deployed in. **/
     public readonly bitcoinNetwork: BitcoinNetwork,
+    /**
+     * The name of this node in the network. It will be the most human-readable option possible, depending
+     * on the data available for this node.
+     **/
     public readonly displayName: string,
+    /** The typename of the object **/
     public readonly typename: string,
-    public readonly alias?: string,
-    public readonly color?: string,
-    public readonly conductivity?: number,
-    public readonly publicKey?: string,
+    /**
+     * A name that identifies the node. It has no importance in terms of operating the node, it is just a
+     * way to identify and search for commercial services or popular nodes. This alias can be changed at
+     * any time by the node operator.
+     **/
+    public readonly alias?: string | undefined,
+    /**
+     * A hexadecimal string that describes a color. For example "#000000" is black, "#FFFFFF" is white. It
+     * has no importance in terms of operating the node, it is just a way to visually differentiate nodes.
+     * That color can be changed at any time by the node operator.
+     **/
+    public readonly color?: string | undefined,
+    /**
+     * A summary metric used to capture how well positioned a node is to send, receive, or route
+     * transactions efficiently. Maximizing a node's conductivity helps a node’s transactions to be
+     * capital efficient. The value is an integer ranging between 0 and 10 (bounds included).
+     **/
+    public readonly conductivity?: number | undefined,
+    /** The public key of this node. It acts as a unique identifier of this node in the Lightning Network. **/
+    public readonly publicKey?: string | undefined,
   ) {
     autoBind(this);
   }
@@ -74,6 +103,21 @@ ${FRAGMENT}
       constructObject: (data: any) => GraphNodeFromJson(data.entity),
     };
   }
+
+  public toJson() {
+    return {
+      __typename: "GraphNode",
+      graph_node_id: this.id,
+      graph_node_created_at: this.createdAt,
+      graph_node_updated_at: this.updatedAt,
+      graph_node_alias: this.alias,
+      graph_node_bitcoin_network: this.bitcoinNetwork,
+      graph_node_color: this.color,
+      graph_node_conductivity: this.conductivity,
+      graph_node_display_name: this.displayName,
+      graph_node_public_key: this.publicKey,
+    };
+  }
 }
 
 export const GraphNodeFromJson = (obj: any): GraphNode => {

package/src/objects/Hop.ts

@@ -2,11 +2,13 @@
 
 import { type Query } from "@lightsparkdev/core";
 import type CurrencyAmount from "./CurrencyAmount.js";
-import { CurrencyAmountFromJson } from "./CurrencyAmount.js";
-import type Entity from "./Entity.js";
+import {
+  CurrencyAmountFromJson,
+  CurrencyAmountToJson,
+} from "./CurrencyAmount.js";
 
 /** This object represents a specific node that existed on a particular payment route. You can retrieve this object to get information about a node on a particular payment path and all payment-relevant information for that node. **/
-type Hop = Entity & {
+interface Hop {
   /**
    * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
    * string.
@@ -26,20 +28,20 @@ type Hop = Entity & {
   typename: string;
 
   /** The destination node of the hop. **/
-  destinationId?: string;
+  destinationId?: string | undefined;
 
   /** The public key of the node to which the hop is bound. **/
-  publicKey?: string;
+  publicKey?: string | undefined;
 
   /** The amount that is to be forwarded to the destination node. **/
-  amountToForward?: CurrencyAmount;
+  amountToForward?: CurrencyAmount | undefined;
 
   /** The fees to be collected by the source node for forwarding the payment over the hop. **/
-  fee?: CurrencyAmount;
+  fee?: CurrencyAmount | undefined;
 
   /** The block height at which an unsettled HTLC is considered expired. **/
-  expiryBlockHeight?: number;
-};
+  expiryBlockHeight?: number | undefined;
+}
 
 export const HopFromJson = (obj: any): Hop => {
   return {
@@ -57,6 +59,22 @@ export const HopFromJson = (obj: any): Hop => {
     expiryBlockHeight: obj["hop_expiry_block_height"],
   } as Hop;
 };
+export const HopToJson = (obj: Hop): any => {
+  return {
+    __typename: "Hop",
+    hop_id: obj.id,
+    hop_created_at: obj.createdAt,
+    hop_updated_at: obj.updatedAt,
+    hop_destination: { id: obj.destinationId } ?? undefined,
+    hop_index: obj.index,
+    hop_public_key: obj.publicKey,
+    hop_amount_to_forward: obj.amountToForward
+      ? CurrencyAmountToJson(obj.amountToForward)
+      : undefined,
+    hop_fee: obj.fee ? CurrencyAmountToJson(obj.fee) : undefined,
+    hop_expiry_block_height: obj.expiryBlockHeight,
+  };
+};
 
 export const FRAGMENT = `
 fragment HopFragment on Hop {

package/src/objects/IdAndSignature.ts

@@ -1,12 +1,12 @@
 // Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
 
-type IdAndSignature = {
+interface IdAndSignature {
   /** The id of the message. **/
   id: string;
 
   /** The signature of the message. **/
   signature: string;
-};
+}
 
 export const IdAndSignatureFromJson = (obj: any): IdAndSignature => {
   return {
@@ -14,5 +14,11 @@ export const IdAndSignatureFromJson = (obj: any): IdAndSignature => {
     signature: obj["id_and_signature_signature"],
   } as IdAndSignature;
 };
+export const IdAndSignatureToJson = (obj: IdAndSignature): any => {
+  return {
+    id_and_signature_id: obj.id,
+    id_and_signature_signature: obj.signature,
+  };
+};
 
 export default IdAndSignature;