@lightsparkdev/lightspark-sdk 1.2.0 → 1.2.1

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/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);

package/src/objects/OutgoingPaymentAttempt.ts

@@ -22,17 +22,43 @@ 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 attempt was initiated. **/
     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 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);

package/src/objects/Wallet.ts

@@ -20,14 +20,26 @@ import { WalletToTransactionsConnectionFromJson } from "./WalletToTransactionsCo
 /** This object represents a Lightspark Wallet, tied to your Lightspark account. Wallets can be used to send or receive funds over the Lightning Network. You can retrieve this object to receive information about a specific wallet tied to your Lightspark account. **/
 class Wallet implements LightsparkNodeOwner, 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 unique identifier of this wallet, as provided by the Lightspark Customer during login. **/
     public readonly thirdPartyIdentifier: string,
+    /** The status of this wallet. **/
     public readonly status: WalletStatus,
+    /** The typename of the object **/
     public readonly typename: string,
+    /** The date and time when the wallet user last logged in. **/
     public readonly lastLoginAt?: string | undefined,
+    /** The balances that describe the funds in this wallet. **/
     public readonly balances?: Balances | undefined,
+    /** The account this wallet belongs to. **/
     public readonly accountId?: string | undefined,
   ) {
     autoBind(this);

package/src/objects/WithdrawalRequest.ts

@@ -19,16 +19,33 @@ import { WithdrawalRequestToChannelOpeningTransactionsConnectionFromJson } from
 /** This object represents a request made for an L1 withdrawal from your Lightspark Node to any Bitcoin wallet. You can retrieve this object to receive detailed information about any withdrawal request made from your Lightspark account. **/
 class WithdrawalRequest 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 amount of money that should be withdrawn in this request. **/
     public readonly amount: CurrencyAmount,
+    /** The bitcoin address where the funds should be sent. **/
     public readonly bitcoinAddress: string,
+    /** The strategy that should be used to withdraw the funds from the account. **/
     public readonly withdrawalMode: WithdrawalMode,
+    /** The current status of this withdrawal request. **/
     public readonly status: WithdrawalRequestStatus,
+    /** The typename of the object **/
     public readonly typename: string,
+    /**
+     * If the requested amount is `-1` (i.e. everything), this field may contain an estimate of the amount
+     * for the withdrawal.
+     **/
     public readonly estimatedAmount?: CurrencyAmount | undefined,
+    /** The time at which this request was completed. **/
     public readonly completedAt?: string | undefined,
+    /** The withdrawal transaction that has been generated by this request. **/
     public readonly withdrawalId?: string | undefined,
   ) {
     autoBind(this);

package/src/tests/integration/constants.ts

@@ -0,0 +1,13 @@
+export const TESTS_TIMEOUT = 60_000; //ms
+export const LONG_TEST_TIMEOUT = 600_0000; //ms
+export const DAY_IN_MS = 86400000; //ms
+export const INVOICE_EXPIRY = 172800; //ms
+export const TRANSACTION_WAIT_TIME = TESTS_TIMEOUT / 1000; //seconds
+export const PAGINATION_STEP = 3;
+
+export const PAY_AMOUNT = 1_000; //msats
+export const MAX_FEE = 10000000; //msats
+
+export const REGTEST_SIGNING_KEY_PASSWORD = "1234!@#$";
+export const ENCODED_REGTEST_REQUEST_FOR_TESTS =
+  "lnbcrt1pjj6zu2pp50qr2p79v65u9l8w3859259yj9fe5nt79hfw5k2am424440tlj09qdq0dp5jqargv4ex2ggcqzpgxqyz5vqsp5v0z0fu99jf37xcasu88evuphx9kdrpvtupdvhu329kx7k7un59zs9qyyssqegzx986rszy96te2kmxl7prlz0p8avthpwzhsz5v220uek7xxrz54svdsjpzwn04m6utj5ua9tmtktygc5xmjmjaqey9dadt33r8gxspvcg8wv";