@lightsparkdev/lightspark-sdk 0.1.6

package/src/objects/RoutingTransaction.ts

@@ -0,0 +1,150 @@
+// 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 LightningTransaction from "./LightningTransaction.js";
+import RichText, { RichTextFromJson } from "./RichText.js";
+import RoutingTransactionFailureReason from "./RoutingTransactionFailureReason.js";
+import Transaction from "./Transaction.js";
+import TransactionStatus from "./TransactionStatus.js";
+
+/** A transaction that was forwarded through a Lightspark node on the Lightning Network. **/
+type RoutingTransaction = LightningTransaction &
+  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 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;
+
+    /** If known, the channel this transaction was received from. **/
+    incomingChannelId?: string;
+
+    /** If known, the channel this transaction was forwarded to. **/
+    outgoingChannelId?: string;
+
+    /**
+     * The fees collected by the node when routing this transaction. We subtract the outgoing amount to
+     * the incoming amount to determine how much fees were collected.
+     **/
+    fees?: CurrencyAmount;
+
+    /** If applicable, user-facing error message describing why the routing failed. **/
+    failureMessage?: RichText;
+
+    /** If applicable, the reason why the routing failed. **/
+    failureReason?: RoutingTransactionFailureReason;
+  };
+
+export const RoutingTransactionFromJson = (obj: any): RoutingTransaction => {
+  return {
+    id: obj["routing_transaction_id"],
+    createdAt: obj["routing_transaction_created_at"],
+    updatedAt: obj["routing_transaction_updated_at"],
+    status:
+      TransactionStatus[obj["routing_transaction_status"]] ??
+      TransactionStatus.FUTURE_VALUE,
+    amount: CurrencyAmountFromJson(obj["routing_transaction_amount"]),
+    typename: "RoutingTransaction",
+    resolvedAt: obj["routing_transaction_resolved_at"],
+    transactionHash: obj["routing_transaction_transaction_hash"],
+    incomingChannelId:
+      obj["routing_transaction_incoming_channel"]?.id ?? undefined,
+    outgoingChannelId:
+      obj["routing_transaction_outgoing_channel"]?.id ?? undefined,
+    fees: !!obj["routing_transaction_fees"]
+      ? CurrencyAmountFromJson(obj["routing_transaction_fees"])
+      : undefined,
+    failureMessage: !!obj["routing_transaction_failure_message"]
+      ? RichTextFromJson(obj["routing_transaction_failure_message"])
+      : undefined,
+    failureReason: !!obj["routing_transaction_failure_reason"]
+      ? RoutingTransactionFailureReason[
+          obj["routing_transaction_failure_reason"]
+        ] ?? RoutingTransactionFailureReason.FUTURE_VALUE
+      : null,
+  } as RoutingTransaction;
+};
+
+export const FRAGMENT = `
+fragment RoutingTransactionFragment on RoutingTransaction {
+    __typename
+    routing_transaction_id: id
+    routing_transaction_created_at: created_at
+    routing_transaction_updated_at: updated_at
+    routing_transaction_status: status
+    routing_transaction_resolved_at: resolved_at
+    routing_transaction_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
+    }
+    routing_transaction_transaction_hash: transaction_hash
+    routing_transaction_incoming_channel: incoming_channel {
+        id
+    }
+    routing_transaction_outgoing_channel: outgoing_channel {
+        id
+    }
+    routing_transaction_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
+    }
+    routing_transaction_failure_message: failure_message {
+        __typename
+        rich_text_text: text
+    }
+    routing_transaction_failure_reason: failure_reason
+}`;
+
+export const getRoutingTransactionQuery = (
+  id: string
+): Query<RoutingTransaction> => {
+  return {
+    queryPayload: `
+query GetRoutingTransaction($id: ID!) {
+    entity(id: $id) {
+        ... on RoutingTransaction {
+            ...RoutingTransactionFragment
+        }
+    }
+}
+
+${FRAGMENT}    
+`,
+    variables: { id },
+    constructObject: (data: any) => RoutingTransactionFromJson(data.entity),
+  };
+};
+
+export default RoutingTransaction;

package/src/objects/RoutingTransactionFailureReason.ts

@@ -0,0 +1,17 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+export enum RoutingTransactionFailureReason {
+  /**
+   * 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",
+
+  INCOMING_LINK_FAILURE = "INCOMING_LINK_FAILURE",
+
+  OUTGOING_LINK_FAILURE = "OUTGOING_LINK_FAILURE",
+
+  FORWARDING_FAILURE = "FORWARDING_FAILURE",
+}
+
+export default RoutingTransactionFailureReason;

package/src/objects/Secret.ts

@@ -0,0 +1,23 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+type Secret = {
+  encryptedValue: string;
+
+  cipher: string;
+};
+
+export const SecretFromJson = (obj: any): Secret => {
+  return {
+    encryptedValue: obj["secret_encrypted_value"],
+    cipher: obj["secret_cipher"],
+  } as Secret;
+};
+
+export const FRAGMENT = `
+fragment SecretFragment on Secret {
+    __typename
+    secret_encrypted_value: encrypted_value
+    secret_cipher: cipher
+}`;
+
+export default Secret;

package/src/objects/SendPaymentInput.ts

@@ -0,0 +1,30 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+type SendPaymentInput = {
+  /** The node from where you want to send the payment. **/
+  nodeId: string;
+
+  /** The public key of the destination node. **/
+  destinationPublicKey: string;
+
+  /** The timeout in seconds that we will try to make the payment. **/
+  timeoutSecs: number;
+
+  /** The amount you will send to the destination node, expressed in msats. **/
+  amountMsats: number;
+
+  /** The maximum amount of fees that you want to pay for this payment to be sent, expressed in msats. **/
+  maximumFeesMsats: number;
+};
+
+export const SendPaymentInputFromJson = (obj: any): SendPaymentInput => {
+  return {
+    nodeId: obj["send_payment_input_node_id"],
+    destinationPublicKey: obj["send_payment_input_destination_public_key"],
+    timeoutSecs: obj["send_payment_input_timeout_secs"],
+    amountMsats: obj["send_payment_input_amount_msats"],
+    maximumFeesMsats: obj["send_payment_input_maximum_fees_msats"],
+  } as SendPaymentInput;
+};
+
+export default SendPaymentInput;

package/src/objects/SendPaymentOutput.ts

@@ -0,0 +1,22 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+type SendPaymentOutput = {
+  /** The payment that has been sent. **/
+  paymentId: string;
+};
+
+export const SendPaymentOutputFromJson = (obj: any): SendPaymentOutput => {
+  return {
+    paymentId: obj["send_payment_output_payment"].id,
+  } as SendPaymentOutput;
+};
+
+export const FRAGMENT = `
+fragment SendPaymentOutputFragment on SendPaymentOutput {
+    __typename
+    send_payment_output_payment: payment {
+        id
+    }
+}`;
+
+export default SendPaymentOutput;