@lightsparkdev/lightspark-sdk 1.8.10 → 1.9.0

package/src/objects/Offer.ts

@@ -0,0 +1,109 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+import { type Query, isObject } from "@lightsparkdev/core";
+import type CurrencyAmount from "./CurrencyAmount.js";
+import {
+  CurrencyAmountFromJson,
+  CurrencyAmountToJson,
+} from "./CurrencyAmount.js";
+
+/** This object represents a BOLT #12 offer (https://github.com/lightning/bolts/blob/master/12-offer-encoding.md) created by a Lightspark Node. **/
+interface Offer {
+  /**
+   * 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 offer. **/
+  dataId: string;
+
+  /** The BOLT12 encoded offer. Starts with 'lno'. **/
+  encodedOffer: string;
+
+  /** The typename of the object **/
+  typename: string;
+
+  /** The amount of the offer. If null, the payer chooses the amount. **/
+  amount?: CurrencyAmount | undefined;
+
+  /** The description of the offer. **/
+  description?: string | undefined;
+}
+
+export const OfferFromJson = (obj: any): Offer => {
+  return {
+    id: obj["offer_id"],
+    createdAt: obj["offer_created_at"],
+    updatedAt: obj["offer_updated_at"],
+    dataId: obj["offer_data"].id,
+    encodedOffer: obj["offer_encoded_offer"],
+    typename: "Offer",
+    amount: !!obj["offer_amount"]
+      ? CurrencyAmountFromJson(obj["offer_amount"])
+      : undefined,
+    description: obj["offer_description"],
+  } as Offer;
+};
+export const OfferToJson = (obj: Offer): any => {
+  return {
+    __typename: "Offer",
+    offer_id: obj.id,
+    offer_created_at: obj.createdAt,
+    offer_updated_at: obj.updatedAt,
+    offer_data: { id: obj.dataId },
+    offer_encoded_offer: obj.encodedOffer,
+    offer_amount: obj.amount ? CurrencyAmountToJson(obj.amount) : undefined,
+    offer_description: obj.description,
+  };
+};
+
+export const FRAGMENT = `
+fragment OfferFragment on Offer {
+    __typename
+    offer_id: id
+    offer_created_at: created_at
+    offer_updated_at: updated_at
+    offer_data: data {
+        id
+    }
+    offer_encoded_offer: encoded_offer
+    offer_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
+    }
+    offer_description: description
+}`;
+
+export const getOfferQuery = (id: string): Query<Offer> => {
+  return {
+    queryPayload: `
+query GetOffer($id: ID!) {
+    entity(id: $id) {
+        ... on Offer {
+            ...OfferFragment
+        }
+    }
+}
+
+${FRAGMENT}    
+`,
+    variables: { id },
+    constructObject: (data: unknown) =>
+      isObject(data) && "entity" in data && isObject(data.entity)
+        ? OfferFromJson(data.entity)
+        : null,
+  };
+};
+
+export default Offer;

package/src/objects/OfferData.ts

