@lightsparkdev/lightspark-sdk 0.1.6

package/dist/objects/index.d.ts

@@ -0,0 +1,3 @@
+export { A as Account, a as AccountToApiTokensConnection, b as AccountToChannelsConnection, c as AccountToNodesConnection, d as AccountToPaymentRequestsConnection, e as AccountToTransactionsConnection, f as ApiToken, B as BitcoinNetwork, h as BlockchainBalance, C as Channel, i as ChannelClosingTransaction, k as ChannelFees, l as ChannelOpeningTransaction, n as ChannelStatus, o as ChannelToTransactionsConnection, p as CreateApiTokenInput, q as CreateApiTokenOutput, r as CreateInvoiceInput, s as CreateInvoiceOutput, t as CreateNodeWalletAddressInput, u as CreateNodeWalletAddressOutput, v as CurrencyAmount, w as CurrencyUnit, D as DeleteApiTokenInput, x as DeleteApiTokenOutput, y as Deposit, E as Entity, F as FeeEstimate, G as FundNodeInput, H as FundNodeOutput, I as GraphNode, J as Hop, M as HtlcAttemptFailureCode, N as IncomingPayment, O as IncomingPaymentAttempt, Q as IncomingPaymentAttemptStatus, R as IncomingPaymentToAttemptsConnection, S as Invoice, U as InvoiceData, V as InvoiceType, W as LightningFeeEstimateForInvoiceInput, X as LightningFeeEstimateForNodeInput, Y as LightningFeeEstimateOutput, Z as LightningTransaction, $ as LightsparkNode, a0 as LightsparkNodePurpose, a1 as LightsparkNodeStatus, a2 as LightsparkNodeToChannelsConnection, a3 as Node, a4 as NodeAddress, a5 as NodeAddressType, a6 as NodeToAddressesConnection, a7 as OnChainTransaction, a9 as OutgoingPayment, aa as OutgoingPaymentAttempt, ab as OutgoingPaymentAttemptStatus, ac as OutgoingPaymentAttemptToHopsConnection, ad as OutgoingPaymentToAttemptsConnection, ae as PageInfo, af as PayInvoiceInput, ag as PayInvoiceOutput, ah as PaymentFailureReason, ai as PaymentRequest, ak as PaymentRequestData, al as PaymentRequestStatus, am as Permission, an as RequestWithdrawalInput, ao as RequestWithdrawalOutput, ap as RichText, aq as RoutingTransaction, as as RoutingTransactionFailureReason, at as Secret, au as SendPaymentInput, av as SendPaymentOutput, aw as Transaction, ay as TransactionFailures, az as TransactionStatus, aA as TransactionType, aB as TransactionUpdate, aC as WalletDashboard, aD as WebhookEventType, aE as Withdrawal, aG as WithdrawalMode, aH as WithdrawalRequest, aI as WithdrawalRequestStatus, aJ as WithdrawalRequestToChannelClosingTransactionsConnection, aK as WithdrawalRequestToChannelOpeningTransactionsConnection, g as getApiTokenQuery, j as getChannelClosingTransactionQuery, m as getChannelOpeningTransactionQuery, z as getDepositQuery, K as getHopQuery, P as getIncomingPaymentAttemptQuery, T as getInvoiceQuery, _ as getLightningTransactionQuery, a8 as getOnChainTransactionQuery, aj as getPaymentRequestQuery, ar as getRoutingTransactionQuery, ax as getTransactionQuery, aF as getWithdrawalQuery } from '../Withdrawal-27a4d10d.js';
+import '@lightsparkdev/core';
+import 'zen-observable';

package/dist/objects/index.js

