@lightsparkdev/lightspark-sdk 0.4.8 → 0.4.10

package/src/objects/ApiToken.ts

@@ -1,9 +1,10 @@
 // Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
 
-import type { Query } from "@lightsparkdev/core";
+import { type Query } from "@lightsparkdev/core";
 import type Entity from "./Entity.js";
 import Permission from "./Permission.js";
 
+/** This is an object representing a Lightspark API token, that can be used to authenticate this account when making API calls or using our SDKs. See the “Authentication” section of our API docs for more details on its usage. **/
 type ApiToken = Entity & {
   /**
    * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque

package/src/objects/Balances.ts

@@ -3,6 +3,7 @@
 import type CurrencyAmount from "./CurrencyAmount.js";
 import { CurrencyAmountFromJson } from "./CurrencyAmount.js";
 
+/** This is an object representing the balance associated with your Lightspark account. You can retrieve this object to see your balance, which can be broken down into several different categorizations. **/
 type Balances = {
   /**
    * This represents the balance that should be displayed when asked "how much do I own right now?". It

package/src/objects/BitcoinNetwork.ts

@@ -1,5 +1,6 @@
 // Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
 
+/** This is an enum identifying a particular Bitcoin Network. **/
 export enum BitcoinNetwork {
   /**
    * This is an enum value that represents values that could be added in the future.
@@ -12,7 +13,7 @@ export enum BitcoinNetwork {
   REGTEST = "REGTEST",
   /** A test version of the Bitcoin Blockchain, maintained by a centralized organization. Not in use at Lightspark. **/
   SIGNET = "SIGNET",
-  /** A test version of the Bitcoin Blockchain, publically available. **/
+  /** A test version of the Bitcoin Blockchain, publicly available. **/
   TESTNET = "TESTNET",
 }
 

package/src/objects/BlockchainBalance.ts

@@ -3,7 +3,7 @@
 import type CurrencyAmount from "./CurrencyAmount.js";
 import { CurrencyAmountFromJson } from "./CurrencyAmount.js";
 
-/** This object provides a detailed breakdown of a `LightsparkNode`'s current balance on the Bitcoin Network. **/
+/** This is an object representing a detailed breakdown of the balance for a Lightspark Node. **/
 type BlockchainBalance = {
   /** The total wallet balance, including unconfirmed UTXOs. **/
   totalBalance?: CurrencyAmount;

package/src/objects/Channel.ts

@@ -1,6 +1,6 @@
 // Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
 
-import type { Query } from "@lightsparkdev/core";
+import { type Query } from "@lightsparkdev/core";
 import autoBind from "auto-bind";
 import type LightsparkClient from "../client.js";
 import type ChannelFees from "./ChannelFees.js";
@@ -13,7 +13,7 @@ import { CurrencyAmountFromJson } from "./CurrencyAmount.js";
 import type Entity from "./Entity.js";
 import type TransactionType from "./TransactionType.js";
 
-/** An object that represents a payment channel between two nodes in the Lightning Network. **/
+/** 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(
     public readonly id: string,

package/src/objects/ChannelClosingTransaction.ts

@@ -1,6 +1,6 @@
 // Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
 
-import type { Query } from "@lightsparkdev/core";
+import { type Query } from "@lightsparkdev/core";
 import type CurrencyAmount from "./CurrencyAmount.js";
 import { CurrencyAmountFromJson } from "./CurrencyAmount.js";
 import type Entity from "./Entity.js";
@@ -8,7 +8,7 @@ import type OnChainTransaction from "./OnChainTransaction.js";
 import type Transaction from "./Transaction.js";
 import TransactionStatus from "./TransactionStatus.js";
 
-/** The transaction on Bitcoin blockchain to close a channel on Lightning Network where the balances are allocated back to local and remote nodes. **/
+/** 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 & {

package/src/objects/ChannelFees.ts

@@ -3,6 +3,7 @@
 import type CurrencyAmount from "./CurrencyAmount.js";
 import { CurrencyAmountFromJson } from "./CurrencyAmount.js";
 
+/** This represents the fee policies set for a channel on the Lightning Network. **/
 type ChannelFees = {
   baseFee?: CurrencyAmount;
 

package/src/objects/ChannelOpeningTransaction.ts

@@ -1,6 +1,6 @@
 // Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
 
-import type { Query } from "@lightsparkdev/core";
+import { type Query } from "@lightsparkdev/core";
 import type CurrencyAmount from "./CurrencyAmount.js";
 import { CurrencyAmountFromJson } from "./CurrencyAmount.js";
 import type Entity from "./Entity.js";
@@ -8,7 +8,7 @@ import type OnChainTransaction from "./OnChainTransaction.js";
 import type Transaction from "./Transaction.js";
 import TransactionStatus from "./TransactionStatus.js";
 
-/** The transaction on Bitcoin blockchain to open a channel on Lightning Network funded by the local Lightspark node. **/
+/** 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 & {

package/src/objects/ChannelStatus.ts

@@ -1,5 +1,6 @@
 // Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
 
+/** This is an enum representing the status of a channel on the Lightning Network. **/
 export enum ChannelStatus {
   /**
    * This is an enum value that represents values that could be added in the future.

package/src/objects/Connection.ts

@@ -0,0 +1,387 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+import { LightsparkException } from "@lightsparkdev/core";
+import type AccountToApiTokensConnection from "./AccountToApiTokensConnection.js";
+import type AccountToNodesConnection from "./AccountToNodesConnection.js";
+import type AccountToPaymentRequestsConnection from "./AccountToPaymentRequestsConnection.js";
+import type AccountToTransactionsConnection from "./AccountToTransactionsConnection.js";
+import type AccountToWalletsConnection from "./AccountToWalletsConnection.js";
+import { ApiTokenFromJson } from "./ApiToken.js";
+import { ChannelFromJson } from "./Channel.js";
+import { CurrencyAmountFromJson } from "./CurrencyAmount.js";
+import { HopFromJson } from "./Hop.js";
+import { IncomingPaymentAttemptFromJson } from "./IncomingPaymentAttempt.js";
+import type IncomingPaymentToAttemptsConnection from "./IncomingPaymentToAttemptsConnection.js";
+import { LightsparkNodeFromJson } from "./LightsparkNode.js";
+import LightsparkNodePurpose from "./LightsparkNodePurpose.js";
+import type LightsparkNodeToChannelsConnection from "./LightsparkNodeToChannelsConnection.js";
+import { OutgoingPaymentAttemptFromJson } from "./OutgoingPaymentAttempt.js";
+import type OutgoingPaymentAttemptToHopsConnection from "./OutgoingPaymentAttemptToHopsConnection.js";
+import type OutgoingPaymentToAttemptsConnection from "./OutgoingPaymentToAttemptsConnection.js";
+import type PageInfo from "./PageInfo.js";
+import { PageInfoFromJson } from "./PageInfo.js";
+import { PaymentRequestFromJson } from "./PaymentRequest.js";
+import { TransactionFromJson } from "./Transaction.js";
+import { WalletFromJson } from "./Wallet.js";
+import type WalletToPaymentRequestsConnection from "./WalletToPaymentRequestsConnection.js";
+import type WalletToTransactionsConnection from "./WalletToTransactionsConnection.js";
+
+type Connection = {
+  /**
+   * 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;
+
+  /** An object that holds pagination information about the objects in this connection. **/
+  pageInfo: PageInfo;
+
+  /** The typename of the object **/
+  typename: string;
+};
+
+export const ConnectionFromJson = (obj: any): Connection => {
+  if (obj["__typename"] == "AccountToApiTokensConnection") {
+    return {
+      count: obj["account_to_api_tokens_connection_count"],
+      pageInfo: PageInfoFromJson(
+        obj["account_to_api_tokens_connection_page_info"]
+      ),
+      entities: obj["account_to_api_tokens_connection_entities"].map((e) =>
+        ApiTokenFromJson(e)
+      ),
+      typename: "AccountToApiTokensConnection",
+    } as AccountToApiTokensConnection;
+  }
+  if (obj["__typename"] == "AccountToNodesConnection") {
+    return {
+      count: obj["account_to_nodes_connection_count"],
+      pageInfo: PageInfoFromJson(obj["account_to_nodes_connection_page_info"]),
+      entities: obj["account_to_nodes_connection_entities"].map((e) =>
+        LightsparkNodeFromJson(e)
+      ),
+      typename: "AccountToNodesConnection",
+      purpose: !!obj["account_to_nodes_connection_purpose"]
+        ? LightsparkNodePurpose[obj["account_to_nodes_connection_purpose"]] ??
+          LightsparkNodePurpose.FUTURE_VALUE
+        : null,
+    } as AccountToNodesConnection;
+  }
+  if (obj["__typename"] == "AccountToPaymentRequestsConnection") {
+    return {
+      count: obj["account_to_payment_requests_connection_count"],
+      pageInfo: PageInfoFromJson(
+        obj["account_to_payment_requests_connection_page_info"]
+      ),
+      entities: obj["account_to_payment_requests_connection_entities"].map(
+        (e) => PaymentRequestFromJson(e)
+      ),
+      typename: "AccountToPaymentRequestsConnection",
+    } as AccountToPaymentRequestsConnection;
+  }
+  if (obj["__typename"] == "AccountToTransactionsConnection") {
+    return {
+      count: obj["account_to_transactions_connection_count"],
+      pageInfo: PageInfoFromJson(
+        obj["account_to_transactions_connection_page_info"]
+      ),
+      entities: obj["account_to_transactions_connection_entities"].map((e) =>
+        TransactionFromJson(e)
+      ),
+      typename: "AccountToTransactionsConnection",
+      profitLoss: !!obj["account_to_transactions_connection_profit_loss"]
+        ? CurrencyAmountFromJson(
+            obj["account_to_transactions_connection_profit_loss"]
+          )
+        : undefined,
+      averageFeeEarned: !!obj[
+        "account_to_transactions_connection_average_fee_earned"
+      ]
+        ? CurrencyAmountFromJson(
+            obj["account_to_transactions_connection_average_fee_earned"]
+          )
+        : undefined,
+      totalAmountTransacted: !!obj[
+        "account_to_transactions_connection_total_amount_transacted"
+      ]
+        ? CurrencyAmountFromJson(
+            obj["account_to_transactions_connection_total_amount_transacted"]
+          )
+        : undefined,
+    } as AccountToTransactionsConnection;
+  }
+  if (obj["__typename"] == "AccountToWalletsConnection") {
+    return {
+      count: obj["account_to_wallets_connection_count"],
+      pageInfo: PageInfoFromJson(
+        obj["account_to_wallets_connection_page_info"]
+      ),
+      entities: obj["account_to_wallets_connection_entities"].map((e) =>
+        WalletFromJson(e)
+      ),
+      typename: "AccountToWalletsConnection",
+    } as AccountToWalletsConnection;
+  }
+  if (obj["__typename"] == "IncomingPaymentToAttemptsConnection") {
+    return {
+      count: obj["incoming_payment_to_attempts_connection_count"],
+      pageInfo: PageInfoFromJson(
+        obj["incoming_payment_to_attempts_connection_page_info"]
+      ),
+      entities: obj["incoming_payment_to_attempts_connection_entities"].map(
+        (e) => IncomingPaymentAttemptFromJson(e)
+      ),
+      typename: "IncomingPaymentToAttemptsConnection",
+    } as IncomingPaymentToAttemptsConnection;
+  }
+  if (obj["__typename"] == "LightsparkNodeToChannelsConnection") {
+    return {
+      count: obj["lightspark_node_to_channels_connection_count"],
+      pageInfo: PageInfoFromJson(
+        obj["lightspark_node_to_channels_connection_page_info"]
+      ),
+      entities: obj["lightspark_node_to_channels_connection_entities"].map(
+        (e) => ChannelFromJson(e)
+      ),
+      typename: "LightsparkNodeToChannelsConnection",
+    } as LightsparkNodeToChannelsConnection;
+  }
+  if (obj["__typename"] == "OutgoingPaymentAttemptToHopsConnection") {
+    return {
+      count: obj["outgoing_payment_attempt_to_hops_connection_count"],
+      pageInfo: PageInfoFromJson(
+        obj["outgoing_payment_attempt_to_hops_connection_page_info"]
+      ),
+      entities: obj["outgoing_payment_attempt_to_hops_connection_entities"].map(
+        (e) => HopFromJson(e)
+      ),
+      typename: "OutgoingPaymentAttemptToHopsConnection",
+    } as OutgoingPaymentAttemptToHopsConnection;
+  }
+  if (obj["__typename"] == "OutgoingPaymentToAttemptsConnection") {
+    return {
+      count: obj["outgoing_payment_to_attempts_connection_count"],
+      pageInfo: PageInfoFromJson(
+        obj["outgoing_payment_to_attempts_connection_page_info"]
+      ),
+      entities: obj["outgoing_payment_to_attempts_connection_entities"].map(
+        (e) => OutgoingPaymentAttemptFromJson(e)
+      ),
+      typename: "OutgoingPaymentToAttemptsConnection",
+    } as OutgoingPaymentToAttemptsConnection;
+  }
+  if (obj["__typename"] == "WalletToPaymentRequestsConnection") {
+    return {
+      count: obj["wallet_to_payment_requests_connection_count"],
+      pageInfo: PageInfoFromJson(
+        obj["wallet_to_payment_requests_connection_page_info"]
+      ),
+      entities: obj["wallet_to_payment_requests_connection_entities"].map((e) =>
+        PaymentRequestFromJson(e)
+      ),
+      typename: "WalletToPaymentRequestsConnection",
+    } as WalletToPaymentRequestsConnection;
+  }
+  if (obj["__typename"] == "WalletToTransactionsConnection") {
+    return {
+      count: obj["wallet_to_transactions_connection_count"],
+      pageInfo: PageInfoFromJson(
+        obj["wallet_to_transactions_connection_page_info"]
+      ),
+      entities: obj["wallet_to_transactions_connection_entities"].map((e) =>
+        TransactionFromJson(e)
+      ),
+      typename: "WalletToTransactionsConnection",
+    } as WalletToTransactionsConnection;
+  }
+  throw new LightsparkException(
+    "DeserializationError",
+    `Couldn't find a concrete type for interface Connection corresponding to the typename=${obj["__typename"]}`
+  );
+};
+
+export const FRAGMENT = `
+fragment ConnectionFragment on Connection {
+    __typename
+    ... on AccountToApiTokensConnection {
+        __typename
+        account_to_api_tokens_connection_count: count
+        account_to_api_tokens_connection_page_info: page_info {
+            __typename
+            page_info_has_next_page: has_next_page
+            page_info_has_previous_page: has_previous_page
+            page_info_start_cursor: start_cursor
+            page_info_end_cursor: end_cursor
+        }
+        account_to_api_tokens_connection_entities: entities {
+            id
+        }
+    }
+    ... on AccountToNodesConnection {
+        __typename
+        account_to_nodes_connection_count: count
+        account_to_nodes_connection_page_info: page_info {
+            __typename
+            page_info_has_next_page: has_next_page
+            page_info_has_previous_page: has_previous_page
+            page_info_start_cursor: start_cursor
+            page_info_end_cursor: end_cursor
+        }
+        account_to_nodes_connection_purpose: purpose
+        account_to_nodes_connection_entities: entities {
+            id
+        }
+    }
+    ... on AccountToPaymentRequestsConnection {
+        __typename
+        account_to_payment_requests_connection_count: count
+        account_to_payment_requests_connection_page_info: page_info {
+            __typename
+            page_info_has_next_page: has_next_page
+            page_info_has_previous_page: has_previous_page
+            page_info_start_cursor: start_cursor
+            page_info_end_cursor: end_cursor
+        }
+        account_to_payment_requests_connection_entities: entities {
+            id
+        }
+    }
+    ... on AccountToTransactionsConnection {
+        __typename
+        account_to_transactions_connection_count: count
+        account_to_transactions_connection_page_info: page_info {
+            __typename
+            page_info_has_next_page: has_next_page
+            page_info_has_previous_page: has_previous_page
+            page_info_start_cursor: start_cursor
+            page_info_end_cursor: end_cursor
+        }
+        account_to_transactions_connection_profit_loss: profit_loss {
+            __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
+        }
+        account_to_transactions_connection_average_fee_earned: average_fee_earned {
+            __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
+        }
+        account_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
+        }
+        account_to_transactions_connection_entities: entities {
+            id
+        }
+    }
+    ... on AccountToWalletsConnection {
+        __typename
+        account_to_wallets_connection_count: count
+        account_to_wallets_connection_page_info: page_info {
+            __typename
+            page_info_has_next_page: has_next_page
+            page_info_has_previous_page: has_previous_page
+            page_info_start_cursor: start_cursor
+            page_info_end_cursor: end_cursor
+        }
+        account_to_wallets_connection_entities: entities {
+            id
+        }
+    }
+    ... on IncomingPaymentToAttemptsConnection {
+        __typename
+        incoming_payment_to_attempts_connection_count: count
+        incoming_payment_to_attempts_connection_page_info: page_info {
+            __typename
+            page_info_has_next_page: has_next_page
+            page_info_has_previous_page: has_previous_page
+            page_info_start_cursor: start_cursor
+            page_info_end_cursor: end_cursor
+        }
+        incoming_payment_to_attempts_connection_entities: entities {
+            id
+        }
+    }
+    ... on LightsparkNodeToChannelsConnection {
+        __typename
+        lightspark_node_to_channels_connection_count: count
+        lightspark_node_to_channels_connection_page_info: page_info {
+            __typename
+            page_info_has_next_page: has_next_page
+            page_info_has_previous_page: has_previous_page
+            page_info_start_cursor: start_cursor
+            page_info_end_cursor: end_cursor
+        }
+        lightspark_node_to_channels_connection_entities: entities {
+            id
+        }
+    }
+    ... on OutgoingPaymentAttemptToHopsConnection {
+        __typename
+        outgoing_payment_attempt_to_hops_connection_count: count
+        outgoing_payment_attempt_to_hops_connection_page_info: page_info {
+            __typename
+            page_info_has_next_page: has_next_page
+            page_info_has_previous_page: has_previous_page
+            page_info_start_cursor: start_cursor
+            page_info_end_cursor: end_cursor
+        }
+        outgoing_payment_attempt_to_hops_connection_entities: entities {
+            id
+        }
+    }
+    ... on OutgoingPaymentToAttemptsConnection {
+        __typename
+        outgoing_payment_to_attempts_connection_count: count
+        outgoing_payment_to_attempts_connection_page_info: page_info {
+            __typename
+            page_info_has_next_page: has_next_page
+            page_info_has_previous_page: has_previous_page
+            page_info_start_cursor: start_cursor
+            page_info_end_cursor: end_cursor
+        }
+        outgoing_payment_to_attempts_connection_entities: entities {
+            id
+        }
+    }
+    ... on WalletToPaymentRequestsConnection {
+        __typename
+        wallet_to_payment_requests_connection_count: count
+        wallet_to_payment_requests_connection_page_info: page_info {
+            __typename
+            page_info_has_next_page: has_next_page
+            page_info_has_previous_page: has_previous_page
+            page_info_start_cursor: start_cursor
+            page_info_end_cursor: end_cursor
+        }
+        wallet_to_payment_requests_connection_entities: entities {
+            id
+        }
+    }
+    ... on WalletToTransactionsConnection {
+        __typename
+        wallet_to_transactions_connection_count: count
+        wallet_to_transactions_connection_page_info: page_info {
+            __typename
+            page_info_has_next_page: has_next_page
+            page_info_has_previous_page: has_previous_page
+            page_info_start_cursor: start_cursor
+            page_info_end_cursor: end_cursor
+        }
+        wallet_to_transactions_connection_entities: entities {
+            id
+        }
+    }
+}`;
+
+export default Connection;

package/src/objects/CreateInvoiceInput.ts

@@ -3,13 +3,22 @@
 import InvoiceType from "./InvoiceType.js";
 
 type CreateInvoiceInput = {
+  /** The node from which to create the invoice. **/
   nodeId: string;
 
+  /** The amount for which the invoice should be created, in millisatoshis. **/
   amountMsats: number;
 
   memo?: string;
 
   invoiceType?: InvoiceType;
+
+  /** The expiry of the invoice in seconds. Default value is 86400 (1 day). **/
+  expirySecs?: number;
+
+  paymentHash?: string;
+
+  preimageNonce?: string;
 };
 
 export const CreateInvoiceInputFromJson = (obj: any): CreateInvoiceInput => {
@@ -21,6 +30,9 @@ export const CreateInvoiceInputFromJson = (obj: any): CreateInvoiceInput => {
       ? InvoiceType[obj["create_invoice_input_invoice_type"]] ??
         InvoiceType.FUTURE_VALUE
       : null,
+    expirySecs: obj["create_invoice_input_expiry_secs"],
+    paymentHash: obj["create_invoice_input_payment_hash"],
+    preimageNonce: obj["create_invoice_input_preimage_nonce"],
   } as CreateInvoiceInput;
 };
 

package/src/objects/CreateLnurlInvoiceInput.ts

@@ -12,6 +12,13 @@ type CreateLnurlInvoiceInput = {
    * payment) of the resulting Bolt 11 invoice.
    **/
   metadataHash: string;
+
+  /** The expiry of the invoice in seconds. Default value is 86400 (1 day). **/
+  expirySecs?: number;
+
+  paymentHash?: string;
+
+  preimageNonce?: string;
 };
 
 export const CreateLnurlInvoiceInputFromJson = (
@@ -21,6 +28,9 @@ export const CreateLnurlInvoiceInputFromJson = (
     nodeId: obj["create_lnurl_invoice_input_node_id"],
     amountMsats: obj["create_lnurl_invoice_input_amount_msats"],
     metadataHash: obj["create_lnurl_invoice_input_metadata_hash"],
+    expirySecs: obj["create_lnurl_invoice_input_expiry_secs"],
+    paymentHash: obj["create_lnurl_invoice_input_payment_hash"],
+    preimageNonce: obj["create_lnurl_invoice_input_preimage_nonce"],
   } as CreateLnurlInvoiceInput;
 };
 

package/src/objects/CreateTestModePaymentoutput.ts

@@ -1,5 +1,6 @@
 // Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
 
+/** This is an object identifying the output of a test mode payment. This object can be used to retrieve the associated payment made from a Test Mode Payment call. **/
 type CreateTestModePaymentoutput = {
   /** The payment that has been sent. **/
   paymentId: string;

package/src/objects/CryptoSanctionsScreeningProvider.ts

@@ -0,0 +1,14 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+/** This is an enum identifying a type of crypto sanctions screening provider. **/
+export enum CryptoSanctionsScreeningProvider {
+  /**
+   * 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",
+
+  CHAINALYSIS = "CHAINALYSIS",
+}
+
+export default CryptoSanctionsScreeningProvider;

package/src/objects/CurrencyAmount.ts

@@ -2,7 +2,7 @@
 
 import CurrencyUnit from "./CurrencyUnit.js";
 
-/** Represents the value and unit for an amount of currency. **/
+/** This object represents the value and unit for an amount of currency. **/
 type CurrencyAmount = {
   /** The original numeric value for this CurrencyAmount. **/
   originalValue: number;

package/src/objects/CurrencyUnit.ts

@@ -1,5 +1,6 @@
 // Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
 
+/** This enum identifies the unit of currency associated with a CurrencyAmount. **/
 export enum CurrencyUnit {
   /**
    * This is an enum value that represents values that could be added in the future.

package/src/objects/Deposit.ts

@@ -1,6 +1,6 @@
 // Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
 
-import type { Query } from "@lightsparkdev/core";
+import { type Query } from "@lightsparkdev/core";
 import type CurrencyAmount from "./CurrencyAmount.js";
 import { CurrencyAmountFromJson } from "./CurrencyAmount.js";
 import type Entity from "./Entity.js";
@@ -8,7 +8,7 @@ import type OnChainTransaction from "./OnChainTransaction.js";
 import type Transaction from "./Transaction.js";
 import TransactionStatus from "./TransactionStatus.js";
 
-/** The transaction on Bitcoin blockchain to fund the Lightspark node's wallet. **/
+/** 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 & {

package/src/objects/Entity.ts

@@ -1,6 +1,6 @@
 // Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
 
-/** This interface is used by all the entities in the Lightspark systems. 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. **/
+/** 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 = {
   /**
    * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque

package/src/objects/FeeEstimate.ts

@@ -3,6 +3,7 @@
 import type CurrencyAmount from "./CurrencyAmount.js";
 import { CurrencyAmountFromJson } 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 = {
   feeFast: CurrencyAmount;
 

package/src/objects/GraphNode.ts

@@ -1,6 +1,6 @@
 // Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
 
-import type { Query } from "@lightsparkdev/core";
+import { type Query } from "@lightsparkdev/core";
 import autoBind from "auto-bind";
 import type LightsparkClient from "../client.js";
 import BitcoinNetwork from "./BitcoinNetwork.js";
@@ -9,7 +9,7 @@ import type NodeAddressType from "./NodeAddressType.js";
 import type NodeToAddressesConnection from "./NodeToAddressesConnection.js";
 import { NodeToAddressesConnectionFromJson } from "./NodeToAddressesConnection.js";
 
-/** This is a node on the Lightning Network, managed by a third party. The information about this node is public data that has been obtained by observing the Lightning Network. **/
+/** 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 {
   constructor(
     public readonly id: string,