@lightsparkdev/lightspark-sdk 0.1.6

package/src/objects/Invoice.ts

@@ -0,0 +1,226 @@
+// 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 InvoiceData, { InvoiceDataFromJson } from "./InvoiceData.js";
+import PaymentRequest from "./PaymentRequest.js";
+import PaymentRequestStatus from "./PaymentRequestStatus.js";
+
+/** This object represents a BOLT #11 invoice (https://github.com/lightning/bolts/blob/master/11-payment-encoding.md) initiated by a Lightspark Node. **/
+type Invoice = PaymentRequest &
+  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 the entity was first created. **/
+    createdAt: string;
+
+    /** The date and time when the entity was last updated. **/
+    updatedAt: string;
+
+    /** The details of the invoice. **/
+    data: InvoiceData;
+
+    /** The status of the payment request. **/
+    status: PaymentRequestStatus;
+
+    /** The typename of the object **/
+    typename: string;
+
+    /** The total amount that has been paid to this invoice. **/
+    amountPaid?: CurrencyAmount;
+  };
+
+export const InvoiceFromJson = (obj: any): Invoice => {
+  return {
+    id: obj["invoice_id"],
+    createdAt: obj["invoice_created_at"],
+    updatedAt: obj["invoice_updated_at"],
+    data: InvoiceDataFromJson(obj["invoice_data"]),
+    status:
+      PaymentRequestStatus[obj["invoice_status"]] ??
+      PaymentRequestStatus.FUTURE_VALUE,
+    typename: "Invoice",
+    amountPaid: !!obj["invoice_amount_paid"]
+      ? CurrencyAmountFromJson(obj["invoice_amount_paid"])
+      : undefined,
+  } as Invoice;
+};
+
+export const FRAGMENT = `
+fragment InvoiceFragment on Invoice {
+    __typename
+    invoice_id: id
+    invoice_created_at: created_at
+    invoice_updated_at: updated_at
+    invoice_data: data {
+        __typename
+        invoice_data_encoded_payment_request: encoded_payment_request
+        invoice_data_bitcoin_network: bitcoin_network
+        invoice_data_payment_hash: payment_hash
+        invoice_data_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
+        }
+        invoice_data_created_at: created_at
+        invoice_data_expires_at: expires_at
+        invoice_data_destination: destination {
+            __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
+            }
+        }
+        invoice_data_memo: memo
+    }
+    invoice_status: status
+    invoice_amount_paid: amount_paid {
+        __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
+    }
+}`;
+
+export const getInvoiceQuery = (id: string): Query<Invoice> => {
+  return {
+    queryPayload: `
+query GetInvoice($id: ID!) {
+    entity(id: $id) {
+        ... on Invoice {
+            ...InvoiceFragment
+        }
+    }
+}
+
+${FRAGMENT}    
+`,
+    variables: { id },
+    constructObject: (data: any) => InvoiceFromJson(data.entity),
+  };
+};
+
+export default Invoice;

package/src/objects/InvoiceData.ts

@@ -0,0 +1,185 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+import BitcoinNetwork from "./BitcoinNetwork.js";
+import CurrencyAmount, { CurrencyAmountFromJson } from "./CurrencyAmount.js";
+import Node, { NodeFromJson } from "./Node.js";
+import PaymentRequestData from "./PaymentRequestData.js";
+
+/** This object represents the BOLT #11 invoice protocol for Lightning Payments. See https://github.com/lightning/bolts/blob/master/11-payment-encoding.md. **/
+type InvoiceData = PaymentRequestData & {
+  encodedPaymentRequest: string;
+
+  bitcoinNetwork: BitcoinNetwork;
+
+  paymentHash: string;
+
+  amount: CurrencyAmount;
+
+  createdAt: string;
+
+  expiresAt: string;
+
+  destination: Node;
+
+  /** The typename of the object **/
+  typename: string;
+
+  memo?: string;
+};
+
+export const InvoiceDataFromJson = (obj: any): InvoiceData => {
+  return {
+    encodedPaymentRequest: obj["invoice_data_encoded_payment_request"],
+    bitcoinNetwork:
+      BitcoinNetwork[obj["invoice_data_bitcoin_network"]] ??
+      BitcoinNetwork.FUTURE_VALUE,
+    paymentHash: obj["invoice_data_payment_hash"],
+    amount: CurrencyAmountFromJson(obj["invoice_data_amount"]),
+    createdAt: obj["invoice_data_created_at"],
+    expiresAt: obj["invoice_data_expires_at"],
+    destination: NodeFromJson(obj["invoice_data_destination"]),
+    typename: "InvoiceData",
+    memo: obj["invoice_data_memo"],
+  } as InvoiceData;
+};
+
+export const FRAGMENT = `
+fragment InvoiceDataFragment on InvoiceData {
+    __typename
+    invoice_data_encoded_payment_request: encoded_payment_request
+    invoice_data_bitcoin_network: bitcoin_network
+    invoice_data_payment_hash: payment_hash
+    invoice_data_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
+    }
+    invoice_data_created_at: created_at
+    invoice_data_expires_at: expires_at
+    invoice_data_destination: destination {
+        __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
+        }
+    }
+    invoice_data_memo: memo
+}`;
+
+export default InvoiceData;

