@lightsparkdev/lightspark-sdk 0.4.9 → 0.4.11

package/src/objects/RoutingTransaction.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";
@@ -11,7 +11,7 @@ import RoutingTransactionFailureReason from "./RoutingTransactionFailureReason.j
 import type Transaction from "./Transaction.js";
 import TransactionStatus from "./TransactionStatus.js";
 
-/** A transaction that was forwarded through a Lightspark node on the Lightning Network. **/
+/** This object represents a transaction that was forwarded through a Lightspark node on the Lightning Network, i.e., a routed transaction. You can retrieve this object to receive information about any transaction routed through your Lightspark Node. **/
 type RoutingTransaction = LightningTransaction &
   Transaction &
   Entity & {
@@ -130,7 +130,7 @@ fragment RoutingTransactionFragment on RoutingTransaction {
 }`;
 
 export const getRoutingTransactionQuery = (
-  id: string
+  id: string,
 ): Query<RoutingTransaction> => {
   return {
     queryPayload: `

package/src/objects/RoutingTransactionFailureReason.ts

@@ -1,5 +1,6 @@
 // Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
 
+/** This is an enum of the potential reasons that an attempted routed transaction through a Lightspark node may have failed. **/
 export enum RoutingTransactionFailureReason {
   /**
    * This is an enum value that represents values that could be added in the future.

package/src/objects/ScreenBitcoinAddressesInput.ts

@@ -0,0 +1,23 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+import CryptoSanctionsScreeningProvider from "./CryptoSanctionsScreeningProvider.js";
+
+type ScreenBitcoinAddressesInput = {
+  provider: CryptoSanctionsScreeningProvider;
+
+  addresses: string[];
+};
+
+export const ScreenBitcoinAddressesInputFromJson = (
+  obj: any,
+): ScreenBitcoinAddressesInput => {
+  return {
+    provider:
+      CryptoSanctionsScreeningProvider[
+        obj["screen_bitcoin_addresses_input_provider"]
+      ] ?? CryptoSanctionsScreeningProvider.FUTURE_VALUE,
+    addresses: obj["screen_bitcoin_addresses_input_addresses"],
+  } as ScreenBitcoinAddressesInput;
+};
+
+export default ScreenBitcoinAddressesInput;

package/src/objects/ScreenBitcoinAddressesOutput.ts

@@ -0,0 +1,25 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+import RiskRating from "./RiskRating.js";
+
+type ScreenBitcoinAddressesOutput = {
+  ratings: RiskRating[];
+};
+
+export const ScreenBitcoinAddressesOutputFromJson = (
+  obj: any,
+): ScreenBitcoinAddressesOutput => {
+  return {
+    ratings: obj["screen_bitcoin_addresses_output_ratings"].map(
+      (e) => RiskRating[e],
+    ),
+  } as ScreenBitcoinAddressesOutput;
+};
+
+export const FRAGMENT = `
+fragment ScreenBitcoinAddressesOutputFragment on ScreenBitcoinAddressesOutput {
+    __typename
+    screen_bitcoin_addresses_output_ratings: ratings
+}`;
+
+export default ScreenBitcoinAddressesOutput;

package/src/objects/Transaction.ts

@@ -1,7 +1,6 @@
 // Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
 
-import type { Query } from "@lightsparkdev/core";
-import { LightsparkException } from "@lightsparkdev/core";
+import { LightsparkException, type Query } from "@lightsparkdev/core";
 import type ChannelClosingTransaction from "./ChannelClosingTransaction.js";
 import type ChannelOpeningTransaction from "./ChannelOpeningTransaction.js";
 import type CurrencyAmount from "./CurrencyAmount.js";
@@ -18,6 +17,7 @@ import RoutingTransactionFailureReason from "./RoutingTransactionFailureReason.j
 import TransactionStatus from "./TransactionStatus.js";
 import type Withdrawal from "./Withdrawal.js";
 
+/** This object represents a payment transaction. The transaction can occur either on a Bitcoin Network, or over the Lightning Network. You can retrieve this object to receive specific information about a particular transaction tied to your Lightspark Node. **/
 type Transaction = Entity & {
   /**
    * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
@@ -129,7 +129,7 @@ export const TransactionFromJson = (obj: any): Transaction => {
       obj["incoming_payment_resolved_at"],
       obj["incoming_payment_transaction_hash"],
       obj["incoming_payment_origin"]?.id ?? undefined,
-      obj["incoming_payment_payment_request"]?.id ?? undefined
+      obj["incoming_payment_payment_request"]?.id ?? undefined,
     );
   }
   if (obj["__typename"] == "OutgoingPayment") {
@@ -150,7 +150,7 @@ export const TransactionFromJson = (obj: any): Transaction => {
         : undefined,
       !!obj["outgoing_payment_payment_request_data"]
         ? PaymentRequestDataFromJson(
-            obj["outgoing_payment_payment_request_data"]
+            obj["outgoing_payment_payment_request_data"],
           )
         : undefined,
       !!obj["outgoing_payment_failure_reason"]
@@ -159,7 +159,7 @@ export const TransactionFromJson = (obj: any): Transaction => {
         : null,
       !!obj["outgoing_payment_failure_message"]
         ? RichTextFromJson(obj["outgoing_payment_failure_message"])
-        : undefined
+        : undefined,
     );
   }
   if (obj["__typename"] == "RoutingTransaction") {
@@ -215,7 +215,7 @@ export const TransactionFromJson = (obj: any): Transaction => {
   }
   throw new LightsparkException(
     "DeserializationError",
-    `Couldn't find a concrete type for interface Transaction corresponding to the typename=${obj["__typename"]}`
+    `Couldn't find a concrete type for interface Transaction corresponding to the typename=${obj["__typename"]}`,
   );
 };
 

package/src/objects/TransactionFailures.ts

@@ -3,6 +3,7 @@
 import PaymentFailureReason from "./PaymentFailureReason.js";
 import RoutingTransactionFailureReason from "./RoutingTransactionFailureReason.js";
 
+/** This object represents payment failures associated with your Lightspark Node. **/
 type TransactionFailures = {
   paymentFailures?: PaymentFailureReason[];
 
@@ -12,7 +13,7 @@ type TransactionFailures = {
 export const TransactionFailuresFromJson = (obj: any): TransactionFailures => {
   return {
     paymentFailures: obj["transaction_failures_payment_failures"]?.map(
-      (e) => PaymentFailureReason[e]
+      (e) => PaymentFailureReason[e],
     ),
     routingTransactionFailures: obj[
       "transaction_failures_routing_transaction_failures"

package/src/objects/TransactionStatus.ts

@@ -1,5 +1,6 @@
 // Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
 
+/** This is an enum of the potential statuses a transaction associated with your Lightspark Node can take. **/
 export enum TransactionStatus {
   /**
    * This is an enum value that represents values that could be added in the future.

package/src/objects/TransactionType.ts

@@ -1,5 +1,6 @@
 // Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
 
+/** This is an enum of the potential types of transactions that can be associated with your Lightspark Node. **/
 export enum TransactionType {
   /**
    * This is an enum value that represents values that could be added in the future.