@@ -0,0 +1,88 @@
+import {
+  AccountToChannelsConnection_default,
+  Account_default,
+  BitcoinNetwork_default,
+  ChannelStatus_default,
+  Channel_default,
+  CurrencyUnit_default,
+  GraphNode_default,
+  HtlcAttemptFailureCode_default,
+  IncomingPaymentAttemptStatus_default,
+  IncomingPayment_default,
+  InvoiceType_default,
+  LightsparkNodePurpose_default,
+  LightsparkNodeStatus_default,
+  LightsparkNode_default,
+  NodeAddressType_default,
+  Node_default,
+  OutgoingPaymentAttemptStatus_default,
+  OutgoingPaymentAttempt_default,
+  OutgoingPayment_default,
+  PaymentFailureReason_default,
+  PaymentRequestStatus_default,
+  Permission_default,
+  RoutingTransactionFailureReason_default,
+  TransactionStatus_default,
+  TransactionType_default,
+  WebhookEventType_default,
+  WithdrawalMode_default,
+  WithdrawalRequestStatus_default,
+  WithdrawalRequest_default,
+  getApiTokenQuery,
+  getChannelClosingTransactionQuery,
+  getChannelOpeningTransactionQuery,
+  getDepositQuery,
+  getHopQuery,
+  getIncomingPaymentAttemptQuery,
+  getInvoiceQuery,
+  getLightningTransactionQuery,
+  getOnChainTransactionQuery,
+  getPaymentRequestQuery,
+  getRoutingTransactionQuery,
+  getTransactionQuery,
+  getWithdrawalQuery
+} from "../chunk-3VRI7CHE.js";
+export {
+  Account_default as Account,
+  AccountToChannelsConnection_default as AccountToChannelsConnection,
+  BitcoinNetwork_default as BitcoinNetwork,
+  Channel_default as Channel,
+  ChannelStatus_default as ChannelStatus,
+  CurrencyUnit_default as CurrencyUnit,
+  GraphNode_default as GraphNode,
+  HtlcAttemptFailureCode_default as HtlcAttemptFailureCode,
+  IncomingPayment_default as IncomingPayment,
+  IncomingPaymentAttemptStatus_default as IncomingPaymentAttemptStatus,
+  InvoiceType_default as InvoiceType,
+  LightsparkNode_default as LightsparkNode,
+  LightsparkNodePurpose_default as LightsparkNodePurpose,
+  LightsparkNodeStatus_default as LightsparkNodeStatus,
+  Node_default as Node,
+  NodeAddressType_default as NodeAddressType,
+  OutgoingPayment_default as OutgoingPayment,
+  OutgoingPaymentAttempt_default as OutgoingPaymentAttempt,
+  OutgoingPaymentAttemptStatus_default as OutgoingPaymentAttemptStatus,
+  PaymentFailureReason_default as PaymentFailureReason,
+  PaymentRequestStatus_default as PaymentRequestStatus,
+  Permission_default as Permission,
+  RoutingTransactionFailureReason_default as RoutingTransactionFailureReason,
+  TransactionStatus_default as TransactionStatus,
+  TransactionType_default as TransactionType,
+  WebhookEventType_default as WebhookEventType,
+  WithdrawalMode_default as WithdrawalMode,
+  WithdrawalRequest_default as WithdrawalRequest,
+  WithdrawalRequestStatus_default as WithdrawalRequestStatus,
+  getApiTokenQuery,
+  getChannelClosingTransactionQuery,
+  getChannelOpeningTransactionQuery,
+  getDepositQuery,
+  getHopQuery,
+  getIncomingPaymentAttemptQuery,
+  getInvoiceQuery,
+  getLightningTransactionQuery,
+  getOnChainTransactionQuery,
+  getPaymentRequestQuery,
+  getRoutingTransactionQuery,
+  getTransactionQuery,
+  getWithdrawalQuery
+};

package/examples/node-scripts/authHelpers.ts

@@ -0,0 +1,20 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+export const getCredentialsFromEnvOrThrow = () => {
+  const apiTokenClientId = process.env["LIGHTSPARK_API_TOKEN_CLIENT_ID"];
+  const apiTokenClientSecret =
+    process.env["LIGHTSPARK_API_TOKEN_CLIENT_SECRET"];
+  const nodePassword = process.env["LIGHTSPARK_TEST_NODE_PASSWORD"];
+  const baseUrl = process.env["LIGHTSPARK_EXAMPLE_BASE_URL"] || "api.lightspark.com";
+  if (!apiTokenClientId || !apiTokenClientSecret || !nodePassword) {
+    throw new Error(
+      "Missing test credentials. Please set LIGHTSPARK_API_TOKEN_CLIENT_ID, LIGHTSPARK_API_TOKEN_CLIENT_SECRET, and LIGHTSPARK_TEST_NODE_PASSWORD environment variables."
+    );
+  }
+  return {
+    apiTokenClientId,
+    apiTokenClientSecret,
+    nodePassword,
+    baseUrl
+  };
+};

