@lightsparkdev/lightspark-sdk 0.1.6

package/src/objects/PaymentFailureReason.ts

@@ -0,0 +1,29 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+export enum PaymentFailureReason {
+  /**
+   * 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",
+
+  NONE = "NONE",
+
+  TIMEOUT = "TIMEOUT",
+
+  NO_ROUTE = "NO_ROUTE",
+
+  ERROR = "ERROR",
+
+  INCORRECT_PAYMENT_DETAILS = "INCORRECT_PAYMENT_DETAILS",
+
+  INSUFFICIENT_BALANCE = "INSUFFICIENT_BALANCE",
+
+  INVOICE_ALREADY_PAID = "INVOICE_ALREADY_PAID",
+
+  SELF_PAYMENT = "SELF_PAYMENT",
+
+  INVOICE_EXPIRED = "INVOICE_EXPIRED",
+}
+
+export default PaymentFailureReason;

package/src/objects/PaymentRequest.ts

@@ -0,0 +1,231 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+import { LightsparkException, Query } from "@lightsparkdev/core";
+import { CurrencyAmountFromJson } from "./CurrencyAmount.js";
+import Entity from "./Entity.js";
+import Invoice from "./Invoice.js";
+import { InvoiceDataFromJson } from "./InvoiceData.js";
+import PaymentRequestData from "./PaymentRequestData.js";
+import PaymentRequestStatus from "./PaymentRequestStatus.js";
+
+type 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 payment request. **/
+  data: PaymentRequestData;
+
+  /** The status of the payment request. **/
+  status: PaymentRequestStatus;
+
+  /** The typename of the object **/
+  typename: string;
+};
+
+export const PaymentRequestFromJson = (obj: any): PaymentRequest => {
+  if (obj["__typename"] == "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;
+  }
+  throw new LightsparkException(
+    "DeserializationError",
+    `Couldn't find a concrete type for interface PaymentRequest corresponding to the typename=${obj["__typename"]}`
+  );
+};
+
+export const FRAGMENT = `
+fragment PaymentRequestFragment on PaymentRequest {
+    __typename
+    ... 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 getPaymentRequestQuery = (id: string): Query<PaymentRequest> => {
+  return {
+    queryPayload: `
+query GetPaymentRequest($id: ID!) {
+    entity(id: $id) {
+        ... on PaymentRequest {
+            ...PaymentRequestFragment
+        }
+    }
+}
+
+${FRAGMENT}    
+`,
+    variables: { id },
+    constructObject: (data: any) => PaymentRequestFromJson(data.entity),
+  };
+};
+
+export default PaymentRequest;

package/src/objects/PaymentRequestData.ts

@@ -0,0 +1,183 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+import { LightsparkException } from "@lightsparkdev/core";
+import BitcoinNetwork from "./BitcoinNetwork.js";
+import { CurrencyAmountFromJson } from "./CurrencyAmount.js";
+import InvoiceData from "./InvoiceData.js";
+import { NodeFromJson } from "./Node.js";
+
+/** The interface of a payment request on the Lightning Network (a.k.a. Lightning Invoice). **/
+type PaymentRequestData = {
+  encodedPaymentRequest: string;
+
+  bitcoinNetwork: BitcoinNetwork;
+
+  /** The typename of the object **/
+  typename: string;
+};
+
+export const PaymentRequestDataFromJson = (obj: any): PaymentRequestData => {
+  if (obj["__typename"] == "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;
+  }
+  throw new LightsparkException(
+    "DeserializationError",
+    `Couldn't find a concrete type for interface PaymentRequestData corresponding to the typename=${obj["__typename"]}`
+  );
+};
+
+export const FRAGMENT = `
+fragment PaymentRequestDataFragment on PaymentRequestData {
+    __typename
+    ... 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 PaymentRequestData;

package/src/objects/PaymentRequestStatus.ts

@@ -0,0 +1,15 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+export enum PaymentRequestStatus {
+  /**
+   * 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",
+
+  OPEN = "OPEN",
+
+  CLOSED = "CLOSED",
+}
+
+export default PaymentRequestStatus;

package/src/objects/Permission.ts

@@ -0,0 +1,39 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+export enum Permission {
+  /**
+   * 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",
+
+  ALL = "ALL",
+
+  MAINNET_VIEW = "MAINNET_VIEW",
+
+  MAINNET_TRANSACT = "MAINNET_TRANSACT",
+
+  MAINNET_MANAGE = "MAINNET_MANAGE",
+
+  TESTNET_VIEW = "TESTNET_VIEW",
+
+  TESTNET_TRANSACT = "TESTNET_TRANSACT",
+
+  TESTNET_MANAGE = "TESTNET_MANAGE",
+
+  REGTEST_VIEW = "REGTEST_VIEW",
+
+  REGTEST_TRANSACT = "REGTEST_TRANSACT",
+
+  REGTEST_MANAGE = "REGTEST_MANAGE",
+
+  USER_VIEW = "USER_VIEW",
+
+  USER_MANAGE = "USER_MANAGE",
+
+  ACCOUNT_VIEW = "ACCOUNT_VIEW",
+
+  ACCOUNT_MANAGE = "ACCOUNT_MANAGE",
+}
+
+export default Permission;

package/src/objects/RequestWithdrawalInput.ts

@@ -0,0 +1,35 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+import WithdrawalMode from "./WithdrawalMode.js";
+
+type RequestWithdrawalInput = {
+  /** The node from which you'd like to make the withdrawal. **/
+  nodeId: string;
+
+  /** The bitcoin address where the withdrawal should be sent. **/
+  bitcoinAddress: string;
+
+  /**
+   * The amount you want to withdraw from this node in Satoshis. Use the special value -1 to withdrawal
+   * all funds from this node.
+   **/
+  amountSats: number;
+
+  /** The strategy that should be used to withdraw the funds from this node. **/
+  withdrawalMode: WithdrawalMode;
+};
+
+export const RequestWithdrawalInputFromJson = (
+  obj: any
+): RequestWithdrawalInput => {
+  return {
+    nodeId: obj["request_withdrawal_input_node_id"],
+    bitcoinAddress: obj["request_withdrawal_input_bitcoin_address"],
+    amountSats: obj["request_withdrawal_input_amount_sats"],
+    withdrawalMode:
+      WithdrawalMode[obj["request_withdrawal_input_withdrawal_mode"]] ??
+      WithdrawalMode.FUTURE_VALUE,
+  } as RequestWithdrawalInput;
+};
+
+export default RequestWithdrawalInput;

package/src/objects/RequestWithdrawalOutput.ts

@@ -0,0 +1,24 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+type RequestWithdrawalOutput = {
+  /** The request that is created for this withdrawal. **/
+  requestId: string;
+};
+
+export const RequestWithdrawalOutputFromJson = (
+  obj: any
+): RequestWithdrawalOutput => {
+  return {
+    requestId: obj["request_withdrawal_output_request"].id,
+  } as RequestWithdrawalOutput;
+};
+
+export const FRAGMENT = `
+fragment RequestWithdrawalOutputFragment on RequestWithdrawalOutput {
+    __typename
+    request_withdrawal_output_request: request {
+        id
+    }
+}`;
+
+export default RequestWithdrawalOutput;

package/src/objects/RichText.ts

@@ -0,0 +1,19 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+type RichText = {
+  text: string;
+};
+
+export const RichTextFromJson = (obj: any): RichText => {
+  return {
+    text: obj["rich_text_text"],
+  } as RichText;
+};
+
+export const FRAGMENT = `
+fragment RichTextFragment on RichText {
+    __typename
+    rich_text_text: text
+}`;
+
+export default RichText;