@@ -0,0 +1,118 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+import { type Query, isObject } from "@lightsparkdev/core";
+import BitcoinNetwork from "./BitcoinNetwork.js";
+import type CurrencyAmount from "./CurrencyAmount.js";
+import {
+  CurrencyAmountFromJson,
+  CurrencyAmountToJson,
+} from "./CurrencyAmount.js";
+
+/**
+ * This object represents the data associated with a BOLT #12 offer. You can retrieve this object
+ * to receive the relevant data associated with a specific offer. *
+ */
+interface OfferData {
+  /**
+   * 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 Bech32 encoded offer. **/
+  encodedOffer: string;
+
+  /** The bitcoin networks supported by the offer. **/
+  bitcoinNetworks: BitcoinNetwork[];
+
+  /** The typename of the object **/
+  typename: string;
+
+  /**
+   * The requested amount in this invoice. If it is equal to 0, the sender should choose the
+   * amount to send.
+   **/
+  amount?: CurrencyAmount | undefined;
+
+  /** The date and time when this invoice will expire. **/
+  expiresAt?: string | undefined;
+}
+
+export const OfferDataFromJson = (obj: any): OfferData => {
+  return {
+    id: obj["offer_data_id"],
+    createdAt: obj["offer_data_created_at"],
+    updatedAt: obj["offer_data_updated_at"],
+    encodedOffer: obj["offer_data_encoded_offer"],
+    bitcoinNetworks: obj["offer_data_bitcoin_networks"].map(
+      (e) => BitcoinNetwork[e],
+    ),
+    typename: "OfferData",
+    amount: !!obj["offer_data_amount"]
+      ? CurrencyAmountFromJson(obj["offer_data_amount"])
+      : undefined,
+    expiresAt: obj["offer_data_expires_at"],
+  } as OfferData;
+};
+export const OfferDataToJson = (obj: OfferData): any => {
+  return {
+    __typename: "OfferData",
+    offer_data_id: obj.id,
+    offer_data_created_at: obj.createdAt,
+    offer_data_updated_at: obj.updatedAt,
+    offer_data_amount: obj.amount
+      ? CurrencyAmountToJson(obj.amount)
+      : undefined,
+    offer_data_encoded_offer: obj.encodedOffer,
+    offer_data_bitcoin_networks: obj.bitcoinNetworks,
+    offer_data_expires_at: obj.expiresAt,
+  };
+};
+
+export const FRAGMENT = `
+fragment OfferDataFragment on OfferData {
+    __typename
+    offer_data_id: id
+    offer_data_created_at: created_at
+    offer_data_updated_at: updated_at
+    offer_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
+    }
+    offer_data_encoded_offer: encoded_offer
+    offer_data_bitcoin_networks: bitcoin_networks
+    offer_data_expires_at: expires_at
+}`;
+
+export const getOfferDataQuery = (id: string): Query<OfferData> => {
+  return {
+    queryPayload: `
+query GetOfferData($id: ID!) {
+    entity(id: $id) {
+        ... on OfferData {
+            ...OfferDataFragment
+        }
+    }
+}
+
+${FRAGMENT}    
+`,
+    variables: { id },
+    constructObject: (data: unknown) =>
+      isObject(data) && "entity" in data && isObject(data.entity)
+        ? OfferDataFromJson(data.entity)
+        : null,
+  };
+};
+
+export default OfferData;

package/src/objects/PayOfferInput.ts

@@ -0,0 +1,53 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+interface PayOfferInput {
+  /** The ID of the node that will be sending the payment. **/
+  nodeId: string;
+
+  /** The Bech32 offer you want to pay (as defined by the BOLT12 standard). **/
+  encodedOffer: string;
+
+  /** The timeout in seconds that we will try to make the payment. **/
+  timeoutSecs: number;
+
+  /**
+   * The maximum amount of fees that you want to pay for this payment to be sent, expressed in
+   * msats. *
+   */
+  maximumFeesMsats: number;
+
+  /**
+   * The amount you will pay for this offer, expressed in msats. It should ONLY be set when the
+   * offer amount is zero.
+   **/
+  amountMsats?: number | undefined;
+
+  /**
+   * An idempotency key for this payment. If provided, it will be used to create a payment with
+   * the same idempotency key. If not provided, a new idempotency key will be generated.
+   **/
+  idempotencyKey?: string | undefined;
+}
+
+export const PayOfferInputFromJson = (obj: any): PayOfferInput => {
+  return {
+    nodeId: obj["pay_offer_input_node_id"],
+    encodedOffer: obj["pay_offer_input_encoded_offer"],
+    timeoutSecs: obj["pay_offer_input_timeout_secs"],
+    maximumFeesMsats: obj["pay_offer_input_maximum_fees_msats"],
+    amountMsats: obj["pay_offer_input_amount_msats"],
+    idempotencyKey: obj["pay_offer_input_idempotency_key"],
+  } as PayOfferInput;
+};
+export const PayOfferInputToJson = (obj: PayOfferInput): any => {
+  return {
+    pay_offer_input_node_id: obj.nodeId,
+    pay_offer_input_encoded_offer: obj.encodedOffer,
+    pay_offer_input_timeout_secs: obj.timeoutSecs,
+    pay_offer_input_maximum_fees_msats: obj.maximumFeesMsats,
+    pay_offer_input_amount_msats: obj.amountMsats,
+    pay_offer_input_idempotency_key: obj.idempotencyKey,
+  };
+};
+
+export default PayOfferInput;

