@lightsparkdev/lightspark-sdk 0.1.6

package/src/objects/ChannelToTransactionsConnection.ts

@@ -0,0 +1,86 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+import CurrencyAmount, { CurrencyAmountFromJson } from "./CurrencyAmount.js";
+
+type ChannelToTransactionsConnection = {
+  /**
+   * The total count of objects in this connection, using the current filters. It is different from the
+   * number of objects returned in the current page (in the `entities` field).
+   **/
+  count: number;
+
+  /**
+   * The average fee for the transactions that transited through this channel, according to the filters
+   * and constraints of the connection.
+   **/
+  averageFee?: CurrencyAmount;
+
+  /**
+   * The total amount transacted for the transactions that transited through this channel, according to
+   * the filters and constraints of the connection.
+   **/
+  totalAmountTransacted?: CurrencyAmount;
+
+  /**
+   * The total amount of fees for the transactions that transited through this channel, according to the
+   * filters and constraints of the connection.
+   **/
+  totalFees?: CurrencyAmount;
+};
+
+export const ChannelToTransactionsConnectionFromJson = (
+  obj: any
+): ChannelToTransactionsConnection => {
+  return {
+    count: obj["channel_to_transactions_connection_count"],
+    averageFee: !!obj["channel_to_transactions_connection_average_fee"]
+      ? CurrencyAmountFromJson(
+          obj["channel_to_transactions_connection_average_fee"]
+        )
+      : undefined,
+    totalAmountTransacted: !!obj[
+      "channel_to_transactions_connection_total_amount_transacted"
+    ]
+      ? CurrencyAmountFromJson(
+          obj["channel_to_transactions_connection_total_amount_transacted"]
+        )
+      : undefined,
+    totalFees: !!obj["channel_to_transactions_connection_total_fees"]
+      ? CurrencyAmountFromJson(
+          obj["channel_to_transactions_connection_total_fees"]
+        )
+      : undefined,
+  } as ChannelToTransactionsConnection;
+};
+
+export const FRAGMENT = `
+fragment ChannelToTransactionsConnectionFragment on ChannelToTransactionsConnection {
+    __typename
+    channel_to_transactions_connection_count: count
+    channel_to_transactions_connection_average_fee: average_fee {
+        __typename
+        currency_amount_original_value: original_value
+        currency_amount_original_unit: original_unit
+        currency_amount_preferred_currency_unit: preferred_currency_unit
+        currency_amount_preferred_currency_value_rounded: preferred_currency_value_rounded
+        currency_amount_preferred_currency_value_approx: preferred_currency_value_approx
+    }
+    channel_to_transactions_connection_total_amount_transacted: total_amount_transacted {
+        __typename
+        currency_amount_original_value: original_value
+        currency_amount_original_unit: original_unit
+        currency_amount_preferred_currency_unit: preferred_currency_unit
+        currency_amount_preferred_currency_value_rounded: preferred_currency_value_rounded
+        currency_amount_preferred_currency_value_approx: preferred_currency_value_approx
+    }
+    channel_to_transactions_connection_total_fees: total_fees {
+        __typename
+        currency_amount_original_value: original_value
+        currency_amount_original_unit: original_unit
+        currency_amount_preferred_currency_unit: preferred_currency_unit
+        currency_amount_preferred_currency_value_rounded: preferred_currency_value_rounded
+        currency_amount_preferred_currency_value_approx: preferred_currency_value_approx
+    }
+}`;
+
+export default ChannelToTransactionsConnection;

package/src/objects/CreateApiTokenInput.ts

@@ -0,0 +1,22 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+import Permission from "./Permission.js";
+
+type CreateApiTokenInput = {
+  /** An arbitrary name that the user can choose to identify the API token in a list. **/
+  name: string;
+
+  /** List of permissions to grant to the API token **/
+  permissions: Permission[];
+};
+
+export const CreateApiTokenInputFromJson = (obj: any): CreateApiTokenInput => {
+  return {
+    name: obj["create_api_token_input_name"],
+    permissions: obj["create_api_token_input_permissions"].map(
+      (e) => Permission[e]
+    ),
+  } as CreateApiTokenInput;
+};
+
+export default CreateApiTokenInput;

package/src/objects/CreateApiTokenOutput.ts

@@ -0,0 +1,41 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+import ApiToken, { ApiTokenFromJson } from "./ApiToken.js";
+
+type CreateApiTokenOutput = {
+  /** The API Token that has been created. **/
+  apiToken: ApiToken;
+
+  /**
+   * The secret that should be used to authenticate against our API. This secret is not stored and will
+   * never be available again after this. You must keep this secret secure as it grants access to your
+   * account.
+   **/
+  clientSecret: string;
+};
+
+export const CreateApiTokenOutputFromJson = (
+  obj: any
+): CreateApiTokenOutput => {
+  return {
+    apiToken: ApiTokenFromJson(obj["create_api_token_output_api_token"]),
+    clientSecret: obj["create_api_token_output_client_secret"],
+  } as CreateApiTokenOutput;
+};
+
+export const FRAGMENT = `
+fragment CreateApiTokenOutputFragment on CreateApiTokenOutput {
+    __typename
+    create_api_token_output_api_token: api_token {
+        __typename
+        api_token_id: id
+        api_token_created_at: created_at
+        api_token_updated_at: updated_at
+        api_token_client_id: client_id
+        api_token_name: name
+        api_token_permissions: permissions
+    }
+    create_api_token_output_client_secret: client_secret
+}`;
+
+export default CreateApiTokenOutput;