package/examples/node-scripts/createInvoice.ts

@@ -0,0 +1,64 @@
+#!/usr/bin/env ts-node
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+import {
+  AccountTokenAuthProvider,
+  InvoiceType,
+  LightsparkClient,
+} from "@lightsparkdev/lightspark-sdk";
+import { Command } from "commander";
+
+import { getCredentialsFromEnvOrThrow } from "./authHelpers.js";
+
+const main = async (program: Command) => {
+  const credentials = getCredentialsFromEnvOrThrow();
+  const client = new LightsparkClient(
+    new AccountTokenAuthProvider(
+      credentials.apiTokenClientId,
+      credentials.apiTokenClientSecret
+    ),
+    credentials.baseUrl
+  );
+  const account = await client.getCurrentAccount();
+  const nodeId = (await account.getNodes(client)).entities[0].id;
+  const options = program.opts();
+  console.log("Options: ", JSON.stringify(options, null, 2));
+  const invoice = await client.createInvoice(
+    nodeId,
+    options.amount * 1000,
+    options.memo,
+    options.amp ? InvoiceType.AMP : InvoiceType.STANDARD
+  );
+  console.log("Invoice:", JSON.stringify(invoice, null, 2));
+};
+
+(() => {
+  const program = new Command();
+  program
+    .name("CreateInvoice")
+    .version("1.0.0")
+    .description("Create an invoice for your wallet node")
+    .option(
+      "-m, --memo  <value>",
+      "Add a memo describing the invoice.",
+      undefined
+    )
+    .option(
+      "-a, --amount <number>",
+      "The amount of the invoice in sats.",
+      parseInt,
+      0
+    )
+    .option("--amp", "Flag to use AMP invoices.", false)
+    .parse(process.argv);
+
+  const options = program.opts();
+  if (options.amount === undefined) {
+    program.outputHelp();
+  } else {
+    // tslint:disable-next-line
+    main(program).catch((err) =>
+      console.error("Oh no, something went wrong.\n", err)
+    );
+  }
+})();

package/examples/node-scripts/example.ts

