@lightsparkdev/lightspark-sdk 1.2.2 → 1.3.0

package/dist/index.js

@@ -86,7 +86,7 @@ import {
   getTransactionQuery,
   getUmaInvitationQuery,
   getWithdrawalQuery
-} from "./chunk-GLL4KTUT.js";
+} from "./chunk-Y55D3PD4.js";
 import {
   BitcoinNetwork_default
 } from "./chunk-K6SAUSAX.js";
@@ -129,22 +129,22 @@ var AccountTokenAuthProvider_default = AccountTokenAuthProvider;
 // src/client.ts
 import autoBind2 from "auto-bind";
 import {
-  createSha256Hash,
   DefaultCrypto as DefaultCrypto2,
   LightsparkAuthException,
   LightsparkException,
   LightsparkSigningException as LightsparkSigningException3,
   NodeKeyCache,
-  pollUntil,
   Requester,
   SigningKeyType as SigningKeyType2,
-  StubAuthProvider
+  StubAuthProvider,
+  createSha256Hash,
+  pollUntil
 } from "@lightsparkdev/core";
 
 // package.json
 var package_default = {
   name: "@lightsparkdev/lightspark-sdk",
-  version: "1.2.2",
+  version: "1.3.0",
   description: "Lightspark JS SDK",
   author: "Lightspark Inc.",
   keywords: [
@@ -213,7 +213,7 @@ var package_default = {
   ],
   scripts: {
     build: "yarn tsc && tsup",
-    "build:watch": "yarn build --watch",
+    "build:watch": "yarn build --watch --clean=false",
     clean: "rm -rf .turbo && rm -rf dist",
     dev: "yarn build -- --watch",
     docs: "typedoc src",
@@ -232,7 +232,7 @@ var package_default = {
   },
   license: "Apache-2.0",
   dependencies: {
-    "@lightsparkdev/core": "1.0.10",
+    "@lightsparkdev/core": "1.0.12",
     "@lightsparkdev/crypto-wasm": "0.1.2",
     "auto-bind": "^5.0.1",
     "crypto-browserify": "^3.12.0",
@@ -259,7 +259,192 @@ var package_default = {
     "tsc-absolute": "^1.0.1",
     tsup: "^7.2.0",
     typedoc: "^0.24.7",
-    typescript: "^4.9.5"
+    typescript: "^5.0.0"
+  }
+};
+
+// src/NodeKeyLoaderCache.ts
+import {
+  DefaultCrypto,
+  LightsparkSigningException as LightsparkSigningException2
+} from "@lightsparkdev/core";
+
+// src/SigningKeyLoader.ts
+import {
+  LightsparkSigningException,
+  SigningKeyType,
+  b64encode as b64encode2,
+  isBrowser
+} from "@lightsparkdev/core";
+
+// src/graphql/RecoverNodeSigningKey.ts
+var RecoverNodeSigningKey = `
+  query RecoverNodeSigningKey($nodeId: ID!) {
+    entity(id: $nodeId) {
+      __typename
+      ... on LightsparkNodeWithOSK {
+        encrypted_signing_private_key {
+          encrypted_value
+          cipher
+        }
+      }
+    }
+  }
+`;
+
+// src/SigningKeyLoader.ts
+var SIGNING_KEY_PATH = "m/5";
+function isNodeIdAndPasswordSigningKeyLoaderArgs(args) {
+  return args.password !== void 0;
+}
+function isMasterSeedSigningKeyLoaderArgs(args) {
+  return args.masterSeed !== void 0;
+}
+var NodeIdAndPasswordSigningKeyLoader = class {
+  nodeId;
+  password;
+  requester;
+  cryptoImpl;
+  constructor(args, requester, cryptoImpl) {
+    this.nodeId = args.nodeId;
+    this.password = args.password;
+    this.requester = requester;
+    this.cryptoImpl = cryptoImpl;
+  }
+  async loadSigningKey() {
+    const encryptedKey = await this.recoverNodeSigningKey();
+    if (!encryptedKey) {
+      console.warn("No encrypted key found for node " + this.nodeId);
+      return;
+    }
+    const signingPrivateKey = await this.cryptoImpl.decryptSecretWithNodePassword(
+      encryptedKey.cipher,
+      encryptedKey.encrypted_value,
+      this.password
+    );
+    if (!signingPrivateKey) {
+      throw new LightsparkSigningException(
+        "Unable to decrypt signing key with provided password. Please try again."
+      );
+    }
+    let signingPrivateKeyPEM = "";
+    if (new Uint8Array(signingPrivateKey)[0] === 48) {
+      signingPrivateKeyPEM = b64encode2(signingPrivateKey);
+    } else {
+      const dec = new TextDecoder();
+      signingPrivateKeyPEM = dec.decode(signingPrivateKey);
+    }
+    return { key: signingPrivateKeyPEM, type: SigningKeyType.RSASigningKey };
+  }
+  async recoverNodeSigningKey() {
+    const response = await this.requester.makeRawRequest(
+      RecoverNodeSigningKey,
+      { nodeId: this.nodeId }
+    );
+    const nodeEntity = response.entity;
+    if (nodeEntity?.__typename === "LightsparkNodeWithOSK") {
+      return nodeEntity.encrypted_signing_private_key;
+    }
+    return null;
+  }
+};
+var MasterSeedSigningKeyLoader = class {
+  masterSeed;
+  network;
+  constructor(args) {
+    this.masterSeed = args.masterSeed;
+    this.network = args.network;
+  }
+  async loadSigningKey() {
+    if (isBrowser) {
+      throw new LightsparkSigningException(
+        "Browser environments not supported for master seed signing key loader."
+      );
+    }
+    const { LightsparkSigner, Network } = await import("@lightsparkdev/crypto-wasm");
+    let cryptoLibNetwork;
+    switch (this.network) {
+      case BitcoinNetwork_default.MAINNET:
+        cryptoLibNetwork = Network.Bitcoin;
+        break;
+      case BitcoinNetwork_default.TESTNET:
+        cryptoLibNetwork = Network.Testnet;
+        break;
+      case BitcoinNetwork_default.REGTEST:
+        cryptoLibNetwork = Network.Regtest;
+        break;
+      default:
+        throw new Error(
+          `Unsupported lightspark_crypto network ${this.network}.`
+        );
+    }
+    const lightsparkSigner = LightsparkSigner.from_bytes(
+      this.masterSeed,
+      cryptoLibNetwork
+    );
+    const privateKey = lightsparkSigner.derive_private_key(SIGNING_KEY_PATH);
+    return { key: privateKey, type: SigningKeyType.Secp256k1SigningKey };
+  }
+};
+
+// src/NodeKeyLoaderCache.ts
+var NodeKeyLoaderCache = class {
+  constructor(nodeKeyCache, cryptoImpl = DefaultCrypto) {
+    this.nodeKeyCache = nodeKeyCache;
+    this.cryptoImpl = cryptoImpl;
+    this.idToLoader = /* @__PURE__ */ new Map();
+  }
+  idToLoader;
+  /**
+   * Sets the signing key loader for a node.
+   * Instantiates a signing key loader based on the type of args passed in by
+   * the user.
+   *
+   * @param nodeId The ID of the node to get the key for
+   * @param loaderArgs Loader arguments for loading the key
+   * @param requester Requester used for loading the key
+   */
+  setLoader(nodeId, loaderArgs, requester) {
+    let loader;
+    if (isNodeIdAndPasswordSigningKeyLoaderArgs(loaderArgs)) {
+      loader = new NodeIdAndPasswordSigningKeyLoader(
+        { nodeId, ...loaderArgs },
+        requester,
+        this.cryptoImpl
+      );
+    } else if (isMasterSeedSigningKeyLoaderArgs(loaderArgs)) {
+      loader = new MasterSeedSigningKeyLoader({ ...loaderArgs });
+    } else {
+      throw new LightsparkSigningException2("Invalid signing key loader args");
+    }
+    this.idToLoader.set(nodeId, loader);
+  }
+  /**
+   * Gets the key for a node using the loader set by [setLoader]
+   *
+   * @param id The ID of the node to get the key for
+   * @returns The loaded key
+   */
+  async getKeyWithLoader(id) {
+    if (this.nodeKeyCache.hasKey(id)) {
+      return this.nodeKeyCache.getKey(id);
+    }
+    const loader = this.idToLoader.get(id);
+    if (!loader) {
+      throw new LightsparkSigningException2(
+        "No signing key loader found for node " + id
+      );
+    }
+    const loaderResult = await loader.loadSigningKey();
+    if (!loaderResult) {
+      return;
+    }
+    const key = await this.nodeKeyCache.loadKey(
+      id,
+      { key: loaderResult.key },
+      loaderResult.type
+    );
+    return key || void 0;
   }
 };
 
@@ -274,6 +459,21 @@ var BitcoinFeeEstimate = `
   ${FRAGMENT2}
 `;
 
+// src/graphql/CancelInvoice.ts
+var CancelInvoice = `
+  mutation CancelInvoice(
+    $invoice_id: ID!
+  ) {
+    cancel_invoice(input: { invoice_id: $invoice_id }) {
+      invoice {
+        ...InvoiceFragment
+      }
+    }
+  }
+
+  ${FRAGMENT4}
+`;
+
 // src/graphql/ClaimUmaInvitation.ts
 var ClaimUmaInvitation = `
     mutation ClaimUmaInvitation(
@@ -290,7 +490,7 @@ var ClaimUmaInvitation = `
         }
     }
 
-${FRAGMENT3}
+${FRAGMENT5}
 `;
 
 // src/graphql/ClaimUmaInvitationWithIncentives.ts
@@ -313,7 +513,7 @@ var ClaimUmaInvitationWithIncentives = `
         }
     }
 