package/src/objects/InvoiceType.ts

@@ -0,0 +1,15 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+export enum InvoiceType {
+  /**
+   * 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",
+  /** A standard Bolt 11 invoice. **/
+  STANDARD = "STANDARD",
+  /** An AMP (Atomic Multi-path Payment) invoice. **/
+  AMP = "AMP",
+}
+
+export default InvoiceType;

package/src/objects/LightningFeeEstimateForInvoiceInput.ts

@@ -0,0 +1,28 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+type LightningFeeEstimateForInvoiceInput = {
+  /** The node from where you want to send the payment. **/
+  nodeId: string;
+
+  /** The invoice you want to pay (as defined by the BOLT11 standard). **/
+  encodedPaymentRequest: string;
+
+  /**
+   * If the invoice does not specify a payment amount, then the amount that you wish to pay, expressed
+   * in msats.
+   **/
+  amountMsats?: number;
+};
+
+export const LightningFeeEstimateForInvoiceInputFromJson = (
+  obj: any
+): LightningFeeEstimateForInvoiceInput => {
+  return {
+    nodeId: obj["lightning_fee_estimate_for_invoice_input_node_id"],
+    encodedPaymentRequest:
+      obj["lightning_fee_estimate_for_invoice_input_encoded_payment_request"],
+    amountMsats: obj["lightning_fee_estimate_for_invoice_input_amount_msats"],
+  } as LightningFeeEstimateForInvoiceInput;
+};
+
+export default LightningFeeEstimateForInvoiceInput;

package/src/objects/LightningFeeEstimateForNodeInput.ts

@@ -0,0 +1,25 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+type LightningFeeEstimateForNodeInput = {
+  /** The node from where you want to send the payment. **/
+  nodeId: string;
+
+  /** The public key of the node that you want to pay. **/
+  destinationNodePublicKey: string;
+
+  /** The payment amount expressed in msats. **/
+  amountMsats: number;
+};
+
+export const LightningFeeEstimateForNodeInputFromJson = (
+  obj: any
+): LightningFeeEstimateForNodeInput => {
+  return {
+    nodeId: obj["lightning_fee_estimate_for_node_input_node_id"],
+    destinationNodePublicKey:
+      obj["lightning_fee_estimate_for_node_input_destination_node_public_key"],
+    amountMsats: obj["lightning_fee_estimate_for_node_input_amount_msats"],
+  } as LightningFeeEstimateForNodeInput;
+};
+
+export default LightningFeeEstimateForNodeInput;

package/src/objects/LightningFeeEstimateOutput.ts

@@ -0,0 +1,33 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+import CurrencyAmount, { CurrencyAmountFromJson } from "./CurrencyAmount.js";
+
+type LightningFeeEstimateOutput = {
+  /** The estimated fees for the payment. **/
+  feeEstimate: CurrencyAmount;
+};
+
+export const LightningFeeEstimateOutputFromJson = (
+  obj: any
+): LightningFeeEstimateOutput => {
+  return {
+    feeEstimate: CurrencyAmountFromJson(
+      obj["lightning_fee_estimate_output_fee_estimate"]
+    ),
+  } as LightningFeeEstimateOutput;
+};
+
+export const FRAGMENT = `
+fragment LightningFeeEstimateOutputFragment on LightningFeeEstimateOutput {
+    __typename
+    lightning_fee_estimate_output_fee_estimate: fee_estimate {
+        __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
+    }
+}`;
+
+export default LightningFeeEstimateOutput;