package/src/objects/PayOfferOutput.ts

@@ -0,0 +1,27 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+interface PayOfferOutput {
+  /** The payment that has been sent. **/
+  paymentId: string;
+}
+
+export const PayOfferOutputFromJson = (obj: any): PayOfferOutput => {
+  return {
+    paymentId: obj["pay_offer_output_payment"].id,
+  } as PayOfferOutput;
+};
+export const PayOfferOutputToJson = (obj: PayOfferOutput): any => {
+  return {
+    pay_offer_output_payment: { id: obj.paymentId },
+  };
+};
+
+export const FRAGMENT = `
+fragment PayOfferOutputFragment on PayOfferOutput {
+    __typename
+    pay_offer_output_payment: payment {
+        id
+    }
+}`;
+
+export default PayOfferOutput;

package/src/objects/PayTestModeInvoiceInput.ts

@@ -0,0 +1,68 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+import PaymentFailureReason from "./PaymentFailureReason.js";
+
+interface PayTestModeInvoiceInput {
+  /** The node from where you want to send the payment. **/
+  nodeId: string;
+
+  /** The invoice you want to pay (as defined by the BOLT11 standard). **/
+  encodedInvoice: string;
+
+  /** The timeout in seconds that we will try to make the payment. **/
+  timeoutSecs: number;
+
+  /**
+   * The maximum amount of fees that you want to pay for this payment to be sent, expressed in
+   * msats. *
+   */
+  maximumFeesMsats: number;
+
+  /** The failure reason to trigger for the payment. If not set, pay_invoice will be called. **/
+  failureReason?: PaymentFailureReason | undefined;
+
+  /**
+   * The amount you will pay for this invoice, expressed in msats. It should ONLY be set when the
+   * invoice amount is zero.
+   **/
+  amountMsats?: number | undefined;
+
+  /**
+   * The idempotency key of the request. The same result will be returned for the same
+   * idempotency key. *
+   */
+  idempotencyKey?: string | undefined;
+}
+
+export const PayTestModeInvoiceInputFromJson = (
+  obj: any,
+): PayTestModeInvoiceInput => {
+  return {
+    nodeId: obj["pay_test_mode_invoice_input_node_id"],
+    encodedInvoice: obj["pay_test_mode_invoice_input_encoded_invoice"],
+    timeoutSecs: obj["pay_test_mode_invoice_input_timeout_secs"],
+    maximumFeesMsats: obj["pay_test_mode_invoice_input_maximum_fees_msats"],
+    failureReason: !!obj["pay_test_mode_invoice_input_failure_reason"]
+      ? PaymentFailureReason[
+          obj["pay_test_mode_invoice_input_failure_reason"]
+        ] ?? PaymentFailureReason.FUTURE_VALUE
+      : null,
+    amountMsats: obj["pay_test_mode_invoice_input_amount_msats"],
+    idempotencyKey: obj["pay_test_mode_invoice_input_idempotency_key"],
+  } as PayTestModeInvoiceInput;
+};
+export const PayTestModeInvoiceInputToJson = (
+  obj: PayTestModeInvoiceInput,
+): any => {
+  return {
+    pay_test_mode_invoice_input_node_id: obj.nodeId,
+    pay_test_mode_invoice_input_encoded_invoice: obj.encodedInvoice,
+    pay_test_mode_invoice_input_timeout_secs: obj.timeoutSecs,
+    pay_test_mode_invoice_input_maximum_fees_msats: obj.maximumFeesMsats,
+    pay_test_mode_invoice_input_failure_reason: obj.failureReason,
+    pay_test_mode_invoice_input_amount_msats: obj.amountMsats,
+    pay_test_mode_invoice_input_idempotency_key: obj.idempotencyKey,
+  };
+};
+
+export default PayTestModeInvoiceInput;