package/src/objects/CreateInvoiceInput.ts

@@ -0,0 +1,27 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+import InvoiceType from "./InvoiceType.js";
+
+type CreateInvoiceInput = {
+  nodeId: string;
+
+  amountMsats: number;
+
+  memo?: string;
+
+  invoiceType?: InvoiceType;
+};
+
+export const CreateInvoiceInputFromJson = (obj: any): CreateInvoiceInput => {
+  return {
+    nodeId: obj["create_invoice_input_node_id"],
+    amountMsats: obj["create_invoice_input_amount_msats"],
+    memo: obj["create_invoice_input_memo"],
+    invoiceType: !!obj["create_invoice_input_invoice_type"]
+      ? InvoiceType[obj["create_invoice_input_invoice_type"]] ??
+        InvoiceType.FUTURE_VALUE
+      : null,
+  } as CreateInvoiceInput;
+};
+
+export default CreateInvoiceInput;

package/src/objects/CreateInvoiceOutput.ts

@@ -0,0 +1,21 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+type CreateInvoiceOutput = {
+  invoiceId: string;
+};
+
+export const CreateInvoiceOutputFromJson = (obj: any): CreateInvoiceOutput => {
+  return {
+    invoiceId: obj["create_invoice_output_invoice"].id,
+  } as CreateInvoiceOutput;
+};
+
+export const FRAGMENT = `
+fragment CreateInvoiceOutputFragment on CreateInvoiceOutput {
+    __typename
+    create_invoice_output_invoice: invoice {
+        id
+    }
+}`;
+
+export default CreateInvoiceOutput;

package/src/objects/CreateNodeWalletAddressInput.ts

@@ -0,0 +1,15 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+type CreateNodeWalletAddressInput = {
+  nodeId: string;
+};
+
+export const CreateNodeWalletAddressInputFromJson = (
+  obj: any
+): CreateNodeWalletAddressInput => {
+  return {
+    nodeId: obj["create_node_wallet_address_input_node_id"],
+  } as CreateNodeWalletAddressInput;
+};
+
+export default CreateNodeWalletAddressInput;

package/src/objects/CreateNodeWalletAddressOutput.ts

@@ -0,0 +1,27 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+type CreateNodeWalletAddressOutput = {
+  nodeId: string;
+
+  walletAddress: string;
+};
+
+export const CreateNodeWalletAddressOutputFromJson = (
+  obj: any
+): CreateNodeWalletAddressOutput => {
+  return {
+    nodeId: obj["create_node_wallet_address_output_node"].id,
+    walletAddress: obj["create_node_wallet_address_output_wallet_address"],
+  } as CreateNodeWalletAddressOutput;
+};
+
+export const FRAGMENT = `
+fragment CreateNodeWalletAddressOutputFragment on CreateNodeWalletAddressOutput {
+    __typename
+    create_node_wallet_address_output_node: node {
+        id
+    }
+    create_node_wallet_address_output_wallet_address: wallet_address
+}`;
+
+export default CreateNodeWalletAddressOutput;

package/src/objects/CurrencyAmount.ts

