@lightsparkdev/lightspark-sdk 1.2.0 → 1.2.2

package/src/objects/CreateInvitationWithIncentivesOutput.ts

@@ -0,0 +1,32 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+interface CreateInvitationWithIncentivesOutput {
+  invitationId: string;
+}
+
+export const CreateInvitationWithIncentivesOutputFromJson = (
+  obj: any,
+): CreateInvitationWithIncentivesOutput => {
+  return {
+    invitationId: obj["create_invitation_with_incentives_output_invitation"].id,
+  } as CreateInvitationWithIncentivesOutput;
+};
+export const CreateInvitationWithIncentivesOutputToJson = (
+  obj: CreateInvitationWithIncentivesOutput,
+): any => {
+  return {
+    create_invitation_with_incentives_output_invitation: {
+      id: obj.invitationId,
+    },
+  };
+};
+
+export const FRAGMENT = `
+fragment CreateInvitationWithIncentivesOutputFragment on CreateInvitationWithIncentivesOutput {
+    __typename
+    create_invitation_with_incentives_output_invitation: invitation {
+        id
+    }
+}`;
+
+export default CreateInvitationWithIncentivesOutput;

package/src/objects/CreateUmaInvitationInput.ts

@@ -0,0 +1,22 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+interface CreateUmaInvitationInput {
+  inviterUma: string;
+}
+
+export const CreateUmaInvitationInputFromJson = (
+  obj: any,
+): CreateUmaInvitationInput => {
+  return {
+    inviterUma: obj["create_uma_invitation_input_inviter_uma"],
+  } as CreateUmaInvitationInput;
+};
+export const CreateUmaInvitationInputToJson = (
+  obj: CreateUmaInvitationInput,
+): any => {
+  return {
+    create_uma_invitation_input_inviter_uma: obj.inviterUma,
+  };
+};
+
+export default CreateUmaInvitationInput;

package/src/objects/CreateUmaInvitationOutput.ts

@@ -0,0 +1,30 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+interface CreateUmaInvitationOutput {
+  invitationId: string;
+}
+
+export const CreateUmaInvitationOutputFromJson = (
+  obj: any,
+): CreateUmaInvitationOutput => {
+  return {
+    invitationId: obj["create_uma_invitation_output_invitation"].id,
+  } as CreateUmaInvitationOutput;
+};
+export const CreateUmaInvitationOutputToJson = (
+  obj: CreateUmaInvitationOutput,
+): any => {
+  return {
+    create_uma_invitation_output_invitation: { id: obj.invitationId },
+  };
+};
+
+export const FRAGMENT = `
+fragment CreateUmaInvitationOutputFragment on CreateUmaInvitationOutput {
+    __typename
+    create_uma_invitation_output_invitation: invitation {
+        id
+    }
+}`;
+
+export default CreateUmaInvitationOutput;

package/src/objects/Entity.ts

