@lightsparkdev/lightspark-sdk 0.2.7 → 0.3.0

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @lightsparkdev/lightspark-sdk
 
+## 0.3.0
+
+### Minor Changes
+
+- d14f64e: Release
+
+### Patch Changes
+
+- Updated dependencies [d14f64e]
+  - @lightsparkdev/core@0.3.0
+
+## 0.2.8
+
+### Patch Changes
+
+- Updated dependencies [615bb86]
+  - @lightsparkdev/core@0.2.5
+
 ## 0.2.7
 
 ### Patch Changes

package/dist/{Withdrawal-82dbbfd6.d.ts → Withdrawal-e4b8b697.d.ts}

@@ -1,4 +1,4 @@
-import { Maybe, Query, AuthProvider, CryptoInterface } from '@lightsparkdev/core';
+import { Maybe, Query, AuthProvider, CryptoInterface, KeyOrAliasType } from '@lightsparkdev/core';
 import Observable from 'zen-observable';
 
 declare enum CurrencyUnit {
@@ -1138,7 +1138,7 @@ declare class WithdrawalRequest implements Entity {
  * const invoiceDetails = await lightsparkClient.decodeInvoice(encodedInvoice);
  * console.log(invoiceDetails);
  *
- * const payment = await lightsparkClient.payInvoice(PAYING_NODE_ID, encodedInvoice, 1000);
+ * const payment = await lightsparkClient.payInvoice(PAYING_NODE_ID, encodedInvoice, 100000);
  * console.log(payment);
  * ```
  *
@@ -1156,8 +1156,8 @@ declare class LightsparkClient {
      * @param authProvider The auth provider to use for authentication. Defaults to a stub auth provider. For server-side
      *     use, you should use the `AccountTokenAuthProvider`.
      * @param serverUrl The base URL of the server to connect to. Defaults to lightspark production.
-     * @param nodeKeyCache This is used to cache node keys for the duration of the session. Defaults to a new instance of
-     *     `NodeKeyCache`. You should not need to change this.
+     * @param cryptoImpl The crypto implementation to use. Defaults to web and node compatible crypto.
+     *     For React Native, you should use the `ReactNativeCrypto` implementation from `@lightsparkdev/react-native`.
      */
     constructor(authProvider?: AuthProvider, serverUrl?: string, cryptoImpl?: CryptoInterface);
     /**
@@ -1216,6 +1216,8 @@ declare class LightsparkClient {
     /**
      * Creates an invoice for the given node.
      *
+     * Test mode note: You can simulate a payment of this invoice in test move using [createTestModePayment].
+     *
      * @param nodeId The node ID for which to create an invoice.
      * @param amountMsats The amount of the invoice in msats. You can create a zero-amount invoice to accept any payment amount.
      * @param memo A string memo to include in the invoice as a description.
@@ -1268,15 +1270,18 @@ declare class LightsparkClient {
     unlockNode(nodeId: string, password: string): Promise<boolean>;
     private recoverNodeSigningKey;
     /**
-     * Directly unlocks a node with a signing private key.
+     * Directly unlocks a node with a signing private key or alias.
      *
      * @param nodeId The ID of the node to unlock.
      * @param signingPrivateKeyPEM The PEM-encoded signing private key.
      */
-    loadNodeKey(nodeId: string, signingPrivateKeyPEM: string): Promise<void>;
+    loadNodeKey(nodeId: string, signingPrivateKeyOrAlias: KeyOrAliasType): Promise<void>;
     /**
      * Sends a lightning payment for a given invoice.
      *
+     * Test mode note: For test mode, you can use the [createTestModeInvoice] function to create an invoice you can
+     * pay in test mode.
+     *
      * @param payerNodeId The ID of the node that will pay the invoice.
      * @param encodedInvoice The encoded invoice to pay.
      * @param maximumFeesMsats Maximum fees (in msats) to pay for the payment. This parameter is required.
@@ -1349,6 +1354,26 @@ declare class LightsparkClient {
      * @param id The ID of the API token to delete.
      */
     deleteApiToken(id: string): Promise<void>;
+    /**
+     * In test mode, generates a Lightning Invoice which can be paid by a local node.
+     * This call is only valid in test mode. You can then pay the invoice using [payInvoice].
+     *
+     * @param localNodeId The ID of the node that will pay the invoice.
+     * @param amountMsats The amount to pay in milli-satoshis.
+     * @param memo An optional memo to attach to the invoice.
+     * @param invoiceType The type of invoice to create.
+     */
+    createTestModeInvoice(localNodeId: string, amountMsats: number, memo?: string | undefined, invoiceType?: InvoiceType): Promise<string | null>;
+    /**
+     * In test mode, simulates a payment of a Lightning Invoice from another node.
+     * This can only be used in test mode and should be used with invoices generated by [createInvoice].
+     *
+     * @param localNodeId The ID of the node that will receive the payment.
+     * @param encodedInvoice The encoded invoice to pay.
+     * @param amountMsats The amount to pay in milli-satoshis for 0-amount invoices. This should be null for non-zero
+     *     amount invoices.
+     */
+    createTestModePayment(localNodeId: string, encodedInvoice: string, amountMsats?: number | undefined): Promise<OutgoingPayment | null>;
     /**
      * Executes a raw `Query` against the Lightspark API.
      *

package/dist/{chunk-2T6E6TXJ.js → chunk-7GDCZ2RB.js}

@@ -5702,6 +5702,11 @@ export {
   ApiTokenFromJson,
   FRAGMENT as FRAGMENT3,
   getApiTokenQuery,
+  HtlcAttemptFailureCode_default,
+  OutgoingPaymentAttemptStatus_default,
+  getHopQuery,
+  OutgoingPaymentAttempt_default,
+  PaymentFailureReason_default,
   BitcoinNetwork_default,
   NodeAddressType_default,
   GraphNode_default,
@@ -5711,18 +5716,13 @@ export {
   Channel_default,
   LightsparkNode_default,
   Node_default,
-  InvoiceDataFromJson,
-  FRAGMENT7 as FRAGMENT4,
-  FRAGMENT22 as FRAGMENT5,
-  HtlcAttemptFailureCode_default,
-  OutgoingPaymentAttemptStatus_default,
-  getHopQuery,
-  OutgoingPaymentAttempt_default,
-  PaymentFailureReason_default,
   TransactionStatus_default,
   OutgoingPaymentFromJson,
-  FRAGMENT13 as FRAGMENT6,
+  FRAGMENT13 as FRAGMENT4,
   OutgoingPayment_default,
+  InvoiceDataFromJson,
+  FRAGMENT7 as FRAGMENT5,
+  FRAGMENT22 as FRAGMENT6,
   WithdrawalMode_default,
   WithdrawalRequestStatus_default,
   getChannelClosingTransactionQuery,