@lightsparkdev/lightspark-sdk 1.0.0 → 1.0.2

package/dist/index.js

@@ -1,8 +1,12 @@
+import {
+  assertValidBitcoinNetwork,
+  getBitcoinNetworkOrThrow,
+  isBitcoinNetwork
+} from "./chunk-5RDIWPBE.js";
 import {
   AccountToChannelsConnection_default,
   Account_default,
   ApiTokenFromJson,
-  BitcoinNetwork_default,
   ChannelStatus_default,
   Channel_default,
   ComplianceProvider_default,
@@ -72,7 +76,10 @@ import {
   getSignableQuery,
   getTransactionQuery,
   getWithdrawalQuery
-} from "./chunk-LZC5C5NI.js";
+} from "./chunk-K2ZU5YQL.js";
+import {
+  BitcoinNetwork_default
+} from "./chunk-K6SAUSAX.js";
 import "./chunk-NIMBE7W3.js";
 
 // src/auth/AccountTokenAuthProvider.ts
@@ -122,7 +129,7 @@ import { createHash } from "crypto";
 // package.json
 var package_default = {
   name: "@lightsparkdev/lightspark-sdk",
-  version: "1.0.0",
+  version: "1.0.2",
   description: "Lightspark JS SDK",
   author: "Lightspark Inc.",
   keywords: [
@@ -163,6 +170,16 @@ var package_default = {
       module: "./dist/objects/index.js",
       require: "./dist/objects/index.cjs",
       default: "./dist/objects/index.cjs"
+    },
+    "./env": {
+      types: "./dist/env.d.ts",
+      import: {
+        types: "./dist/env.d.ts",
+        default: "./dist/env.js"
+      },
+      module: "./dist/env.js",
+      require: "./dist/env.cjs",
+      default: "./dist/env.cjs"
     }
   },
   type: "module",
@@ -180,7 +197,7 @@ var package_default = {
     "CHANGELOG.md"
   ],
   scripts: {
-    build: "tsup",
+    build: "yarn tsc && tsup",
     clean: "rm -rf .turbo && rm -rf dist",
     dev: "yarn build -- --watch",
     docs: "typedoc src",
@@ -197,11 +214,13 @@ var package_default = {
   },
   license: "Apache-2.0",
   dependencies: {
-    "@lightsparkdev/core": "1.0.0",
+    "@lightsparkdev/core": "1.0.1",
+    "@lightsparkdev/crypto-wasm": "0.1.0",
     "auto-bind": "^5.0.1",
     crypto: "^1.0.1",
     "crypto-browserify": "^3.12.0",
     dayjs: "^1.11.7",
+    dotenv: "^16.3.1",
     graphql: "^16.6.0",
     "graphql-ws": "^5.11.3",
     ws: "^8.12.1",
@@ -801,12 +820,14 @@ ${FRAGMENT10}
 
 // src/NodeKeyLoaderCache.ts
 import {
+  DefaultCrypto,
   LightsparkSigningException as LightsparkSigningException2
 } from "@lightsparkdev/core";
 
 // src/SigningKeyLoader.ts
 import {
   b64encode as b64encode2,
+  isBrowser,
   LightsparkSigningException,
   SigningKeyType
 } from "@lightsparkdev/core";
@@ -827,25 +848,7 @@ var RecoverNodeSigningKey = `
 `;
 
 // src/SigningKeyLoader.ts
-import {
-  LightsparkSigner,
-  Network
-} from "../src/lightspark_crypto/lightspark_crypto.js";
 var SIGNING_KEY_PATH = "m/5";
-var getCryptoLibNetwork = (bitcoinNetwork) => {
-  switch (bitcoinNetwork) {
-    case BitcoinNetwork_default.MAINNET:
-      return Network.Bitcoin;
-    case BitcoinNetwork_default.TESTNET:
-      return Network.Testnet;
-    case BitcoinNetwork_default.REGTEST:
-      return Network.Regtest;
-    default:
-      throw new Error(
-        `Unsupported lightspark_crypto network ${bitcoinNetwork}.`
-      );
-  }
-};
 function isNodeIdAndPasswordSigningKeyLoaderArgs(args) {
   return args.password !== void 0;
 }
@@ -908,9 +911,31 @@ var MasterSeedSigningKeyLoader = class {
     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,
-      getCryptoLibNetwork(this.network)
+      cryptoLibNetwork
     );
     const privateKey = lightsparkSigner.derive_private_key(SIGNING_KEY_PATH);
     return { key: privateKey, type: SigningKeyType.Secp256k1SigningKey };
@@ -968,11 +993,12 @@ var NodeKeyLoaderCache = class {
     if (!loaderResult) {
       return;
     }
-    return this.nodeKeyCache.loadKey(
+    const key = await this.nodeKeyCache.loadKey(
       id,
       { key: loaderResult.key },
       loaderResult.type
     );
+    return key || void 0;
   }
 };
 
@@ -1764,7 +1790,9 @@ export {
   WithdrawalMode_default as WithdrawalMode,
   WithdrawalRequest_default as WithdrawalRequest,
   WithdrawalRequestStatus_default as WithdrawalRequestStatus,
+  assertValidBitcoinNetwork,
   getApiTokenQuery,
+  getBitcoinNetworkOrThrow,
   getChannelClosingTransactionQuery,
   getChannelOpeningTransactionQuery,
   getDepositQuery,
@@ -1780,5 +1808,6 @@ export {
   getSignableQuery,
   getTransactionQuery,
   getWithdrawalQuery,
+  isBitcoinNetwork,
   verifyAndParseWebhook
 };

package/dist/objects/index.d.ts

@@ -1,3 +1,4 @@
-export { A as Account, a as AccountToApiTokensConnection, b as AccountToChannelsConnection, c as AccountToNodesConnection, d as AccountToPaymentRequestsConnection, e as AccountToTransactionsConnection, f as AccountToWalletsConnection, g as ApiToken, B as Balances, i as BitcoinNetwork, j as BlockchainBalance, C as Channel, k as ChannelClosingTransaction, m as ChannelFees, n as ChannelOpeningTransaction, p as ChannelStatus, q as ChannelToTransactionsConnection, r as ComplianceProvider, s as Connection, t as CreateApiTokenInput, u as CreateApiTokenOutput, v as CreateInvoiceInput, w as CreateInvoiceOutput, x as CreateLnurlInvoiceInput, y as CreateNodeWalletAddressInput, z as CreateNodeWalletAddressOutput, D as CreateTestModeInvoiceInput, E as CreateTestModeInvoiceOutput, F as CreateTestModePaymentInput, G as CreateTestModePaymentoutput, H as CreateUmaInvoiceInput, I as CurrencyAmount, J as CurrencyUnit, K as DeclineToSignMessagesInput, M as DeclineToSignMessagesOutput, N as DeleteApiTokenInput, O as DeleteApiTokenOutput, P as Deposit, R as Entity, S as FeeEstimate, T as FundNodeInput, U as FundNodeOutput, V as GraphNode, X as Hop, Z as HtlcAttemptFailureCode, _ as IdAndSignature, $ as IncomingPayment, a0 as IncomingPaymentAttempt, a2 as IncomingPaymentAttemptStatus, a3 as IncomingPaymentToAttemptsConnection, a4 as Invoice, a6 as InvoiceData, a7 as InvoiceType, a8 as LightningFeeEstimateForInvoiceInput, a9 as LightningFeeEstimateForNodeInput, aa as LightningFeeEstimateOutput, ab as LightningTransaction, ad as LightsparkNode, ae as LightsparkNodeOwner, ag as LightsparkNodeStatus, ah as LightsparkNodeToChannelsConnection, ai as LightsparkNodeWithOSK, aj as LightsparkNodeWithRemoteSigning, ak as Node, al as NodeAddress, am as NodeAddressType, an as NodeToAddressesConnection, ao as OnChainTransaction, aq as OutgoingPayment, ar as OutgoingPaymentAttempt, as as OutgoingPaymentAttemptStatus, at as OutgoingPaymentAttemptToHopsConnection, aw as OutgoingPaymentToAttemptsConnection, au as OutgoingPaymentsForInvoiceQueryInput, av as OutgoingPaymentsForInvoiceQueryOutput, ax as PageInfo, ay as PayInvoiceInput, az as PayInvoiceOutput, aG as PayUmaInvoiceInput, aA as PaymentDirection, aB as PaymentFailureReason, aC as PaymentRequest, aE as PaymentRequestData, aF as PaymentRequestStatus, aH as Permission, aI as PostTransactionData, aJ as RegisterPaymentInput, aK as RegisterPaymentOutput, aL as ReleaseChannelPerCommitmentSecretInput, aM as ReleaseChannelPerCommitmentSecretOutput, aN as ReleasePaymentPreimageInput, aO as ReleasePaymentPreimageOutput, aP as RemoteSigningSubEventType, aQ as RequestWithdrawalInput, aR as RequestWithdrawalOutput, aS as RichText, aT as RiskRating, aU as RoutingTransaction, aW as RoutingTransactionFailureReason, aX as ScreenNodeInput, aY as ScreenNodeOutput, aZ as Secret, a_ as SendPaymentInput, a$ as SendPaymentOutput, b0 as SetInvoicePaymentHashInput, b1 as SetInvoicePaymentHashOutput, b7 as SignInvoiceInput, b8 as SignInvoiceOutput, b9 as SignMessagesInput, ba as SignMessagesOutput, b2 as Signable, b4 as SignablePayload, b6 as SignablePayloadStatus, bb as SingleNodeDashboard, bc as Transaction, be as TransactionFailures, bf as TransactionStatus, bg as TransactionType, bh as TransactionUpdate, bi as UpdateChannelPerCommitmentPointInput, bj as UpdateChannelPerCommitmentPointOutput, bk as UpdateNodeSharedSecretInput, bl as UpdateNodeSharedSecretOutput, bm as Wallet, bn as WalletStatus, bo as WalletToPaymentRequestsConnection, bp as WalletToTransactionsConnection, W as WebhookEventType, bq as Withdrawal, bs as WithdrawalMode, bt as WithdrawalRequest, bu as WithdrawalRequestStatus, bv as WithdrawalRequestToChannelClosingTransactionsConnection, bw as WithdrawalRequestToChannelOpeningTransactionsConnection, h as getApiTokenQuery, l as getChannelClosingTransactionQuery, o as getChannelOpeningTransactionQuery, Q as getDepositQuery, Y as getHopQuery, a1 as getIncomingPaymentAttemptQuery, a5 as getInvoiceQuery, ac as getLightningTransactionQuery, af as getLightsparkNodeOwnerQuery, ap as getOnChainTransactionQuery, aD as getPaymentRequestQuery, aV as getRoutingTransactionQuery, b5 as getSignablePayloadQuery, b3 as getSignableQuery, bd as getTransactionQuery, br as getWithdrawalQuery } from '../index-09d4ac20.js';
+export { A as Account, a as AccountToApiTokensConnection, b as AccountToChannelsConnection, c as AccountToNodesConnection, d as AccountToPaymentRequestsConnection, e as AccountToTransactionsConnection, f as AccountToWalletsConnection, g as ApiToken, B as Balances, i as BlockchainBalance, C as Channel, j as ChannelClosingTransaction, l as ChannelFees, m as ChannelOpeningTransaction, o as ChannelStatus, p as ChannelToTransactionsConnection, q as ComplianceProvider, r as Connection, s as CreateApiTokenInput, t as CreateApiTokenOutput, u as CreateInvoiceInput, v as CreateInvoiceOutput, w as CreateLnurlInvoiceInput, x as CreateNodeWalletAddressInput, y as CreateNodeWalletAddressOutput, z as CreateTestModeInvoiceInput, D as CreateTestModeInvoiceOutput, E as CreateTestModePaymentInput, F as CreateTestModePaymentoutput, G as CreateUmaInvoiceInput, H as CurrencyAmount, I as CurrencyUnit, J as DeclineToSignMessagesInput, K as DeclineToSignMessagesOutput, M as DeleteApiTokenInput, N as DeleteApiTokenOutput, O as Deposit, Q as Entity, R as FeeEstimate, S as FundNodeInput, T as FundNodeOutput, U as GraphNode, V as Hop, Y as HtlcAttemptFailureCode, Z as IdAndSignature, _ as IncomingPayment, $ as IncomingPaymentAttempt, a1 as IncomingPaymentAttemptStatus, a2 as IncomingPaymentToAttemptsConnection, a3 as Invoice, a5 as InvoiceData, a6 as InvoiceType, a7 as LightningFeeEstimateForInvoiceInput, a8 as LightningFeeEstimateForNodeInput, a9 as LightningFeeEstimateOutput, aa as LightningTransaction, ac as LightsparkNode, ad as LightsparkNodeOwner, af as LightsparkNodeStatus, ag as LightsparkNodeToChannelsConnection, ah as LightsparkNodeWithOSK, ai as LightsparkNodeWithRemoteSigning, aj as Node, ak as NodeAddress, al as NodeAddressType, am as NodeToAddressesConnection, an as OnChainTransaction, ap as OutgoingPayment, aq as OutgoingPaymentAttempt, ar as OutgoingPaymentAttemptStatus, as as OutgoingPaymentAttemptToHopsConnection, av as OutgoingPaymentToAttemptsConnection, at as OutgoingPaymentsForInvoiceQueryInput, au as OutgoingPaymentsForInvoiceQueryOutput, aw as PageInfo, ax as PayInvoiceInput, ay as PayInvoiceOutput, aF as PayUmaInvoiceInput, az as PaymentDirection, aA as PaymentFailureReason, aB as PaymentRequest, aD as PaymentRequestData, aE as PaymentRequestStatus, aG as Permission, aH as PostTransactionData, aI as RegisterPaymentInput, aJ as RegisterPaymentOutput, aK as ReleaseChannelPerCommitmentSecretInput, aL as ReleaseChannelPerCommitmentSecretOutput, aM as ReleasePaymentPreimageInput, aN as ReleasePaymentPreimageOutput, aO as RemoteSigningSubEventType, aP as RequestWithdrawalInput, aQ as RequestWithdrawalOutput, aR as RichText, aS as RiskRating, aT as RoutingTransaction, aV as RoutingTransactionFailureReason, aW as ScreenNodeInput, aX as ScreenNodeOutput, aY as Secret, aZ as SendPaymentInput, a_ as SendPaymentOutput, a$ as SetInvoicePaymentHashInput, b0 as SetInvoicePaymentHashOutput, b6 as SignInvoiceInput, b7 as SignInvoiceOutput, b8 as SignMessagesInput, b9 as SignMessagesOutput, b1 as Signable, b3 as SignablePayload, b5 as SignablePayloadStatus, ba as SingleNodeDashboard, bb as Transaction, bd as TransactionFailures, be as TransactionStatus, bf as TransactionType, bg as TransactionUpdate, bh as UpdateChannelPerCommitmentPointInput, bi as UpdateChannelPerCommitmentPointOutput, bj as UpdateNodeSharedSecretInput, bk as UpdateNodeSharedSecretOutput, bl as Wallet, bm as WalletStatus, bn as WalletToPaymentRequestsConnection, bo as WalletToTransactionsConnection, W as WebhookEventType, bp as Withdrawal, br as WithdrawalMode, bs as WithdrawalRequest, bt as WithdrawalRequestStatus, bu as WithdrawalRequestToChannelClosingTransactionsConnection, bv as WithdrawalRequestToChannelOpeningTransactionsConnection, h as getApiTokenQuery, k as getChannelClosingTransactionQuery, n as getChannelOpeningTransactionQuery, P as getDepositQuery, X as getHopQuery, a0 as getIncomingPaymentAttemptQuery, a4 as getInvoiceQuery, ab as getLightningTransactionQuery, ae as getLightsparkNodeOwnerQuery, ao as getOnChainTransactionQuery, aC as getPaymentRequestQuery, aU as getRoutingTransactionQuery, b4 as getSignablePayloadQuery, b2 as getSignableQuery, bc as getTransactionQuery, bq as getWithdrawalQuery } from '../index-dbf06298.js';
+export { B as BitcoinNetwork } from '../BitcoinNetwork-a816c0be.js';
 import '@lightsparkdev/core';
 import 'zen-observable';

package/dist/objects/index.js

@@ -1,7 +1,6 @@
 import {
   AccountToChannelsConnection_default,
   Account_default,
-  BitcoinNetwork_default,
   ChannelStatus_default,
   Channel_default,
   ComplianceProvider_default,
@@ -52,7 +51,10 @@ import {
   getSignableQuery,
   getTransactionQuery,
   getWithdrawalQuery
-} from "../chunk-LZC5C5NI.js";
+} from "../chunk-K2ZU5YQL.js";
+import {
+  BitcoinNetwork_default
+} from "../chunk-K6SAUSAX.js";
 import "../chunk-NIMBE7W3.js";
 export {
   Account_default as Account,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lightsparkdev/lightspark-sdk",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "Lightspark JS SDK",
   "author": "Lightspark Inc.",
   "keywords": [
@@ -41,6 +41,16 @@
       "module": "./dist/objects/index.js",
       "require": "./dist/objects/index.cjs",
       "default": "./dist/objects/index.cjs"
+    },
+    "./env": {
+      "types": "./dist/env.d.ts",
+      "import": {
+        "types": "./dist/env.d.ts",
+        "default": "./dist/env.js"
+      },
+      "module": "./dist/env.js",
+      "require": "./dist/env.cjs",
+      "default": "./dist/env.cjs"
     }
   },
   "type": "module",
@@ -58,7 +68,7 @@
     "CHANGELOG.md"
   ],
   "scripts": {
-    "build": "tsup",
+    "build": "yarn tsc && tsup",
     "clean": "rm -rf .turbo && rm -rf dist",
     "dev": "yarn build -- --watch",
     "docs": "typedoc src",
@@ -75,11 +85,13 @@
   },
   "license": "Apache-2.0",
   "dependencies": {
-    "@lightsparkdev/core": "1.0.0",
+    "@lightsparkdev/core": "1.0.1",
+    "@lightsparkdev/crypto-wasm": "0.1.0",
     "auto-bind": "^5.0.1",
     "crypto": "^1.0.1",
     "crypto-browserify": "^3.12.0",
     "dayjs": "^1.11.7",
+    "dotenv": "^16.3.1",
     "graphql": "^16.6.0",
     "graphql-ws": "^5.11.3",
     "ws": "^8.12.1",

package/src/NodeKeyLoaderCache.ts

@@ -1,4 +1,5 @@
 import {
+  DefaultCrypto,
   LightsparkSigningException,
   type CryptoInterface,
   type NodeKeyCache,
@@ -78,10 +79,11 @@ export default class NodeKeyLoaderCache {
       return;
     }
 
-    return this.nodeKeyCache.loadKey(
+    const key = await this.nodeKeyCache.loadKey(
       id,
       { key: loaderResult.key },
       loaderResult.type,
     );
+    return key || undefined;
   }
 }

package/src/SigningKeyLoader.ts

@@ -1,5 +1,6 @@
 import {
   b64encode,
+  isBrowser,
   LightsparkSigningException,
   SigningKeyType,
   type CryptoInterface,
@@ -8,28 +9,9 @@ import {
 } from "@lightsparkdev/core";
 import { RecoverNodeSigningKey } from "./graphql/RecoverNodeSigningKey.js";
 import { BitcoinNetwork } from "./index.js";
-import {
-  LightsparkSigner,
-  Network,
-} from "./lightspark_crypto/lightspark_crypto.js";
 
 const SIGNING_KEY_PATH = "m/5";
 
-const getCryptoLibNetwork = (bitcoinNetwork: BitcoinNetwork): Network => {
-  switch (bitcoinNetwork) {
-    case BitcoinNetwork.MAINNET:
-      return Network.Bitcoin;
-    case BitcoinNetwork.TESTNET:
-      return Network.Testnet;
-    case BitcoinNetwork.REGTEST:
-      return Network.Regtest;
-    default:
-      throw new Error(
-        `Unsupported lightspark_crypto network ${bitcoinNetwork}.`,
-      );
-  }
-};
-
 /**
  * Args for creating a new SigningKeyLoader. Must be one of the sub types.
  */
@@ -167,9 +149,35 @@ export class MasterSeedSigningKeyLoader implements SigningKeyLoader {
   }
 
   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.MAINNET:
+        cryptoLibNetwork = Network.Bitcoin;
+        break;
+      case BitcoinNetwork.TESTNET:
+        cryptoLibNetwork = Network.Testnet;
+        break;
+      case BitcoinNetwork.REGTEST:
+        cryptoLibNetwork = Network.Regtest;
+        break;
+      default:
+        throw new Error(
+          `Unsupported lightspark_crypto network ${this.network}.`,
+        );
+    }
     const lightsparkSigner = LightsparkSigner.from_bytes(
       this.masterSeed,
-      getCryptoLibNetwork(this.network),
+      cryptoLibNetwork,
     );
     const privateKey = lightsparkSigner.derive_private_key(SIGNING_KEY_PATH);
     return { key: privateKey, type: SigningKeyType.Secp256k1SigningKey };

package/src/env.ts

@@ -0,0 +1,54 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+/* These utils are only needed in NodeJS contexts and so the file is exported separately
+   in the package to avoid eg unnecessary browser bundling */
+import dotenv from "dotenv";
+import { getBitcoinNetworkOrThrow } from "./helpers.js";
+import { type BitcoinNetwork } from "./objects/BitcoinNetwork.js";
+
+export type EnvCredentials = {
+  apiTokenClientId: string;
+  apiTokenClientSecret: string;
+  bitcoinNetwork: BitcoinNetwork;
+  testNodePassword: string;
+  baseUrl: string;
+};
+
+export enum RequiredCredentials {
+  ClientId = "LIGHTSPARK_API_TOKEN_CLIENT_ID",
+  ClientSecret = "LIGHTSPARK_API_TOKEN_CLIENT_SECRET",
+  BitcoinNetwork = "BITCOIN_NETWORK",
+}
+
+export const getCredentialsFromEnvOrThrow = (): EnvCredentials => {
+  const env =
+    dotenv.config({
+      path: process.env.HOME + "/.lightsparkapienv",
+    }).parsed || {};
+
+  const missingTestCredentials = Object.values(RequiredCredentials).filter(
+    (cred) => !env[cred],
+  );
+  if (missingTestCredentials.length) {
+    throw new Error(
+      `Missing test credentials. Please set ${missingTestCredentials.join(
+        ", ",
+      )} environment variables.`,
+    );
+  }
+
+  const apiTokenClientId = env[RequiredCredentials.ClientId]!;
+  const apiTokenClientSecret = env[RequiredCredentials.ClientSecret]!;
+  const bitcoinNetwork = getBitcoinNetworkOrThrow(
+    env[RequiredCredentials.BitcoinNetwork]! as BitcoinNetwork,
+  );
+  const testNodePassword = "1234!@#$";
+  const baseUrl = env["LIGHTSPARK_BASE_URL"] || "api.lightspark.com";
+  return {
+    apiTokenClientId,
+    apiTokenClientSecret,
+    bitcoinNetwork,
+    testNodePassword,
+    baseUrl,
+  };
+};

package/src/helpers.ts

@@ -0,0 +1,31 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+import { BitcoinNetwork } from "./objects/BitcoinNetwork.js";
+
+const BITCOIN_NETWORKS = [
+  BitcoinNetwork.MAINNET,
+  BitcoinNetwork.TESTNET,
+  BitcoinNetwork.SIGNET,
+  BitcoinNetwork.REGTEST,
+];
+
+export const isBitcoinNetwork = (bitcoinNetwork: BitcoinNetwork) => {
+  return BITCOIN_NETWORKS.includes(bitcoinNetwork);
+};
+
+export const assertValidBitcoinNetwork = (
+  bitcoinNetwork: BitcoinNetwork,
+): void => {
+  if (!isBitcoinNetwork(bitcoinNetwork)) {
+    throw new Error(
+      `Invalid bitcoin network ${bitcoinNetwork}. Valid networks: ${BITCOIN_NETWORKS}`,
+    );
+  }
+};
+
+export const getBitcoinNetworkOrThrow = (
+  bitcoinNetwork: BitcoinNetwork,
+): BitcoinNetwork => {
+  assertValidBitcoinNetwork(bitcoinNetwork.toUpperCase() as BitcoinNetwork);
+  return bitcoinNetwork;
+};

package/src/index.ts

@@ -2,5 +2,6 @@
 
 export * from "./auth/index.js";
 export { default as LightsparkClient } from "./client.js";
+export * from "./helpers.js";
 export * from "./objects/index.js";
 export * from "./webhooks.js";

package/src/lightspark_crypto/lightspark_crypto.d.ts

@@ -1,157 +0,0 @@
-/* tslint:disable */
-/* eslint-disable */
-/**
- */
-export enum Network {
-  Bitcoin = 0,
-  Testnet = 1,
-  Regtest = 2,
-}
-/**
- */
-export class InvoiceSignature {
-  free(): void;
-  /**
-   * @returns {Uint8Array}
-   */
-  get_signature(): Uint8Array;
-  /**
-   * @returns {number}
-   */
-  get_recovery_id(): number;
-}
-/**
- */
-export class LightsparkSigner {
-  free(): void;
-  /**
-   * @param {Seed} seed
-   * @param {number} network
-   * @returns {LightsparkSigner}
-   */
-  static new(seed: Seed, network: number): LightsparkSigner;
-  /**
-   * @param {Uint8Array} seed
-   * @param {number} network
-   * @returns {LightsparkSigner}
-   */
-  static from_bytes(seed: Uint8Array, network: number): LightsparkSigner;
-  /**
-   * @returns {string}
-   */
-  get_master_public_key(): string;
-  /**
-   * @param {string} derivation_path
-   * @returns {string}
-   */
-  derive_public_key(derivation_path: string): string;
-  /**
-   * @param {Uint8Array} message
-   * @param {string} derivation_path
-   * @param {boolean} is_raw
-   * @param {Uint8Array | undefined} add_tweak
-   * @param {Uint8Array | undefined} mul_tweak
-   * @returns {Uint8Array}
-   */
-  derive_key_and_sign(
-    message: Uint8Array,
-    derivation_path: string,
-    is_raw: boolean,
-    add_tweak?: Uint8Array,
-    mul_tweak?: Uint8Array,
-  ): Uint8Array;
-  /**
-   * @param {Uint8Array} public_key
-   * @returns {Uint8Array}
-   */
-  ecdh(public_key: Uint8Array): Uint8Array;
-  /**
-   * @param {string} derivation_path
-   * @param {bigint} per_commitment_point_idx
-   * @returns {Uint8Array}
-   */
-  get_per_commitment_point(
-    derivation_path: string,
-    per_commitment_point_idx: bigint,
-  ): Uint8Array;
-  /**
-   * @param {string} derivation_path
-   * @param {bigint} per_commitment_point_idx
-   * @returns {Uint8Array}
-   */
-  release_per_commitment_secret(
-    derivation_path: string,
-    per_commitment_point_idx: bigint,
-  ): Uint8Array;
-  /**
-   * @returns {Uint8Array}
-   */
-  generate_preimage_nonce(): Uint8Array;
-  /**
-   * @param {Uint8Array} nonce
-   * @returns {Uint8Array}
-   */
-  generate_preimage(nonce: Uint8Array): Uint8Array;
-  /**
-   * @param {Uint8Array} nonce
-   * @returns {Uint8Array}
-   */
-  generate_preimage_hash(nonce: Uint8Array): Uint8Array;
-  /**
-   * @param {string} derivation_path
-   * @returns {string}
-   */
-  derive_private_key(derivation_path: string): string;
-  /**
-   * @param {string} unsigned_invoice
-   * @returns {InvoiceSignature}
-   */
-  sign_invoice_wasm(unsigned_invoice: string): InvoiceSignature;
-  /**
-   * @param {Uint8Array} invoice_hash
-   * @returns {InvoiceSignature}
-   */
-  sign_invoice_hash_wasm(invoice_hash: Uint8Array): InvoiceSignature;
-}
-/**
- */
-export class Mnemonic {
-  free(): void;
-  /**
-   * @returns {Mnemonic}
-   */
-  static random(): Mnemonic;
-  /**
-   * @param {Uint8Array} entropy
-   * @returns {Mnemonic}
-   */
-  static from_entropy(entropy: Uint8Array): Mnemonic;
-  /**
-   * @param {string} phrase
-   * @returns {Mnemonic}
-   */
-  static from_phrase(phrase: string): Mnemonic;
-  /**
-   * @returns {string}
-   */
-  as_string(): string;
-}
-/**
- */
-export class Seed {
-  free(): void;
-  /**
-   * @param {Mnemonic} mnemonic
-   * @returns {Seed}
-   */
-  static from_mnemonic(mnemonic: Mnemonic): Seed;
-  /**
-   * @param {Uint8Array} seed
-   * @returns {Seed}
-   */
-  static new(seed: Uint8Array): Seed;
-  /**
-   * @returns {Uint8Array}
-   */
-  as_bytes(): Uint8Array;
-}