@@ -0,0 +1,55 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+import CurrencyUnit from "./CurrencyUnit.js";
+
+/** Represents the value and unit for an amount of currency. **/
+type CurrencyAmount = {
+  /** The original numeric value for this CurrencyAmount. **/
+  originalValue: number;
+
+  /** The original unit of currency for this CurrencyAmount. **/
+  originalUnit: CurrencyUnit;
+
+  /** The unit of user's preferred currency. **/
+  preferredCurrencyUnit: CurrencyUnit;
+
+  /**
+   * The rounded numeric value for this CurrencyAmount in the very base level of user's preferred
+   * currency. For example, for USD, the value will be in cents.
+   **/
+  preferredCurrencyValueRounded: number;
+
+  /**
+   * The approximate float value for this CurrencyAmount in the very base level of user's preferred
+   * currency. For example, for USD, the value will be in cents.
+   **/
+  preferredCurrencyValueApprox: number;
+};
+
+export const CurrencyAmountFromJson = (obj: any): CurrencyAmount => {
+  return {
+    originalValue: obj["currency_amount_original_value"],
+    originalUnit:
+      CurrencyUnit[obj["currency_amount_original_unit"]] ??
+      CurrencyUnit.FUTURE_VALUE,
+    preferredCurrencyUnit:
+      CurrencyUnit[obj["currency_amount_preferred_currency_unit"]] ??
+      CurrencyUnit.FUTURE_VALUE,
+    preferredCurrencyValueRounded:
+      obj["currency_amount_preferred_currency_value_rounded"],
+    preferredCurrencyValueApprox:
+      obj["currency_amount_preferred_currency_value_approx"],
+  } as CurrencyAmount;
+};
+
+export const FRAGMENT = `
+fragment CurrencyAmountFragment on CurrencyAmount {
+    __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 CurrencyAmount;

package/src/objects/CurrencyUnit.ts

@@ -0,0 +1,25 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+export enum CurrencyUnit {
+  /**
+   * 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",
+  /** Bitcoin is the cryptocurrency native to the Bitcoin network. It is used as the native medium for value transfer for the Lightning Network. **/
+  BITCOIN = "BITCOIN",
+  /** 0.00000001 (10e-8) Bitcoin or one hundred millionth of a Bitcoin. This is the unit most commonly used in Lightning transactions. **/
+  SATOSHI = "SATOSHI",
+  /** 0.001 Satoshi, or 10e-11 Bitcoin. We recommend using the Satoshi unit instead when possible. **/
+  MILLISATOSHI = "MILLISATOSHI",
+  /** United States Dollar. **/
+  USD = "USD",
+  /** 0.000000001 (10e-9) Bitcoin or a billionth of a Bitcoin. We recommend using the Satoshi unit instead when possible. **/
+  NANOBITCOIN = "NANOBITCOIN",
+  /** 0.000001 (10e-6) Bitcoin or a millionth of a Bitcoin. We recommend using the Satoshi unit instead when possible. **/
+  MICROBITCOIN = "MICROBITCOIN",
+  /** 0.001 (10e-3) Bitcoin or a thousandth of a Bitcoin. We recommend using the Satoshi unit instead when possible. **/
+  MILLIBITCOIN = "MILLIBITCOIN",
+}
+
+export default CurrencyUnit;

package/src/objects/DeleteApiTokenInput.ts

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

package/src/objects/DeleteApiTokenOutput.ts

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

package/src/objects/Deposit.ts

@@ -0,0 +1,144 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+import { Query } from "@lightsparkdev/core";
+import CurrencyAmount, { CurrencyAmountFromJson } from "./CurrencyAmount.js";
+import Entity from "./Entity.js";
+import OnChainTransaction from "./OnChainTransaction.js";
+import Transaction from "./Transaction.js";
+import TransactionStatus from "./TransactionStatus.js";
+
+/** The transaction on Bitcoin blockchain to fund the Lightspark node's wallet. **/
+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;
+  };
+
+export const DepositFromJson = (obj: any): Deposit => {
+  return {
+    id: obj["deposit_id"],
+    createdAt: obj["deposit_created_at"],
+    updatedAt: obj["deposit_updated_at"],
+    status:
+      TransactionStatus[obj["deposit_status"]] ??
+      TransactionStatus.FUTURE_VALUE,
+    amount: CurrencyAmountFromJson(obj["deposit_amount"]),
+    blockHeight: obj["deposit_block_height"],
+    destinationAddresses: obj["deposit_destination_addresses"],
+    destinationId: obj["deposit_destination"].id,
+    typename: "Deposit",
+    resolvedAt: obj["deposit_resolved_at"],
+    transactionHash: obj["deposit_transaction_hash"],
+    fees: !!obj["deposit_fees"]
+      ? CurrencyAmountFromJson(obj["deposit_fees"])
+      : undefined,
+    blockHash: obj["deposit_block_hash"],
+    numConfirmations: obj["deposit_num_confirmations"],
+  } as Deposit;
+};
+
+export const FRAGMENT = `
+fragment DepositFragment on Deposit {
+    __typename
+    deposit_id: id
+    deposit_created_at: created_at
+    deposit_updated_at: updated_at
+    deposit_status: status
+    deposit_resolved_at: resolved_at
+    deposit_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
+    }
+    deposit_transaction_hash: transaction_hash
+    deposit_fees: fees {
+        __typename
+        currency_amount_original_value: original_value
+        currency_amount_original_unit: original_unit
+        currency_amount_preferred_currency_unit: preferred_currency_unit
+        currency_amount_preferred_currency_value_rounded: preferred_currency_value_rounded
+        currency_amount_preferred_currency_value_approx: preferred_currency_value_approx
+    }
+    deposit_block_hash: block_hash
+    deposit_block_height: block_height
+    deposit_destination_addresses: destination_addresses
+    deposit_num_confirmations: num_confirmations
+    deposit_destination: destination {
+        id
+    }
+}`;
+
+export const getDepositQuery = (id: string): Query<Deposit> => {
+  return {
+    queryPayload: `
+query GetDeposit($id: ID!) {
+    entity(id: $id) {
+        ... on Deposit {
+            ...DepositFragment
+        }
+    }
+}
+
+${FRAGMENT}    
+`,
+    variables: { id },
+    constructObject: (data: any) => DepositFromJson(data.entity),
+  };
+};
+
+export default Deposit;