@@ -1237,6 +1237,7 @@ fragment EntityFragment on Entity {
         outgoing_payment_attempt_status: status
         outgoing_payment_attempt_failure_code: failure_code
         outgoing_payment_attempt_failure_source_index: failure_source_index
+        outgoing_payment_attempt_attempted_at: attempted_at
         outgoing_payment_attempt_resolved_at: resolved_at
         outgoing_payment_attempt_amount: amount {
             __typename
@@ -1361,6 +1362,18 @@ fragment EntityFragment on Entity {
             id
         }
     }
+    ... on UmaInvitation {
+        __typename
+        uma_invitation_id: id
+        uma_invitation_created_at: created_at
+        uma_invitation_updated_at: updated_at
+        uma_invitation_code: code
+        uma_invitation_url: url
+        uma_invitation_inviter_uma: inviter_uma
+        uma_invitation_invitee_uma: invitee_uma
+        uma_invitation_incentives_status: incentives_status
+        uma_invitation_incentives_ineligibility_reason: incentives_ineligibility_reason
+    }
     ... on Wallet {
         __typename
         wallet_id: id

package/src/objects/GraphNode.ts

@@ -13,15 +13,43 @@ import { NodeToAddressesConnectionFromJson } from "./NodeToAddressesConnection.j
 /** 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, Entity {
   constructor(
+    /**
+     * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
+     * string.
+     **/
     public readonly id: string,
+    /** The date and time when the entity was first created. **/
     public readonly createdAt: string,
+    /** The date and time when the entity was last updated. **/
     public readonly updatedAt: string,
+    /** The Bitcoin Network this node is deployed in. **/
     public readonly bitcoinNetwork: BitcoinNetwork,
+    /**
+     * The name of this node in the network. It will be the most human-readable option possible, depending
+     * on the data available for this node.
+     **/
     public readonly displayName: string,
+    /** The typename of the object **/
     public readonly typename: string,
+    /**
+     * A name that identifies the node. It has no importance in terms of operating the node, it is just a
+     * way to identify and search for commercial services or popular nodes. This alias can be changed at
+     * any time by the node operator.
+     **/
     public readonly alias?: string | undefined,
+    /**
+     * A hexadecimal string that describes a color. For example "#000000" is black, "#FFFFFF" is white. It
+     * has no importance in terms of operating the node, it is just a way to visually differentiate nodes.
+     * That color can be changed at any time by the node operator.
+     **/
     public readonly color?: string | undefined,
+    /**
+     * A summary metric used to capture how well positioned a node is to send, receive, or route
+     * transactions efficiently. Maximizing a node's conductivity helps a node’s transactions to be
+     * capital efficient. The value is an integer ranging between 0 and 10 (bounds included).
+     **/
     public readonly conductivity?: number | undefined,
+    /** The public key of this node. It acts as a unique identifier of this node in the Lightning Network. **/
     public readonly publicKey?: string | undefined,
   ) {
     autoBind(this);

package/src/objects/IncentivesIneligibilityReason.ts

@@ -0,0 +1,24 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+/** Describes the reason for an invitation to not be eligible for incentives. **/
+export enum IncentivesIneligibilityReason {
+  /**
+   * 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",
+  /** This invitation is not eligible for incentives because it has been created outside of the incentives flow. **/
+  DISABLED = "DISABLED",
+  /** This invitation is not eligible for incentives because the sender is not eligible. **/
+  SENDER_NOT_ELIGIBLE = "SENDER_NOT_ELIGIBLE",
+  /** This invitation is not eligible for incentives because the receiver is not eligible. **/
+  RECEIVER_NOT_ELIGIBLE = "RECEIVER_NOT_ELIGIBLE",
+  /** This invitation is not eligible for incentives because the sending VASP is not part of the incentives program. **/
+  SENDING_VASP_NOT_ELIGIBLE = "SENDING_VASP_NOT_ELIGIBLE",
+  /** This invitation is not eligible for incentives because the receiving VASP is not part of the incentives program. **/
+  RECEIVING_VASP_NOT_ELIGIBLE = "RECEIVING_VASP_NOT_ELIGIBLE",
+  /** This invitation is not eligible for incentives because the sender and receiver are in the same region. **/
+  NOT_CROSS_BORDER = "NOT_CROSS_BORDER",
+}
+
+export default IncentivesIneligibilityReason;

package/src/objects/IncentivesStatus.ts

@@ -0,0 +1,18 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+/** Describes the status of the incentives for this invitation. **/
+export enum IncentivesStatus {
+  /**
+   * 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",
+  /** The invitation is eligible for incentives in its current state. When it is claimed, we will reassess. **/
+  PENDING = "PENDING",
+  /** The incentives have been validated. **/
+  VALIDATED = "VALIDATED",
+  /** This invitation is not eligible for incentives. A more detailed reason can be found in the `incentives_ineligibility_reason` field. **/
+  INELIGIBLE = "INELIGIBLE",
+}
+
+export default IncentivesStatus;

package/src/objects/IncomingPayment.ts

@@ -24,16 +24,33 @@ import TransactionStatus from "./TransactionStatus.js";
 /** This object represents any payment sent to a Lightspark node on the Lightning Network. You can retrieve this object to receive payment related information about a specific payment received by a Lightspark node. **/
 class IncomingPayment implements LightningTransaction, Transaction, Entity {
   constructor(
+    /**
+     * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
+     * string.
+     **/
     public readonly id: string,
+    /** The date and time when this transaction was initiated. **/
     public readonly createdAt: string,
+    /** The date and time when the entity was last updated. **/
     public readonly updatedAt: string,
+    /** The current status of this transaction. **/
     public readonly status: TransactionStatus,
+    /** The amount of money involved in this transaction. **/
     public readonly amount: CurrencyAmount,
+    /** The recipient Lightspark node this payment was sent to. **/
     public readonly destinationId: string,
+    /** The typename of the object **/
     public readonly typename: string,
+    /** The date and time when this transaction was completed or failed. **/
     public readonly resolvedAt?: string | undefined,
+    /** The hash of this transaction, so it can be uniquely identified on the Lightning Network. **/
     public readonly transactionHash?: string | undefined,
+    /**
+     * The optional payment request for this incoming payment, which will be null if the payment is sent
+     * through keysend.
+     **/
     public readonly paymentRequestId?: string | undefined,
+    /** The post transaction data which can be used in KYT payment registration. **/
     public readonly umaPostTransactionData?: PostTransactionData[] | undefined,
   ) {
     autoBind(this);

package/src/objects/LightsparkNodeWithOSK.ts

@@ -32,25 +32,86 @@ import { SecretFromJson, SecretToJson } from "./Secret.js";
 /** This is a Lightspark node with OSK. **/
 class LightsparkNodeWithOSK implements LightsparkNode, Node, Entity {
   constructor(
+    /**
+     * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
+     * string.
+     **/
     public readonly id: string,
+    /** The date and time when the entity was first created. **/
     public readonly createdAt: string,
+    /** The date and time when the entity was last updated. **/
     public readonly updatedAt: string,
+    /** The Bitcoin Network this node is deployed in. **/
     public readonly bitcoinNetwork: BitcoinNetwork,
+    /**
+     * The name of this node in the network. It will be the most human-readable option possible, depending
+     * on the data available for this node.
+     **/
     public readonly displayName: string,
+    /** The owner of this LightsparkNode. **/
     public readonly ownerId: string,
+    /**
+     * The utxos of the channels that are connected to this node. This is used in uma flow for
+     * pre-screening.
+     **/
     public readonly umaPrescreeningUtxos: string[],
+    /** The typename of the object **/
     public readonly typename: string,
+    /**
+     * A name that identifies the node. It has no importance in terms of operating the node, it is just a
+     * way to identify and search for commercial services or popular nodes. This alias can be changed at
+     * any time by the node operator.
+     **/
     public readonly alias?: string | undefined,
+    /**
+     * A hexadecimal string that describes a color. For example "#000000" is black, "#FFFFFF" is white. It
+     * has no importance in terms of operating the node, it is just a way to visually differentiate nodes.
+     * That color can be changed at any time by the node operator.
+     **/
     public readonly color?: string | undefined,
+    /**
+     * A summary metric used to capture how well positioned a node is to send, receive, or route
+     * transactions efficiently. Maximizing a node's conductivity helps a node’s transactions to be
+     * capital efficient. The value is an integer ranging between 0 and 10 (bounds included).
+     **/
     public readonly conductivity?: number | undefined,
+    /** The public key of this node. It acts as a unique identifier of this node in the Lightning Network. **/
     public readonly publicKey?: string | undefined,
+    /** The current status of this node. **/
     public readonly status?: LightsparkNodeStatus | undefined,
+    /**
+     * The sum of the balance on the Bitcoin Network, channel balances, and commit fees on this node.
+     *
+     * @deprecated Use `balances` instead.
+     **/
     public readonly totalBalance?: CurrencyAmount | undefined,
+    /**
+     * The total sum of the channel balances (online and offline) on this node.
+     *
+     * @deprecated Use `balances` instead.
+     **/
     public readonly totalLocalBalance?: CurrencyAmount | undefined,
+    /**
+     * The sum of the channel balances (online only) that are available to send on this node.
+     *
+     * @deprecated Use `balances` instead.
+     **/
     public readonly localBalance?: CurrencyAmount | undefined,
+    /**
+     * The sum of the channel balances that are available to receive on this node.
+     *
+     * @deprecated Use `balances` instead.
+     **/
     public readonly remoteBalance?: CurrencyAmount | undefined,
+    /**
+     * The details of the balance of this node on the Bitcoin Network.
+     *
+     * @deprecated Use `balances` instead.
+     **/
     public readonly blockchainBalance?: BlockchainBalance | undefined,
+    /** The balances that describe the funds in this node. **/
     public readonly balances?: Balances | undefined,
+    /** The private key client is using to sign a GraphQL request which will be verified at server side. **/
     public readonly encryptedSigningPrivateKey?: Secret | undefined,
   ) {
     autoBind(this);

package/src/objects/LightsparkNodeWithRemoteSigning.ts

@@ -30,24 +30,84 @@ import { NodeToAddressesConnectionFromJson } from "./NodeToAddressesConnection.j
 /** This is a Lightspark node with remote signing. **/
 class LightsparkNodeWithRemoteSigning implements LightsparkNode, Node, Entity {
   constructor(
+    /**
+     * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
+     * string.
+     **/
     public readonly id: string,
+    /** The date and time when the entity was first created. **/
     public readonly createdAt: string,
+    /** The date and time when the entity was last updated. **/
     public readonly updatedAt: string,
+    /** The Bitcoin Network this node is deployed in. **/
     public readonly bitcoinNetwork: BitcoinNetwork,
+    /**
+     * The name of this node in the network. It will be the most human-readable option possible, depending
+     * on the data available for this node.
+     **/
     public readonly displayName: string,
+    /** The owner of this LightsparkNode. **/
     public readonly ownerId: string,
+    /**
+     * The utxos of the channels that are connected to this node. This is used in uma flow for
+     * pre-screening.
+     **/
     public readonly umaPrescreeningUtxos: string[],
+    /** The typename of the object **/
     public readonly typename: string,
+    /**
+     * A name that identifies the node. It has no importance in terms of operating the node, it is just a
+     * way to identify and search for commercial services or popular nodes. This alias can be changed at
+     * any time by the node operator.
+     **/
     public readonly alias?: string | undefined,
+    /**
+     * A hexadecimal string that describes a color. For example "#000000" is black, "#FFFFFF" is white. It
+     * has no importance in terms of operating the node, it is just a way to visually differentiate nodes.
+     * That color can be changed at any time by the node operator.
+     **/
     public readonly color?: string | undefined,
+    /**
+     * A summary metric used to capture how well positioned a node is to send, receive, or route
+     * transactions efficiently. Maximizing a node's conductivity helps a node’s transactions to be
+     * capital efficient. The value is an integer ranging between 0 and 10 (bounds included).
+     **/
     public readonly conductivity?: number | undefined,
+    /** The public key of this node. It acts as a unique identifier of this node in the Lightning Network. **/
     public readonly publicKey?: string | undefined,
+    /** The current status of this node. **/
     public readonly status?: LightsparkNodeStatus | undefined,
+    /**
+     * The sum of the balance on the Bitcoin Network, channel balances, and commit fees on this node.
+     *
+     * @deprecated Use `balances` instead.
+     **/
     public readonly totalBalance?: CurrencyAmount | undefined,
+    /**
+     * The total sum of the channel balances (online and offline) on this node.
+     *
+     * @deprecated Use `balances` instead.
+     **/
     public readonly totalLocalBalance?: CurrencyAmount | undefined,
+    /**
+     * The sum of the channel balances (online only) that are available to send on this node.
+     *
+     * @deprecated Use `balances` instead.
+     **/
     public readonly localBalance?: CurrencyAmount | undefined,
+    /**
+     * The sum of the channel balances that are available to receive on this node.
+     *
+     * @deprecated Use `balances` instead.
+     **/
     public readonly remoteBalance?: CurrencyAmount | undefined,
+    /**
+     * The details of the balance of this node on the Bitcoin Network.
+     *
+     * @deprecated Use `balances` instead.
+     **/
     public readonly blockchainBalance?: BlockchainBalance | undefined,
+    /** The balances that describe the funds in this node. **/
     public readonly balances?: Balances | undefined,
   ) {
     autoBind(this);

package/src/objects/OutgoingPayment.ts

@@ -31,21 +31,40 @@ import TransactionStatus from "./TransactionStatus.js";
 /** This object represents a Lightning Network payment sent from a Lightspark Node. You can retrieve this object to receive payment related information about any payment sent from your Lightspark Node on the Lightning Network. **/
 class OutgoingPayment implements LightningTransaction, Transaction, Entity {
   constructor(
+    /**
+     * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
+     * string.
+     **/
     public readonly id: string,
+    /** The date and time when this transaction was initiated. **/
     public readonly createdAt: string,
+    /** The date and time when the entity was last updated. **/
     public readonly updatedAt: string,
+    /** The current status of this transaction. **/
     public readonly status: TransactionStatus,
+    /** The amount of money involved in this transaction. **/
     public readonly amount: CurrencyAmount,
+    /** The Lightspark node this payment originated from. **/
     public readonly originId: string,
+    /** The typename of the object **/
     public readonly typename: string,
+    /** The date and time when this transaction was completed or failed. **/
     public readonly resolvedAt?: string | undefined,
+    /** The hash of this transaction, so it can be uniquely identified on the Lightning Network. **/
     public readonly transactionHash?: string | undefined,
+    /** If known, the final recipient node this payment was sent to. **/
     public readonly destinationId?: string | undefined,
+    /** The fees paid by the sender node to send the payment. **/
     public readonly fees?: CurrencyAmount | undefined,
+    /** The data of the payment request that was paid by this transaction, if known. **/
     public readonly paymentRequestData?: PaymentRequestData | undefined,
+    /** If applicable, the reason why the payment failed. **/
     public readonly failureReason?: PaymentFailureReason | undefined,
+    /** If applicable, user-facing error message describing why the payment failed. **/
     public readonly failureMessage?: RichText | undefined,
+    /** The post transaction data which can be used in KYT payment registration. **/
     public readonly umaPostTransactionData?: PostTransactionData[] | undefined,
+    /** The preimage of the payment. **/
     public readonly paymentPreimage?: string | undefined,
   ) {
     autoBind(this);
@@ -79,6 +98,7 @@ query FetchOutgoingPaymentToAttemptsConnection($entity_id: ID!, $first: Int, $af
                     outgoing_payment_attempt_status: status
                     outgoing_payment_attempt_failure_code: failure_code
                     outgoing_payment_attempt_failure_source_index: failure_source_index
+                    outgoing_payment_attempt_attempted_at: attempted_at
                     outgoing_payment_attempt_resolved_at: resolved_at
                     outgoing_payment_attempt_amount: amount {
                         __typename

package/src/objects/OutgoingPaymentAttempt.ts

@@ -22,17 +22,45 @@ import { OutgoingPaymentAttemptToHopsConnectionFromJson } from "./OutgoingPaymen
 /** This object represents an attempted Lightning Network payment sent from a Lightspark Node. You can retrieve this object to receive payment related information about any payment attempt sent from your Lightspark Node on the Lightning Network, including any potential reasons the payment may have failed. **/
 class OutgoingPaymentAttempt implements Entity {
   constructor(
+    /**
+     * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
+     * string.
+     **/
     public readonly id: string,
+    /** The date and time when the entity was first created. **/
     public readonly createdAt: string,
+    /** The date and time when the entity was last updated. **/
     public readonly updatedAt: string,
+    /** The status of an outgoing payment attempt. **/
     public readonly status: OutgoingPaymentAttemptStatus,
+    /** The date and time when the attempt was initiated. **/
+    public readonly attemptedAt: string,
+    /** The outgoing payment for this attempt. **/
     public readonly outgoingPaymentId: string,
+    /** The typename of the object **/
     public readonly typename: string,
+    /** If the payment attempt failed, then this contains the Bolt #4 failure code. **/
     public readonly failureCode?: HtlcAttemptFailureCode | undefined,
+    /**
+     * If the payment attempt failed, then this contains the index of the hop at which the problem
+     * occurred.
+     **/
     public readonly failureSourceIndex?: number | undefined,
+    /** The time the outgoing payment attempt failed or succeeded. **/
     public readonly resolvedAt?: string | undefined,
+    /**
+     * The total amount of funds required to complete a payment over this route. This value includes the
+     * cumulative fees for each hop. As a result, the attempt extended to the first-hop in the route will
+     * need to have at least this much value, otherwise the route will fail at an intermediate node due to
+     * an insufficient amount.
+     **/
     public readonly amount?: CurrencyAmount | undefined,
+    /**
+     * The sum of the fees paid at each hop within the route of this attempt. In the case of a one-hop
+     * payment, this value will be zero as we don't need to pay a fee to ourselves.
+     **/
     public readonly fees?: CurrencyAmount | undefined,
+    /** The channel snapshot at the time the outgoing payment attempt was made. **/
     public readonly channelSnapshot?: ChannelSnapshot | undefined,
   ) {
     autoBind(this);
@@ -129,6 +157,7 @@ ${FRAGMENT}
       outgoing_payment_attempt_status: this.status,
       outgoing_payment_attempt_failure_code: this.failureCode,
       outgoing_payment_attempt_failure_source_index: this.failureSourceIndex,
+      outgoing_payment_attempt_attempted_at: this.attemptedAt,
       outgoing_payment_attempt_resolved_at: this.resolvedAt,
       outgoing_payment_attempt_amount: this.amount
         ? CurrencyAmountToJson(this.amount)
@@ -153,6 +182,7 @@ export const OutgoingPaymentAttemptFromJson = (
     obj["outgoing_payment_attempt_updated_at"],
     OutgoingPaymentAttemptStatus[obj["outgoing_payment_attempt_status"]] ??
       OutgoingPaymentAttemptStatus.FUTURE_VALUE,
+    obj["outgoing_payment_attempt_attempted_at"],
     obj["outgoing_payment_attempt_outgoing_payment"].id,
     "OutgoingPaymentAttempt",
     !!obj["outgoing_payment_attempt_failure_code"]
@@ -184,6 +214,7 @@ fragment OutgoingPaymentAttemptFragment on OutgoingPaymentAttempt {
     outgoing_payment_attempt_status: status
     outgoing_payment_attempt_failure_code: failure_code
     outgoing_payment_attempt_failure_source_index: failure_source_index
+    outgoing_payment_attempt_attempted_at: attempted_at
     outgoing_payment_attempt_resolved_at: resolved_at
     outgoing_payment_attempt_amount: amount {
         __typename