@@ -0,0 +1,288 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+import {
+  AccountTokenAuthProvider,
+  BitcoinNetwork,
+  CurrencyAmount,
+  getDepositQuery,
+  LightsparkClient,
+  LightsparkNode,
+  Node,
+} from "@lightsparkdev/lightspark-sdk";
+import day from "dayjs";
+import utc from "dayjs/plugin/utc.js";
+
+import { getCredentialsFromEnvOrThrow } from "./authHelpers.js";
+
+day.extend(utc);
+
+// Let's start by creating a client
+const credentials = getCredentialsFromEnvOrThrow();
+const client = new LightsparkClient(
+  new AccountTokenAuthProvider(
+    credentials.apiTokenClientId,
+    credentials.apiTokenClientSecret
+  ),
+  credentials.baseUrl
+);
+
+// Get some fee estimates for Bitcoin (L1) transactions
+
+const feeEstimate = await client.getBitcoinFeeEstimate(BitcoinNetwork.REGTEST);
+console.log(
+  `Fees for a fast transaction ${feeEstimate.feeFast.preferredCurrencyValueApprox} ${feeEstimate.feeFast.preferredCurrencyUnit}.`
+);
+console.log(
+  `Fees for a cheap transaction ${feeEstimate.feeMin.preferredCurrencyValueApprox} ${feeEstimate.feeMin.preferredCurrencyUnit}.\n`
+);
+
+// List your account's lightning nodes
+
+const account = await client.getCurrentAccount();
+if (!account) {
+  throw new Error("Unable to fetch the account.");
+}
+console.log(`Your account name is ${account.name}.\n`);
+
+// Test API token logic:
+
+const apiTokenConnection = await account.getApiTokens(client);
+console.log(`You have ${apiTokenConnection.count} API tokens.`);
+
+const { apiToken, clientSecret } = await client.createApiToken(
+  "newTestToken",
+  false,
+  true
+);
+console.log(
+  `Created API token ${apiToken.name} with ID ${
+    apiToken.id
+  }. Permissions: ${JSON.stringify(apiToken.permissions)}\n`
+);
+
+const apiTokenConnection2 = await account.getApiTokens(client);
+console.log(`You now have ${apiTokenConnection2.count} API tokens.\n`);
+
+client.deleteApiToken(apiToken.id);
+
+const apiTokenConnection3 = await account.getApiTokens(client);
+console.log(`You now have ${apiTokenConnection3.count} API tokens.\n`);
+
+// Check our account's conductivity on REGTEST
+
+console.log(
+  `Your account's conductivity on REGTEST is ${await account.getConductivity(
+    client,
+    [BitcoinNetwork.REGTEST]
+  )}/10.\n`
+);
+
+// Check your account's local and remote balances for REGTEST
+const localBalance = await account.getLocalBalance(client, [
+  BitcoinNetwork.REGTEST,
+]);
+const remoteBalance = await account.getRemoteBalance(client, [
+  BitcoinNetwork.REGTEST,
+]);
+
+if (localBalance && remoteBalance) {
+  console.log(
+    `Your local balance is ${localBalance.preferredCurrencyValueApprox} ${localBalance.preferredCurrencyUnit}, 
+    your remote balance is ${remoteBalance.preferredCurrencyValueApprox} ${remoteBalance.preferredCurrencyUnit}.`
+  );
+}
+
+const nodesConnection = await account.getNodes(client, 50, [
+  BitcoinNetwork.REGTEST,
+]);
+
+if (!nodesConnection) {
+  throw new Error("Unable to fetch the nodes.");
+}
+
+console.log(`You have ${nodesConnection.count} nodes.`);
+
+if (nodesConnection.entities.length == 0) {
+  throw new Error("Cannot continue without any nodes.");
+}
+
+const nodeId = nodesConnection.entities[0].id;
+const nodeName = nodesConnection.entities[0].displayName;
+console.log("");
+
+// List the transactions for our account
+
+let transactionsConnection = await account.getTransactions(
+  client,
+  100,
+  undefined,
+  undefined,
+  undefined,
+  undefined,
+  BitcoinNetwork.REGTEST
+);
+
+console.log(
+  `There is a total of ${transactionsConnection.count} transaction(s) on this account:`
+);
+let depositTransactionId: string | undefined;
+for (const transaction of transactionsConnection.entities) {
+  console.log(
+    `    - ${transaction.typename} at ${transaction.createdAt}:
+    ${transaction.amount.preferredCurrencyValueApprox} ${transaction.amount.preferredCurrencyUnit}
+    (${transaction.status})`
+  );
+  if (transaction.typename == "Deposit") {
+    depositTransactionId = transaction.id;
+  }
+
+  let fees;
+  if (
+    transaction.typename == "OutgoingPayment" ||
+    transaction.typename == "Withdrawal" ||
+    transaction.typename == "Deposit" ||
+    transaction.typename == "ChannelOpeningTransaction" ||
+    transaction.typename == "ChannelClosingTransaction"
+  ) {
+    fees = (transaction as unknown as { fees: CurrencyAmount }).fees;
+    if (fees !== undefined)
+      console.log(
+        `        Paid ${fees.preferredCurrencyValueApprox} ${fees.preferredCurrencyUnit} in fees.`
+      );
+  }
+}
+console.log("");
+
+// Fetch transactions using pagination
+const pageSize = 10;
+let iterations = 0;
+let hasNext = true;
+let after: string | undefined = undefined;
+while (hasNext && iterations < 30) {
+  iterations += 1;
+  transactionsConnection = await account.getTransactions(
+    client,
+    pageSize,
+    after,
+    undefined,
+    undefined,
+    undefined,
+    BitcoinNetwork.REGTEST
+  );
+  const num = transactionsConnection.entities.length;
+  console.log(
+    `We got ${num} transactions for the page (iteration #${iterations})`
+  );
+  if (transactionsConnection.pageInfo.hasNextPage) {
+    hasNext = true;
+    after = transactionsConnection.pageInfo.endCursor;
+    console.log("  And we have another page!");
+  } else {
+    hasNext = false;
+    console.log("  And we're done!");
+  }
+}
+console.log("");
+
+// Get the transactions that happened in the past day on REGTEST
+
+transactionsConnection = await account.getTransactions(
+  client,
+  undefined,
+  undefined,
+  undefined,
+  day().utc().subtract(1, "day").format(),
+  undefined,
+  BitcoinNetwork.REGTEST
+);
+console.log(
+  `We had ${transactionsConnection.count} transactions in the past 24 hours.`
+);
+
+// Get details for a transaction
+
+if (!depositTransactionId) {
+  throw new Error("Unable to find the deposit transaction.");
+}
+
+const deposit = await client.executeRawQuery(
+  getDepositQuery(depositTransactionId)
+);
+console.log("Details of deposit transaction");
+console.log(deposit);
+console.log("");
+
+// Generate a payment request
+
+const invoice = await client.createInvoice(nodeId, 42000, "Pizza!");
+if (!invoice) {
+  throw new Error("Unable to create the invoice.");
+}
+console.log(`Invoice created from ${nodeName}:`);
+console.log(`Encoded invoice = ${invoice}`);
+console.log("");
+
+// Decode the payment request
+const decodedInvoice = await client.decodeInvoice(invoice);
+if (!decodedInvoice) {
+  throw new Error("Unable to decode the invoice.");
+}
+console.log("Decoded payment request:");
+console.log(
+  "    destination public key = " + decodedInvoice.destination.publicKey
+);
+console.log(
+  "    amount = " +
+    decodedInvoice.amount.preferredCurrencyValueApprox +
+    " " +
+    decodedInvoice.amount.preferredCurrencyUnit
+);
+console.log("    memo = " + decodedInvoice.memo);
+console.log("");
+
+// Let's send the payment.
+
+// First, we need to recover the signing key.
+await client.unlockNode(nodeId, credentials.nodePassword!);
+console.log(`${nodeName}'s signing key has been loaded.`);
+
+// Then we can send the payment. Note that this isn't paying the invoice we just made because
+// you can't actually pay your own invoice. Let's just pay a pre-existing AMP invoice instead.
+const ampInvoice =
+  "lnbcrt1pjr8xwypp5xqj2jfpkz095s8zu57ktsq8vt8yazwcmqpcke9pvl67ne9cpdr0qdqj2a5xzumnwd6hqurswqcqzpgxq9z0rgqsp55hfn0caa5sexea8u979cckkmwelw6h3zpwel5l8tn8s0elgwajss9q8pqqqssqefmmw79tknhl5xhnh7yfepzypxknwr9r4ya7ueqa6vz20axvys8se986hwj6gppeyzst44hm4yl04c4dqjjpqgtt0df254q087sjtfsq35yagj";
+const payment = await client.payInvoice(nodeId, ampInvoice, 1000, 60, 10);
+console.log(`Payment done with ID = ${payment.id}`);
+console.log("");
+
+const address = await client.createNodeWalletAddress(nodeId);
+console.log(`Got a bitcoin address for ${nodeName}: ${address}`);
+console.log("");
+
+// const withdrawal = await client.requestWithdrawal(node2Id, 1000000, address, WithdrawalMode.WALLET_THEN_CHANNELS);
+// console.log(`Money was withdrawn with ID = ${withdrawal.id}`);
+// console.log("");
+
+// Fetch the channels for Node 1
+const node = await client.executeRawQuery(
+  LightsparkNode.getLightsparkNodeQuery(nodeId)
+);
+if (!node) {
+  throw new Error("Unable to find node.");
+}
+
+const channelsConnection = await node.getChannels(client, 10);
+console.log(`${nodeName} has ${channelsConnection.count} channel(s):`);
+for (const channel of channelsConnection.entities) {
+  if (channel.remoteNodeId) {
+    const remoteNode = await client.executeRawQuery(
+      Node.getNodeQuery(channel.remoteNodeId)
+    );
+    const alias = remoteNode?.alias ?? "UNKNOWN";
+    if (channel.localBalance && channel.remoteBalance) {
+      console.log(
+        `    - With ${alias}. Local/remote balance = ${channel.localBalance.preferredCurrencyValueApprox} ${channel.localBalance.preferredCurrencyUnit}
+        / ${channel.remoteBalance.preferredCurrencyValueApprox} ${channel.remoteBalance.preferredCurrencyUnit}`
+      );
+    }
+  }
+}