package/src/objects/PaymentRequestData.ts

@@ -10,8 +10,9 @@ import type InvoiceData from "./InvoiceData.js";
 import { NodeFromJson, NodeToJson } from "./Node.js";
 
 /**
- * This object is an interface of a payment request on the Lightning Network (i.e., a Lightning
- * Invoice). It contains data related to parsing the payment details of a Lightning Invoice. *
+ * This object is an interface of a payment request on the Lightning Network (i.e., Invoice or
+ * Bolt12Invoice). It contains data related to parsing the payment details of a Lightning Invoice.
+ * *
  */
 interface PaymentRequestData {
   encodedPaymentRequest: string;

package/src/objects/index.ts

@@ -47,6 +47,8 @@ export { default as CreateInvoiceOutput } from "./CreateInvoiceOutput.js";
 export { default as CreateLnurlInvoiceInput } from "./CreateLnurlInvoiceInput.js";
 export { default as CreateNodeWalletAddressInput } from "./CreateNodeWalletAddressInput.js";
 export { default as CreateNodeWalletAddressOutput } from "./CreateNodeWalletAddressOutput.js";
+export { default as CreateOfferInput } from "./CreateOfferInput.js";
+export { default as CreateOfferOutput } from "./CreateOfferOutput.js";
 export { default as CreateTestModeInvoiceInput } from "./CreateTestModeInvoiceInput.js";
 export { default as CreateTestModeInvoiceOutput } from "./CreateTestModeInvoiceOutput.js";
 export { default as CreateTestModePaymentInput } from "./CreateTestModePaymentInput.js";
@@ -55,6 +57,7 @@ export { default as CreateUmaInvitationInput } from "./CreateUmaInvitationInput.
 export { default as CreateUmaInvitationOutput } from "./CreateUmaInvitationOutput.js";
 export { default as CreateUmaInvoiceInput } from "./CreateUmaInvoiceInput.js";
 export { default as CurrencyAmount } from "./CurrencyAmount.js";
+export { default as CurrencyAmountInput } from "./CurrencyAmountInput.js";
 export { default as CurrencyUnit } from "./CurrencyUnit.js";
 export { default as DailyLiquidityForecast } from "./DailyLiquidityForecast.js";
 export { default as DeclineToSignMessagesInput } from "./DeclineToSignMessagesInput.js";
@@ -116,6 +119,8 @@ export { default as Node, getNodeQuery } from "./Node.js";
 export { default as NodeAddress } from "./NodeAddress.js";
 export { default as NodeAddressType } from "./NodeAddressType.js";
 export { default as NodeToAddressesConnection } from "./NodeToAddressesConnection.js";
+export { default as Offer, getOfferQuery } from "./Offer.js";
+export { default as OfferData, getOfferDataQuery } from "./OfferData.js";
 export { default as OnChainFeeTarget } from "./OnChainFeeTarget.js";
 export {
   default as OnChainTransaction,
@@ -143,6 +148,9 @@ export {
 } from "./PaymentRequest.js";
 export { default as PaymentRequestData } from "./PaymentRequestData.js";
 export { default as PaymentRequestStatus } from "./PaymentRequestStatus.js";
+export { default as PayOfferInput } from "./PayOfferInput.js";
+export { default as PayOfferOutput } from "./PayOfferOutput.js";
+export { default as PayTestModeInvoiceInput } from "./PayTestModeInvoiceInput.js";
 export { default as PayUmaInvoiceInput } from "./PayUmaInvoiceInput.js";
 export { default as Permission } from "./Permission.js";
 export { default as PostTransactionData } from "./PostTransactionData.js";