-${FRAGMENT3}
+${FRAGMENT5}
 `;
 
 // src/graphql/CreateApiToken.ts
@@ -333,7 +533,7 @@ var CreateApiToken = `
         }
     }
 
-${FRAGMENT4}
+${FRAGMENT6}
 `;
 
 // src/graphql/CreateInvoice.ts
@@ -374,7 +574,7 @@ mutation CreateLnurlInvoice(
       }
   }
 }
-${FRAGMENT6}
+${FRAGMENT4}
 `;
 
 // src/graphql/CreateNodeWalletAddress.ts
@@ -444,7 +644,7 @@ var CreateUmaInvitation = `
         }
     }
 
-${FRAGMENT3}
+${FRAGMENT5}
 `;
 
 // src/graphql/CreateUmaInvitationWithIncentives.ts
@@ -465,7 +665,7 @@ var CreateUmaInvitationWithIncentives = `
         }
     }
 
-${FRAGMENT3}
+${FRAGMENT5}
 `;
 
 // src/graphql/CreateUmaInvoice.ts
@@ -487,7 +687,7 @@ mutation CreateUmaInvoice(
       }
   }
 }
-${FRAGMENT6}
+${FRAGMENT4}
 `;
 
 // src/graphql/DecodeInvoice.ts
@@ -501,7 +701,7 @@ var DecodeInvoice = `
     }
   }
 