package/examples/node-scripts/getAccountDashboard.ts

@@ -0,0 +1,24 @@
+#!/usr/bin/env ts-node
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+import {
+  AccountTokenAuthProvider,
+  BitcoinNetwork,
+  LightsparkClient,
+} from "@lightsparkdev/lightspark-sdk";
+
+import { getCredentialsFromEnvOrThrow } from "./authHelpers.js";
+
+const account = getCredentialsFromEnvOrThrow();
+const client = new LightsparkClient(
+  new AccountTokenAuthProvider(
+    account.apiTokenClientId,
+    account.apiTokenClientSecret
+  ),
+  account.baseUrl
+);
+client
+  .getAccountDashboard(undefined, BitcoinNetwork.REGTEST)
+  .then((dashboard) => {
+    console.log("Got dashboard:", JSON.stringify(dashboard, null, 2));
+  });

package/examples/node-scripts/getNodeChannels.ts

@@ -0,0 +1,34 @@
+#!/usr/bin/env ts-node
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+import {
+  AccountTokenAuthProvider,
+  BitcoinNetwork,
+  LightsparkClient,
+} from "@lightsparkdev/lightspark-sdk";
+
+import { getCredentialsFromEnvOrThrow } from "./authHelpers.js";
+
+const account = getCredentialsFromEnvOrThrow();
+const client = new LightsparkClient(
+  new AccountTokenAuthProvider(
+    account.apiTokenClientId,
+    account.apiTokenClientSecret
+  ),
+  account.baseUrl
+);
+
+const main = async () => {
+  const currentAccount = await client.getCurrentAccount();
+  console.log("Got account:", JSON.stringify(account, null, 2));
+
+  const nodes = await currentAccount!.getNodes(client, 100, [
+    BitcoinNetwork.REGTEST,
+  ]);
+  console.log("Got nodes:", JSON.stringify(nodes, null, 2));
+
+  const channels = await nodes.entities[0].getChannels(client, 20);
+  console.log("Got channels:", JSON.stringify(channels, null, 2));
+};
+
+main().catch((err) => console.error("Oh no, something went wrong.\n", err));

