@lightsparkdev/lightspark-sdk 1.2.2 → 1.2.3

package/src/objects/OutgoingPaymentAttempt.ts

@@ -19,12 +19,19 @@ import OutgoingPaymentAttemptStatus from "./OutgoingPaymentAttemptStatus.js";
 import type OutgoingPaymentAttemptToHopsConnection from "./OutgoingPaymentAttemptToHopsConnection.js";
 import { OutgoingPaymentAttemptToHopsConnectionFromJson } from "./OutgoingPaymentAttemptToHopsConnection.js";
 
-/** 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. **/
+/**
+ * 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.
+     * 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. **/
@@ -39,28 +46,36 @@ class OutgoingPaymentAttempt implements Entity {
     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. **/
+    /**
+     * 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.
+     * 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.
+     * 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.
+     * 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. **/
+    /**
+     * The channel snapshot at the time the outgoing payment attempt was made.
+     * *
+     */
     public readonly channelSnapshot?: ChannelSnapshot | undefined,
   ) {
     autoBind(this);

package/src/objects/OutgoingPaymentAttemptStatus.ts

@@ -1,10 +1,14 @@
 // Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
 
-/** This is an enum of all potential statuses of a payment attempt made from a Lightspark Node. **/
+/**
+ * This is an enum of all potential statuses of a payment attempt made from a
+ * Lightspark Node. *
+ */
 export enum OutgoingPaymentAttemptStatus {
   /**
-   * 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.
+   * 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",
 

package/src/objects/OutgoingPaymentAttemptToHopsConnection.ts

@@ -5,15 +5,23 @@ import { HopFromJson, HopToJson } from "./Hop.js";
 import type PageInfo from "./PageInfo.js";
 import { PageInfoFromJson, PageInfoToJson } from "./PageInfo.js";
 
-/** The connection from an outgoing payment attempt to the list of sequential hops that define the path from sender node to recipient node. **/
+/**
+ * The connection from an outgoing payment attempt to the list of sequential
+ * hops that define the path from sender node to recipient node.
+ * *
+ */
 interface OutgoingPaymentAttemptToHopsConnection {
   /**
-   * 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).
+   * 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. **/
+  /**
+   * An object that holds pagination information about the objects in this
+   * connection. *
+   */
   pageInfo: PageInfo;
 
   /** The hops for the current page of this connection. **/

package/src/objects/OutgoingPaymentToAttemptsConnection.ts

@@ -8,12 +8,16 @@ import { PageInfoFromJson, PageInfoToJson } from "./PageInfo.js";
 /** The connection from outgoing payment to all attempts. **/
 interface OutgoingPaymentToAttemptsConnection {
   /**
-   * 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).
+   * 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. **/
+  /**
+   * An object that holds pagination information about the objects in this
+   * connection. *
+   */
   pageInfo: PageInfo;
 
   /** The attempts for the current page of this connection. **/

package/src/objects/PageInfo.ts

@@ -1,6 +1,11 @@
 // Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
 
-/** This is an object representing information about a page returned by the Lightspark API. For more information, please see the “Pagination” section of our API docs for more information about its usage. **/
+/**
+ * This is an object representing information about a page returned by the
+ * Lightspark API. For more information,
+ * please see the “Pagination” section of our API docs for more information
+ * about its usage. *
+ */
 interface PageInfo {
   hasNextPage?: boolean | undefined;
 

package/src/objects/PayInvoiceInput.ts

@@ -10,12 +10,15 @@ interface PayInvoiceInput {
   /** 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. **/
+  /**
+   * 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 invoice, expressed in msats. It should ONLY be set when the
-   * invoice amount is zero.
+   * 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;
 }

package/src/objects/PaymentDirection.ts

@@ -3,8 +3,9 @@
 /** This is an enum indicating the direction of the payment. **/
 export enum PaymentDirection {
   /**
-   * 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.
+   * 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",
 

package/src/objects/PaymentFailureReason.ts

@@ -1,10 +1,14 @@
 // Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
 
-/** This is an enum of the potential reasons why an OutgoingPayment sent from a Lightspark Node may have failed. **/
+/**
+ * This is an enum of the potential reasons why an OutgoingPayment sent from a
+ * Lightspark Node may have failed. *
+ */
 export enum PaymentFailureReason {
   /**
-   * 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.
+   * 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",
 

package/src/objects/PaymentRequest.ts

@@ -10,11 +10,16 @@ import { InvoiceDataFromJson, InvoiceDataToJson } from "./InvoiceData.js";
 import type PaymentRequestData from "./PaymentRequestData.js";
 import PaymentRequestStatus from "./PaymentRequestStatus.js";
 
-/** This object contains information related to a payment request generated or received by a LightsparkNode. You can retrieve this object to receive payment information about a specific invoice. **/
+/**
+ * This object contains information related to a payment request generated or
+ * received by a LightsparkNode. You can retrieve this object to receive
+ * payment information about a specific invoice.
+ * *
+ */
 interface PaymentRequest {
   /**
-   * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
-   * string.
+   * The unique identifier of this entity across all Lightspark systems.
+   * Should be treated as an opaque string.
    **/
   id: string;
 

package/src/objects/PaymentRequestData.ts

@@ -9,7 +9,11 @@ import {
 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., a Lightning Invoice). It contains data related to parsing the payment
+ * details of a Lightning Invoice. *
+ */
 interface PaymentRequestData {
   encodedPaymentRequest: string;
 

package/src/objects/PaymentRequestStatus.ts

@@ -1,10 +1,14 @@
 // Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
 
-/** This is an enum of the potential states that a payment request on the Lightning Network can take. **/
+/**
+ * This is an enum of the potential states that a payment request on the
+ * Lightning Network can take. *
+ */
 export enum PaymentRequestStatus {
   /**
-   * 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.
+   * 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",
 

package/src/objects/Permission.ts

@@ -1,10 +1,14 @@
 // Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
 
-/** This is an enum of the potential permissions that a Lightspark user can have in regards to account management. **/
+/**
+ * This is an enum of the potential permissions that a Lightspark user can have
+ * in regards to account management. *
+ */
 export enum Permission {
   /**
-   * 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.
+   * 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",
 

package/src/objects/PostTransactionData.ts

@@ -6,11 +6,14 @@ import {
   CurrencyAmountToJson,
 } from "./CurrencyAmount.js";
 
-/** This object represents post-transaction data that could be used to register payment for KYT. **/
+/**
+ * This object represents post-transaction data that could be used to register
+ * payment for KYT. *
+ */
 interface PostTransactionData {
   /**
-   * The utxo of the channel over which the payment went through in the format of
-   * <transaction_hash>:<output_index>.
+   * The utxo of the channel over which the payment went through in the format
+   * of <transaction_hash>:<output_index>.
    **/
   utxo: string;
 

package/src/objects/RegionCode.ts

@@ -1,10 +1,14 @@
 // Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
 
-/** The alpha-2 representation of a country, as defined by the ISO 3166-1 standard. **/
+/**
+ * The alpha-2 representation of a country, as defined by the ISO 3166-1
+ * standard. *
+ */
 export enum RegionCode {
   /**
-   * 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.
+   * 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 code representing the country of Afghanistan. **/
@@ -59,9 +63,15 @@ export enum RegionCode {
   BM = "BM",
   /** The code representing the country of Bhutan. **/
   BT = "BT",
-  /** The code representing the country of The Plurinational State of Bolivia. **/
+  /**
+   * The code representing the country of The Plurinational State of Bolivia.
+   * *
+   */
   BO = "BO",
-  /** The code representing the country of Bonaire, Sint Eustatius, and Saba. **/
+  /**
+   * The code representing the country of Bonaire, Sint Eustatius, and Saba.
+   * *
+   */
   BQ = "BQ",
   /** The code representing the country of Bosnia and Herzegovina. **/
   BA = "BA",
@@ -109,7 +119,10 @@ export enum RegionCode {
   KM = "KM",
   /** The code representing the country of Congo. **/
   CG = "CG",
-  /** The code representing the country of The Democratic Republic of the Congo. **/
+  /**
+   * The code representing the country of The Democratic Republic of the Congo.
+   * *
+   */
   CD = "CD",
   /** The code representing the country of Cook Islands. **/
   CK = "CK",
@@ -199,7 +212,10 @@ export enum RegionCode {
   GY = "GY",
   /** The code representing the country of Haiti. **/
   HT = "HT",
-  /** The code representing the country of Heard Island and McDonald Islands. **/
+  /**
+   * The code representing the country of Heard Island and McDonald Islands.
+   * *
+   */
   HM = "HM",
   /** The code representing the country of Holy See (Vatican City State). **/
   VA = "VA",
@@ -241,7 +257,10 @@ export enum RegionCode {
   KE = "KE",
   /** The code representing the country of Kiribati. **/
   KI = "KI",
-  /** The code representing the country of Democratic People's Republic ofKorea. **/
+  /**
+   * The code representing the country of Democratic People's Republic ofKorea.
+   * *
+   */
   KP = "KP",
   /** The code representing the country of Republic of Korea. **/
   KR = "KR",
@@ -269,7 +288,10 @@ export enum RegionCode {
   LU = "LU",
   /** The code representing the country of Macao. **/
   MO = "MO",
-  /** The code representing the country of The Former Yugoslav Republic of Macedonia. **/
+  /**
+   * The code representing the country of The Former Yugoslav Republic of
+   * Macedonia. *
+   */
   MK = "MK",
   /** The code representing the country of Madagascar. **/
   MG = "MG",
@@ -377,7 +399,10 @@ export enum RegionCode {
   RW = "RW",
   /** The code representing the country of Saint Barthélemy. **/
   BL = "BL",
-  /** The code representing the country of Saint Helena  Ascension and Tristan da Cunha. **/
+  /**
+   * The code representing the country of Saint Helena  Ascension and Tristan
+   * da Cunha. *
+   */
   SH = "SH",
   /** The code representing the country of Saint Kitts and Nevis. **/
   KN = "KN",
@@ -419,7 +444,10 @@ export enum RegionCode {
   SO = "SO",
   /** The code representing the country of South Africa. **/
   ZA = "ZA",
-  /** The code representing the country of South Georgia and the South Sandwich Islands. **/
+  /**
+   * The code representing the country of South Georgia and the South Sandwich
+   * Islands. *
+   */
   GS = "GS",
   /** The code representing the country of South Sudan. **/
   SS = "SS",
@@ -479,7 +507,10 @@ export enum RegionCode {
   GB = "GB",
   /** The code representing the country of United States. **/
   US = "US",
-  /** The code representing the country of United States Minor Outlying Islands. **/
+  /**
+   * The code representing the country of United States Minor Outlying Islands.
+   * *
+   */
   UM = "UM",
   /** The code representing the country of Uruguay. **/
   UY = "UY",

package/src/objects/RegisterPaymentInput.ts

@@ -5,25 +5,30 @@ import PaymentDirection from "./PaymentDirection.js";
 
 interface RegisterPaymentInput {
   /**
-   * The compliance provider that is going to screen the node. You need to be a customer of the selected
-   * provider and store the API key on the Lightspark account setting page.
+   * The compliance provider that is going to screen the node.
+   * You need to be a customer of the selected provider and store the API key
+   * on the Lightspark account setting page.
    **/
   provider: ComplianceProvider;
 
   /**
-   * The Lightspark ID of the lightning payment you want to register. It can be the id of either an
-   * OutgoingPayment or an IncomingPayment.
+   * The Lightspark ID of the lightning payment you want to register.
+   * It can be the id of either an OutgoingPayment or an IncomingPayment.
    **/
   paymentId: string;
 
   /**
-   * The public key of the counterparty lightning node, which would be the public key of the recipient
-   * node if it is to register an outgoing payment, or the public key of the sender node if it is to
+   * The public key of the counterparty lightning node,
+   * which would be the public key of the recipient node if it is to register
+   * an outgoing payment, or the public key of the sender node if it is to
    * register an incoming payment.
    **/
   nodePubkey: string;
 
-  /** Indicates whether this payment is an OutgoingPayment or an IncomingPayment. **/
+  /**
+   * Indicates whether this payment is an OutgoingPayment or an
+   * IncomingPayment. *
+   */
   direction: PaymentDirection;
 }
 

package/src/objects/RemoteSigningSubEventType.ts

@@ -1,10 +1,14 @@
 // Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
 
-/** This is an enum of the potential sub-event types for Remote Signing webook events. **/
+/**
+ * This is an enum of the potential sub-event types for Remote Signing webook
+ * events. *
+ */
 export enum RemoteSigningSubEventType {
   /**
-   * 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.
+   * 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",
 

package/src/objects/RequestWithdrawalInput.ts

@@ -10,8 +10,8 @@ interface RequestWithdrawalInput {
   bitcoinAddress: string;
 
   /**
-   * The amount you want to withdraw from this node in Satoshis. Use the special value -1 to withdrawal
-   * all funds from this node.
+   * The amount you want to withdraw from this node in Satoshis.
+   * Use the special value -1 to withdrawal all funds from this node.
    **/
   amountSats: number;
 

package/src/objects/RiskRating.ts

@@ -1,10 +1,15 @@
 // Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
 
-/** This is an enum of the potential risk ratings related to a transaction made over the Lightning Network. These risk ratings are returned from the CryptoSanctionScreeningProvider. **/
+/**
+ * This is an enum of the potential risk ratings related to a transaction made
+ * over the Lightning Network. These risk ratings are returned from the
+ * CryptoSanctionScreeningProvider. *
+ */
 export enum RiskRating {
   /**
-   * 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.
+   * 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",
 

package/src/objects/RoutingTransaction.ts

@@ -11,11 +11,17 @@ import { RichTextFromJson, RichTextToJson } from "./RichText.js";
 import RoutingTransactionFailureReason from "./RoutingTransactionFailureReason.js";
 import TransactionStatus from "./TransactionStatus.js";
 
-/** 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. **/
+/**
+ * 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.
+ * *
+ */
 interface RoutingTransaction {
   /**
-   * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
-   * string.
+   * The unique identifier of this entity across all Lightspark systems.
+   * Should be treated as an opaque string.
    **/
   id: string;
 
@@ -37,7 +43,10 @@ interface RoutingTransaction {
   /** The date and time when this transaction was completed or failed. **/
   resolvedAt?: string | undefined;
 
-  /** The hash of this transaction, so it can be uniquely identified on the Lightning Network. **/
+  /**
+   * The hash of this transaction, so it can be uniquely identified on the
+   * Lightning Network. *
+   */
   transactionHash?: string | undefined;
 
   /** If known, the channel this transaction was received from. **/
@@ -47,12 +56,16 @@ interface RoutingTransaction {
   outgoingChannelId?: string | undefined;
 
   /**
-   * 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.
+   * 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 | undefined;
 
-  /** If applicable, user-facing error message describing why the routing failed. **/
+  /**
+   * If applicable, user-facing error message describing why the routing
+   * failed. *
+   */
   failureMessage?: RichText | undefined;
 
   /** If applicable, the reason why the routing failed. **/

package/src/objects/RoutingTransactionFailureReason.ts

@@ -1,10 +1,15 @@
 // 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. **/
+/**
+ * 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.
-   * Clients should support unknown values as more of them could be added without notice.
+   * 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",
 

package/src/objects/ScreenNodeInput.ts

@@ -4,8 +4,9 @@ import ComplianceProvider from "./ComplianceProvider.js";
 
 interface ScreenNodeInput {
   /**
-   * The compliance provider that is going to screen the node. You need to be a customer of the selected
-   * provider and store the API key on the Lightspark account setting page.
+   * The compliance provider that is going to screen the node.
+   * You need to be a customer of the selected provider and store the API key
+   * on the Lightspark account setting page.
    **/
   provider: ComplianceProvider;
 

package/src/objects/SendPaymentInput.ts

@@ -13,7 +13,10 @@ interface SendPaymentInput {
   /** 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. **/
+  /**
+   * The maximum amount of fees that you want to pay for this payment to be
+   * sent, expressed in msats. *
+   */
   maximumFeesMsats: number;
 }
 

package/src/objects/SetInvoicePaymentHashInput.ts

@@ -8,8 +8,9 @@ interface SetInvoicePaymentHashInput {
   paymentHash: string;
 
   /**
-   * The 32-byte nonce used to generate the invoice preimage if applicable. It will later be included in
-   * RELEASE_PAYMENT_PREIMAGE webhook to help recover the raw preimage.
+   * The 32-byte nonce used to generate the invoice preimage if applicable.
+   * It will later be included in RELEASE_PAYMENT_PREIMAGE webhook to help
+   * recover the raw preimage.
    **/
   preimageNonce?: string | undefined;
 }

package/src/objects/Signable.ts

@@ -4,8 +4,8 @@ import { type Query } from "@lightsparkdev/core";
 
 interface Signable {
   /**
-   * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
-   * string.
+   * The unique identifier of this entity across all Lightspark systems.
+   * Should be treated as an opaque string.
    **/
   id: string;
 

package/src/objects/SignablePayload.ts

@@ -5,8 +5,8 @@ import SignablePayloadStatus from "./SignablePayloadStatus.js";
 
 interface SignablePayload {
   /**
-   * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
-   * string.
+   * The unique identifier of this entity across all Lightspark systems.
+   * Should be treated as an opaque string.
    **/
   id: string;
 
@@ -19,7 +19,10 @@ interface SignablePayload {
   /** The payload that needs to be signed. **/
   payload: string;
 
-  /** The consistent method for generating the same set of accounts and wallets for a given private key **/
+  /**
+   * The consistent method for generating the same set of accounts and wallets
+   * for a given private key *
+   */
   derivationPath: string;
 
   /** The status of the payload. **/