-  ${FRAGMENT5}
+  ${FRAGMENT3}
 `;
 
 // src/graphql/DeleteApiToken.ts
@@ -527,7 +727,7 @@ var FetchUmaInvitation = `
         }
     }
 
-${FRAGMENT3}
+${FRAGMENT5}
 `;
 
 // src/graphql/FundNode.ts
@@ -686,6 +886,33 @@ var PayInvoice = `
   ${FRAGMENT9}
 `;
 
+// src/graphql/PayUmaInvoice.ts
+var PayUmaInvoice = `
+  mutation PayUmaInvoice(
+    $node_id: ID!
+    $encoded_invoice: String!
+    $timeout_secs: Int!
+    $maximum_fees_msats: Long!
+    $amount_msats: Long
+  ) {
+    pay_uma_invoice(
+      input: {
+        node_id: $node_id
+        encoded_invoice: $encoded_invoice
+        timeout_secs: $timeout_secs
+        maximum_fees_msats: $maximum_fees_msats
+        amount_msats: $amount_msats
+      }
+    ) {
+      payment {
+        ...OutgoingPaymentFragment
+      }
+    }
+  }
+
+  ${FRAGMENT9}
+`;
+
 // src/graphql/PaymentRequestsForNode.ts
 var PaymentRequestsForNode = `
 query PaymentRequestsForNode(
@@ -717,33 +944,6 @@ query PaymentRequestsForNode(
 ${FRAGMENT10}
 `;
 
-// src/graphql/PayUmaInvoice.ts
-var PayUmaInvoice = `
-  mutation PayUmaInvoice(
-    $node_id: ID!
-    $encoded_invoice: String!
-    $timeout_secs: Int!
-    $maximum_fees_msats: Long!
-    $amount_msats: Long
-  ) {
-    pay_uma_invoice(
-      input: {
-        node_id: $node_id
-        encoded_invoice: $encoded_invoice
-        timeout_secs: $timeout_secs
-        maximum_fees_msats: $maximum_fees_msats
-        amount_msats: $amount_msats
-      }
-    ) {
-      payment {
-        ...OutgoingPaymentFragment
-      }
-    }
-  }
-
-  ${FRAGMENT9}
-`;
-
 // src/graphql/RequestWithdrawal.ts
 var RequestWithdrawal = `
   mutation RequestWithdrawal(
@@ -906,6 +1106,20 @@ ${FRAGMENT12}
 ${FRAGMENT}
 `;
 
+// src/graphql/TransactionSubscription.ts
+var TransactionSubscription = `
+subscription TransactionSubscription(
+    $nodeIds: [ID!]!
+) {
+    transactions(node_ids: $nodeIds) {
+        ...TransactionUpdateFragment
+        __typename
+    }
+}
+
+${FRAGMENT13}
+`;
+
 // src/graphql/TransactionsForNode.ts
 var TransactionsForNode = `
 query TransactionsForNode(
@@ -945,204 +1159,6 @@ ${FRAGMENT12}
 ${FRAGMENT}
 `;
 
-// src/graphql/TransactionSubscription.ts
-var TransactionSubscription = `
-subscription TransactionSubscription(
-    $nodeIds: [ID!]!
-) {
-    transactions(node_ids: $nodeIds) {
-        ...TransactionUpdateFragment
-        __typename
-    }
-}
-
-${FRAGMENT13}
-`;
-
-// src/NodeKeyLoaderCache.ts
-import {
-  DefaultCrypto,
-  LightsparkSigningException as LightsparkSigningException2
-} from "@lightsparkdev/core";
-
-// src/SigningKeyLoader.ts
-import {
-  b64encode as b64encode2,
-  isBrowser,
-  LightsparkSigningException,
-  SigningKeyType
-} from "@lightsparkdev/core";
-
-// src/graphql/RecoverNodeSigningKey.ts
-var RecoverNodeSigningKey = `
-  query RecoverNodeSigningKey($nodeId: ID!) {
-    entity(id: $nodeId) {
-      __typename
-      ... on LightsparkNodeWithOSK {
-        encrypted_signing_private_key {
-          encrypted_value
-          cipher
-        }
-      }
-    }
-  }
-`;
-
-// src/SigningKeyLoader.ts
-var SIGNING_KEY_PATH = "m/5";
-function isNodeIdAndPasswordSigningKeyLoaderArgs(args) {
-  return args.password !== void 0;
-}
-function isMasterSeedSigningKeyLoaderArgs(args) {
-  return args.masterSeed !== void 0;
-}
-var NodeIdAndPasswordSigningKeyLoader = class {
-  nodeId;
-  password;
-  requester;
-  cryptoImpl;
-  constructor(args, requester, cryptoImpl) {
-    this.nodeId = args.nodeId;
-    this.password = args.password;
-    this.requester = requester;
-    this.cryptoImpl = cryptoImpl;
-  }
-  async loadSigningKey() {
-    const encryptedKey = await this.recoverNodeSigningKey();
-    if (!encryptedKey) {
-      console.warn("No encrypted key found for node " + this.nodeId);
-      return;
-    }
-    const signingPrivateKey = await this.cryptoImpl.decryptSecretWithNodePassword(
-      encryptedKey.cipher,
-      encryptedKey.encrypted_value,
-      this.password
-    );
-    if (!signingPrivateKey) {
-      throw new LightsparkSigningException(
-        "Unable to decrypt signing key with provided password. Please try again."
-      );
-    }
-    let signingPrivateKeyPEM = "";
-    if (new Uint8Array(signingPrivateKey)[0] === 48) {
-      signingPrivateKeyPEM = b64encode2(signingPrivateKey);
-    } else {
-      const dec = new TextDecoder();
-      signingPrivateKeyPEM = dec.decode(signingPrivateKey);
-    }
-    return { key: signingPrivateKeyPEM, type: SigningKeyType.RSASigningKey };
-  }
-  async recoverNodeSigningKey() {
-    const response = await this.requester.makeRawRequest(
-      RecoverNodeSigningKey,
-      { nodeId: this.nodeId }
-    );
-    const nodeEntity = response.entity;
-    if (nodeEntity?.__typename === "LightsparkNodeWithOSK") {
-      return nodeEntity.encrypted_signing_private_key;
-    }
-    return null;
-  }
-};
-var MasterSeedSigningKeyLoader = class {
-  masterSeed;
-  network;
-  constructor(args) {
-    this.masterSeed = args.masterSeed;
-    this.network = args.network;
-  }
-  async loadSigningKey() {
-    if (isBrowser) {
-      throw new LightsparkSigningException(
-        "Browser environments not supported for master seed signing key loader."
-      );
-    }
-    const { LightsparkSigner, Network } = await import("@lightsparkdev/crypto-wasm");
-    let cryptoLibNetwork;
-    switch (this.network) {
-      case BitcoinNetwork_default.MAINNET:
-        cryptoLibNetwork = Network.Bitcoin;
-        break;
-      case BitcoinNetwork_default.TESTNET:
-        cryptoLibNetwork = Network.Testnet;
-        break;
-      case BitcoinNetwork_default.REGTEST:
-        cryptoLibNetwork = Network.Regtest;
-        break;
-      default:
-        throw new Error(
-          `Unsupported lightspark_crypto network ${this.network}.`
-        );
-    }
-    const lightsparkSigner = LightsparkSigner.from_bytes(
-      this.masterSeed,
-      cryptoLibNetwork
-    );
-    const privateKey = lightsparkSigner.derive_private_key(SIGNING_KEY_PATH);
-    return { key: privateKey, type: SigningKeyType.Secp256k1SigningKey };
-  }
-};
-
-// src/NodeKeyLoaderCache.ts
-var NodeKeyLoaderCache = class {
-  constructor(nodeKeyCache, cryptoImpl = DefaultCrypto) {
-    this.nodeKeyCache = nodeKeyCache;
-    this.cryptoImpl = cryptoImpl;
-    this.idToLoader = /* @__PURE__ */ new Map();
-  }
-  idToLoader;
-  /**
-   * Sets the signing key loader for a node.
-   * Instantiates a signing key loader based on the type of args passed in by the user.
-   *
-   * @param nodeId The ID of the node to get the key for
-   * @param loaderArgs Loader arguments for loading the key
-   * @param requester Requester used for loading the key
-   */
-  setLoader(nodeId, loaderArgs, requester) {
-    let loader;
-    if (isNodeIdAndPasswordSigningKeyLoaderArgs(loaderArgs)) {
-      loader = new NodeIdAndPasswordSigningKeyLoader(
-        { nodeId, ...loaderArgs },
-        requester,
-        this.cryptoImpl
-      );
-    } else if (isMasterSeedSigningKeyLoaderArgs(loaderArgs)) {
-      loader = new MasterSeedSigningKeyLoader({ ...loaderArgs });
-    } else {
-      throw new LightsparkSigningException2("Invalid signing key loader args");
-    }
-    this.idToLoader.set(nodeId, loader);
-  }
-  /**
-   * Gets the key for a node using the loader set by [setLoader]
-   *
-   * @param id The ID of the node to get the key for
-   * @returns The loaded key
-   */
-  async getKeyWithLoader(id) {
-    if (this.nodeKeyCache.hasKey(id)) {
-      return this.nodeKeyCache.getKey(id);
-    }
-    const loader = this.idToLoader.get(id);
-    if (!loader) {
-      throw new LightsparkSigningException2(
-        "No signing key loader found for node " + id
-      );
-    }
-    const loaderResult = await loader.loadSigningKey();
-    if (!loaderResult) {
-      return;
-    }
-    const key = await this.nodeKeyCache.loadKey(
-      id,
-      { key: loaderResult.key },
-      loaderResult.type
-    );
-    return key || void 0;
-  }
-};
-
 // src/client.ts
 var sdkVersion = package_default.version;
 var LightsparkClient = class {
@@ -1154,7 +1170,8 @@ var LightsparkClient = class {
    *     use, you should use the `AccountTokenAuthProvider`.
    * @param serverUrl The base URL of the server to connect to. Defaults to lightspark production.
    * @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`.
+   *     For React Native, you should use the `ReactNativeCrypto`
+   *     implementation from `@lightsparkdev/react-native`.
    */
   constructor(authProvider = new StubAuthProvider(), serverUrl = "api.lightspark.com", cryptoImpl = DefaultCrypto2) {
     this.authProvider = authProvider;
@@ -1180,9 +1197,11 @@ var LightsparkClient = class {
   nodeKeyLoaderCache;
   LIGHTSPARK_SDK_ENDPOINT = process.env.LIGHTSPARK_SDK_ENDPOINT || "graphql/server/2023-09-13";
   /**
-   * Sets the key loader for a node. This unlocks client operations that require a private key.
-   * Passing in [NodeIdAndPasswordSigningKeyLoaderArgs] loads the RSA key for an OSK node.
-   * Passing in [MasterSeedSigningKeyLoaderArgs] loads the Secp256k1 key for a remote signing node.
+   * Sets the key loader for a node. This unlocks client operations that
+   * require a private key. Passing in [NodeIdAndPasswordSigningKeyLoaderArgs]
+   * loads the RSA key for an OSK node.
+   * Passing in [MasterSeedSigningKeyLoaderArgs] loads the Secp256k1 key for a
+   * remote signing node.
    *
    * @param nodeId The ID of the node the key is for
    * @param loader The loader for the key
@@ -1193,7 +1212,8 @@ var LightsparkClient = class {
     return !!key;
   }
   /**
-   * Gets the signing key for a node. Must have previously called [loadNodeSigningKey].
+   * Gets the signing key for a node. Must have previously called
+   * [loadNodeSigningKey].
    *
    * @param nodeId The ID of the node the key is for
    * @returns The signing key for the node
@@ -1202,7 +1222,8 @@ var LightsparkClient = class {
     return await this.nodeKeyLoaderCache.getKeyWithLoader(nodeId);
   }
   /**
-   * Sets the auth provider for the client. This is useful for switching between auth providers if you are using
+   * Sets the auth provider for the client.
+   * This is useful for switching between auth providers if you are using
    * multiple accounts or waiting for the user to log in.
    *
    * @param authProvider
@@ -1281,7 +1302,8 @@ var LightsparkClient = class {
     ) ?? [];
   }
   /**
-   * Starts listening for new transactions or updates to existing transactions for a list of nodes.
+   * Starts listening for new transactions or updates to existing transactions
+   * for a list of nodes.
    *
    * @param nodeIds The node IDs for which to listen to transactions.
    * @returns A zen-observable that emits transaction updates for the given node IDs.
@@ -1298,8 +1320,8 @@ var LightsparkClient = class {
     );
   }
   /**
-   * Retrieves a dashboard of basic info for the authenticated account. See `AccountDashboard` for which info is
-   * included.
+   * Retrieves a dashboard of basic info for the authenticated account.
+   * See `AccountDashboard` for which info is included.
    *
    * @param nodeIds The node IDs to include in the dashboard. Defaults to undefined (all nodes).
    * @param bitcoinNetwork The bitcoin network to include in the dashboard. Defaults to MAINNET.
@@ -1366,8 +1388,8 @@ var LightsparkClient = class {
     };
   }
   /**
-   * Gets a basic dashboard for a single node, including recent transactions. See `SingleNodeDashboard` for which info is
-   * included.
+   * Gets a basic dashboard for a single node, including recent transactions.
+   * See `SingleNodeDashboard` for which info is included.
    *
    * @param nodeId The node ID for which to get a dashboard.
    * @param bitcoinNetwork The bitcoin network for which to get a dashboard. Defaults to MAINNET.
@@ -1438,7 +1460,8 @@ var LightsparkClient = class {
   /**
    * Creates an invoice for the given node.
    *
-   * Test mode note: You can simulate a payment of this invoice in test move using [createTestModePayment].
+   * 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.
@@ -1466,11 +1489,13 @@ var LightsparkClient = class {
     return response.create_invoice?.invoice.data?.encoded_payment_request;
   }
   /**
-   * Generates a Lightning Invoice (follows the Bolt 11 specification) to request a payment
-   * from another Lightning Node. This should only be used for generating invoices for LNURLs,
+   * Generates a Lightning Invoice (follows the Bolt 11 specification) to
+   * request a payment from another Lightning Node.
+   * This should only be used for generating invoices for LNURLs,
    * with [createInvoice] preferred in the general case.
    *
-   * Test mode note: You can simulate a payment of this invoice in test move using [createTestModePayment].
+   * 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.
@@ -1501,10 +1526,12 @@ var LightsparkClient = class {
     return InvoiceFromJson(invoiceJson);
   }
   /**
-   * Creates a new invoice for the UMA protocol. The metadata is hashed and included in the invoice.
-   * This API generates a Lightning Invoice (follows the Bolt 11 specification) to request a payment
-   * from another Lightning Node. This should only be used for generating invoices for UMA, with `createInvoice`
-   * preferred in the general case.
+   * Creates a new invoice for the UMA protocol.
+   * The metadata is hashed and included in the invoice.
+   * This API generates a Lightning Invoice (follows the Bolt 11 specification)
+   * to request a payment from another Lightning Node.
+   * This should only be used for generating invoices for UMA,
+   * with `createInvoice` preferred in the general case.
    *
    * @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.
@@ -1532,6 +1559,22 @@ var LightsparkClient = class {
     }
     return InvoiceFromJson(invoiceJson);
   }
+  /**
+   * Cancels an existing unpaid invoice and returns that invoice. Cancelled invoices cannot be paid.
+   *
+   * @param invoiceId The ID of the invoice to cancel.
+   * @returns The cancelled invoice, or undefined if the invoice could not be cancelled.
+   */
+  async cancelInvoice(invoiceId) {
+    const response = await this.requester.makeRawRequest(CancelInvoice, {
+      invoice_id: invoiceId
+    });
+    const invoiceJson = response.cancel_invoice?.invoice;
+    if (!invoiceJson) {
+      return void 0;
+    }
+    return InvoiceFromJson(invoiceJson);
+  }
   /**
    * Decodes an encoded lightning invoice string.
    *
@@ -1545,7 +1588,8 @@ var LightsparkClient = class {
     return InvoiceDataFromJson(response.decoded_payment_request);
   }
   /**
-   * Gets an estimate of the fee for sending a payment over the given bitcoin network.
+   * Gets an estimate of the fee for sending a payment over the given bitcoin
+   * network.
    *
    * @param bitcoinNetwork The bitcoin network for which to get a fee estimate. Defaults to MAINNET.
    * @returns A fee estimate for the given bitcoin network including a minimum fee rate, and a max-speed fee rate.
@@ -1582,7 +1626,8 @@ var LightsparkClient = class {
     );
   }
   /**
-   * Returns an estimate of the fees that will be paid to send a payment to another Lightning node.
+   * Returns an estimate of the fees that will be paid to send a payment to
+   * another Lightning node.
    *
    * @param nodeId The node from where you want to send the payment.
    * @param destinationNodePublicKey The public key of the node that you want to pay.
@@ -1618,17 +1663,20 @@ var LightsparkClient = class {
   /**
    * 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.
+   * 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.
-   *     As guidance, a maximum fee of 16 basis points should make almost all transactions succeed. For example,
-   *     for a transaction between 10k sats and 100k sats, this would mean a fee limit of 16 to 160 sats.
+   *     As guidance, a maximum fee of 16 basis points should make almost all
+   *     transactions succeed. For example,
+   *     for a transaction between 10k sats and 100k sats,
+   *     this would mean a fee limit of 16 to 160 sats.
    * @param timeoutSecs A timeout for the payment in seconds. Defaults to 60 seconds.
    * @param amountMsats The amount to pay in msats for a zero-amount invoice. Defaults to the full amount of the
-   *     invoice. NOTE: This parameter can only be passed for a zero-amount invoice. Otherwise, the call will fail.
+   *     invoice. NOTE: This parameter can only be passed for a zero-amount
+   *     invoice. Otherwise, the call will fail.
    * @returns An `OutgoingPayment` object if the payment was successful, or undefined if the payment failed.
    */
   async payInvoice(payerNodeId, encodedInvoice, maximumFeesMsats, timeoutSecs = 60, amountMsats = void 0) {
@@ -1658,18 +1706,23 @@ var LightsparkClient = class {
     return response.pay_invoice && OutgoingPaymentFromJson(response.pay_invoice.payment);
   }
   /**
-   * sends an UMA payment to a node on the Lightning Network, based on the invoice
-   * (as defined by the BOLT11 specification) that you provide.
-   * This should only be used for paying UMA invoices, with `payInvoice` preferred in the general case.
+   * sends an UMA payment to a node on the Lightning Network,
+   * based on the invoice (as defined by the BOLT11 specification) that you
+   * provide.
+   * This should only be used for paying UMA invoices,
+   * with `payInvoice` preferred in the general case.
    *
    * @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.
-   *     As guidance, a maximum fee of 16 basis points should make almost all transactions succeed. For example,
-   *     for a transaction between 10k sats and 100k sats, this would mean a fee limit of 16 to 160 sats.
+   *     As guidance, a maximum fee of 16 basis points should make almost all
+   *     transactions succeed. For example,
+   *     for a transaction between 10k sats and 100k sats,
+   *     this would mean a fee limit of 16 to 160 sats.
    * @param timeoutSecs A timeout for the payment in seconds. Defaults to 60 seconds.
    * @param amountMsats The amount to pay in msats for a zero-amount invoice. Defaults to the full amount of the
-   *     invoice. NOTE: This parameter can only be passed for a zero-amount invoice. Otherwise, the call will fail.
+   *     invoice. NOTE: This parameter can only be passed for a zero-amount
+   *     invoice. Otherwise, the call will fail.
    * @returns An `OutgoingPayment` object if the payment was successful, or undefined if the payment failed.
    */
   async payUmaInvoice(payerNodeId, encodedInvoice, maximumFeesMsats, timeoutSecs = 60, amountMsats = void 0) {
@@ -1699,7 +1752,8 @@ var LightsparkClient = class {
     return response.pay_uma_invoice && OutgoingPaymentFromJson(response.pay_invoice.payment);
   }
   /**
-   * Waits for a transaction to have a completed status, and returns the transaction.
+   * Waits for a transaction to have a completed status, and returns the
+   * transaction.
    *
    * @param transactionId The ID of the transaction to wait for
    * @param pollTimeoutSecs The timeout in seconds that we will wait before throwing an exception
@@ -1736,15 +1790,18 @@ var LightsparkClient = class {
     return transaction;
   }
   /**
-   * Sends a payment directly to a node on the Lightning Network through the public key of the node without an invoice.
+   * Sends a payment directly to a node on the Lightning Network through the
+   * public key of the node without an invoice.
    *
    * @param payerNodeId The ID of the node that will send the payment.
    * @param destinationPublicKey The public key of the destination node.
    * @param timeoutSecs The timeout in seconds that we will try to make the payment.
    * @param amountMsats The amount to pay in msats.
    * @param maximumFeesMsats Maximum fees (in msats) to pay for the payment. This parameter is required.
-   *     As guidance, a maximum fee of 15 basis points should make almost all transactions succeed. For example,
-   *     for a transaction between 10k sats and 100k sats, this would mean a fee limit of 15 to 150 sats.
+   *     As guidance, a maximum fee of 15 basis points should make almost all
+   *     transactions succeed. For example,
+   *     for a transaction between 10k sats and 100k sats,
+   *     this would mean a fee limit of 15 to 150 sats.
    * @returns An `OutgoingPayment` object if the payment was successful, or undefined if the payment failed.
    */
   async sendPayment(payerNodeId, destinationPublicKey, timeoutSecs = 60, amountMsats, maximumFeesMsats) {
@@ -1771,7 +1828,8 @@ var LightsparkClient = class {
     return response.send_payment && OutgoingPaymentFromJson(response.send_payment.payment);
   }
   /**
-   * Creates an L1 Bitcoin wallet address for a given node which can be used to deposit or withdraw funds.
+   * Creates an L1 Bitcoin wallet address for a given node which can be used to
+   * deposit or withdraw funds.
    *
    * @param nodeId The ID of the node to create a wallet address for.
    * @returns A string containing the wallet address for the given node.
@@ -1784,12 +1842,15 @@ var LightsparkClient = class {
     return response.create_node_wallet_address.wallet_address;
   }
   /**
-   * Withdraws funds from the account and sends it to the requested bitcoin address.
+   * Withdraws funds from the account and sends it to the requested bitcoin
+   * address.
    *
-   * Depending on the chosen mode, it will first take the funds from the wallet, and if applicable, close channels
-   * appropriately to recover enough funds and reopen channels with the remaining funds.
-   * The process is asynchronous and may take up to a few minutes. You can check the progress by polling the
-   * `WithdrawalRequest` that is created, or by subscribing to a webhook.
+   * Depending on the chosen mode, it will first take the funds from the
+   * wallet, and if applicable, close channels appropriately to recover enough
+   * funds and reopen channels with the remaining funds.
+   * The process is asynchronous and may take up to a few minutes.
+   * You can check the progress by polling the `WithdrawalRequest` that is
+   * created, or by subscribing to a webhook.
    *
    * @param nodeId The ID of the node from which to withdraw funds.
    * @param amountSats The amount of funds to withdraw in satoshis.
@@ -1810,9 +1871,10 @@ var LightsparkClient = class {
     return WithdrawalRequestFromJson(response.request_withdrawal.request);
   }
   /**
-   * Adds funds to a Lightspark node on the REGTEST network. If the amount is not specified, 10,000,000 SATOSHI will be
-   * added. This API only functions for nodes created on the REGTEST network and will return an error when called for
-   * any non-REGTEST node.
+   * Adds funds to a Lightspark node on the REGTEST network.
+   * If the amount is not specified, 10,000,000 SATOSHI will be added.
+   * This API only functions for nodes created on the REGTEST network and will
+   * return an error when called for any non-REGTEST node.
    *
    * @param nodeId The ID of the node to fund. Must be a REGTEST node.
    * @param amountSats The amount of funds to add to the node in satoshis. Defaults to 10,000,000 SATOSHI.
@@ -1826,8 +1888,8 @@ var LightsparkClient = class {
     return CurrencyAmountFromJson(response.fund_node.amount);
   }
   /**
-   * Creates a new API token that can be used to authenticate requests for this account when using the Lightspark APIs
-   * and SDKs.
+   * Creates a new API token that can be used to authenticate requests for this
+   * account when using the Lightspark APIs and SDKs.
    *
    * @param name Creates a new API token that can be used to authenticate requests for this account when using the
    *     Lightspark APIs and SDKs.
@@ -1864,8 +1926,9 @@ var LightsparkClient = class {
     await this.requester.makeRawRequest(DeleteApiToken, { api_token_id: id });
   }
   /**
-   * 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].
+   * 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.
@@ -1894,8 +1957,9 @@ var LightsparkClient = class {
     });
   }
   /**
-   * 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].
+   * 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.
@@ -1918,8 +1982,8 @@ var LightsparkClient = class {
     });
   }
   /**
-   * Creates an UMA invitation. If you are part of the incentive program, you should use
-   * [createUmaInvitationWithIncentives].
+   * Creates an UMA invitation. If you are part of the incentive program,
+   * you should use [createUmaInvitationWithIncentives].
    *
    * @param inviterUma The UMA of the inviter.
    * @returns The invitation that was created.
@@ -1973,8 +2037,8 @@ var LightsparkClient = class {
     });
   }
   /**
-   * Claims an UMA invitation. If you are part of the incentive program, you should use
-   * [claimUmaInvitationWithIncentives].
+   * Claims an UMA invitation. If you are part of the incentive program,
+   * you should use [claimUmaInvitationWithIncentives].
    *
    * @param invitationCode The invitation code to claim.
    * @param inviteeUma The UMA of the invitee.
@@ -2065,7 +2129,8 @@ var LightsparkClient = class {
   /**
    * Executes a raw `Query` against the Lightspark API.
    *
-   * This generally should not be used directly, but is exposed for advanced use cases and for internal use to retrieve
+   * This generally should not be used directly,
+   * but is exposed for advanced use cases and for internal use to retrieve
    * complex fields from objects.
    *
    * @param query The `Query` to execute.