package/examples/node-scripts/internalAuthHelpers.ts

@@ -0,0 +1,26 @@
+// Copyright ©, 2023-present, Lightspark Group, Inc. - All Rights Reserved
+
+export const getCredentialsFromEnvOrThrow = () => {
+  const apiTokenClientId = process.env["LIGHTSPARK_API_TOKEN_CLIENT_ID"];
+  const apiTokenClientSecret =
+    process.env["LIGHTSPARK_API_TOKEN_CLIENT_SECRET"];
+  const walletNodeId = process.env["LIGHTSPARK_WALLET_NODE_ID"];
+  const node1Name = process.env["LIGHTSPARK_EXAMPLE_NODE_1_NAME"];
+  const node1Password = process.env["LIGHTSPARK_TEST_NODE_PASSWORD"];
+  const node2Name = process.env["LIGHTSPARK_EXAMPLE_NODE_2_NAME"];
+  const node2Password = process.env["LIGHTSPARK_EXAMPLE_NODE_2_PASSWORD"];
+  if (!apiTokenClientId || !apiTokenClientSecret || !node1Password) {
+    throw new Error(
+      "Missing test credentials. Please set LIGHTSPARK_API_TOKEN_CLIENT_ID, LIGHTSPARK_API_TOKEN_CLIENT_SECRET, and LIGHTSPARK_TEST_NODE_PASSWORD environment variables."
+    );
+  }
+  return {
+    apiTokenClientId,
+    apiTokenClientSecret,
+    walletNodeId,
+    node1Name,
+    node1Password,
+    node2Name,
+    node2Password,
+  };
+};