@lightsparkdev/lightspark-sdk 0.1.6

package/.fossa.yml

@@ -0,0 +1,6 @@
+version: 3
+
+project:
+  id: lightspark/js-lightspark-sdk
+  name: js-lightspark-sdk
+  url: https://github.com/lightsparkdev/js-sdk

package/.prettierrc

@@ -0,0 +1 @@
+{}

package/.turbo/turbo-build.log

@@ -0,0 +1,19 @@
+$ tsup --entry src/index.ts --entry src/objects/index.ts --format cjs,esm --dts
+CLI Building entry: src/index.ts, src/objects/index.ts
+CLI Using tsconfig: tsconfig.json
+CLI tsup v6.7.0
+CLI Target: esnext
+CJS Build start
+ESM Build start
+ESM dist/objects/index.js  2.94 KB
+ESM dist/chunk-3VRI7CHE.js 267.05 KB
+ESM dist/index.js          38.28 KB
+ESM ⚡️ Build success in 60ms
+CJS dist/objects/index.cjs 259.99 KB
+CJS dist/index.cjs         305.74 KB
+CJS ⚡️ Build success in 61ms
+DTS Build start
+DTS ⚡️ Build success in 1145ms
+DTS dist/index.d.ts               3.21 KB
+DTS dist/objects/index.d.ts       2.75 KB
+DTS dist/Withdrawal-27a4d10d.d.ts 76.15 KB

package/.turbo/turbo-lint.log

@@ -0,0 +1,3 @@
+$ npx prettier --check ./src
+Checking formatting...
+All matched files use Prettier code style!

package/CHANGELOG.md

@@ -0,0 +1,49 @@
+# @lightsparkdev/lightspark-sdk
+
+## 0.1.6
+
+### Patch Changes
+
+- Rename server-sdk to lightspark-sdk. It can be used from a browser.
+- Updated dependencies
+  - @lightsparkdev/core@0.1.6
+
+## 0.1.5
+
+### Patch Changes
+
+- Fixing subscription authentication for the wallet-sdk
+- Updated dependencies
+  - @lightsparkdev/core@0.1.5
+
+## 0.1.4
+
+### Patch Changes
+
+- Adding some helpful utilities and fixing react native compatibility.
+- Updated dependencies
+  - @lightsparkdev/core@0.1.4
+
+## 0.1.3
+
+### Patch Changes
+
+- Shrug
+- Updated dependencies
+  - @lightsparkdev/core@0.1.3
+
+## 0.1.2
+
+### Patch Changes
+
+- Changeset work already
+- Updated dependencies
+  - @lightsparkdev/core@0.1.2
+
+## 0.1.1
+
+### Patch Changes
+
+- Initial release testing releases
+- Updated dependencies
+  - @lightsparkdev/core@0.1.1

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2023 Lightspark Group, Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,137 @@
+# The Lightspark JS+TS SDK
+
+This is the Lightspark Typescript SDK, which can be used either from a node or browser environment. It's used to manage accounts, nodes, wallets, etc. See the examples directory for some examples of how to use it!
+
+## Getting started
+
+To use the SDK, you'll need to install it from npm:
+
+```bash
+$ npm install @lightsparkdev/lightspark-sdk
+```
+
+The entry-point to the SDK is the `LightsparkClient` class, which can be imported from the root package.
+To create and authenticate a client from a server-environment, you'll need to provide your API token ID and secret. You can create these from the [Lightspark API Tokens page](https://app.lightspark.com/api-config).
+
+```typescript
+import { AccountTokenAuthProvider, LightsparkClient } from "@lightsparkdev/js-sdk";
+
+const TOKEN_ID = <your api token id>;
+// NOTE: This should be stored securely, e.g. in an environment variable and shouldn't be present in client-side code.
+const TOKEN_SECRET = <your api token secret>;
+
+const lightsparkClient = new LightsparkClient(
+    new AccountTokenAuthProvider(TOKEN_ID, TOKEN_SECRET)
+);
+```
+
+If you want to use the client in a browser environment, you'll need to use a different authentication provider. The `OAuthProvider` can be used to authenticate with the user's Lightspark account. It will open a popup window to the Lightspark login page, and then exchange the authorization code for an access token.
+
+You can then use the client to make API calls. For example, to create an invoice:
+
+```typescript
+const encodedInvoice = await lightsparkClient.createInvoice({
+  amount: { value: 100, unit: CurrencyUnit.SATOSHI },
+  memo: "Whasssupppp",
+  type: InvoiceType.AMP,
+});
+
+const invoiceDetails = await lightsparkClient.decodeInvoice(encodedInvoice);
+console.log(invoiceDetails);
+```
+
+To complete sensitive operations like paying an invoice, you'll need to unlock the paying node using its node ID and password:
+
+```typescript
+const nodeID = <the node ID of a node to unlock>;
+const nodePassword = <the password used to unlock the node>;
+
+try {
+    await lightsparkClient.unlockNode(nodeID, nodePassword);
+} catch (e) {
+    console.error("Failed to unlock node", e);
+}
+
+// Now we can pay the invoice.
+const payment = await lightsparkClient.payInvoice(nodeID, encodedInvoice, 1000);
+console.log(`Payment details: ${payment}`);
+```
+
+You can also use the SDK to subscribe to events from the node, such as transaction updates. For example, to subscribe to transaction updates for a node:
+
+```typescript
+const nodeID = <the node ID of a node to subscribe to>;
+let subscription;
+
+function startListening(nodeId: string) {
+    if (subscription) {
+        return;
+    }
+    console.log("Starting to listen for transactions...");
+
+    subscription = lightsparkClient.listenToTransactions([nodeID]).subscribe({
+        next: (transaction) => {
+            if (transaction) {
+                console.log(`Transaction updated! ${JSON.stringify(transaction)}`);
+            }
+        },
+    });
+}
+
+function stopListening() {
+    if (!subscription) {
+        return;
+    }
+    console.log("Stopping listening for transactions...");
+
+    subscription.unsubscribe();
+    subscription = undefined;
+}
+```
+
+## Examples
+
+Several examples of SDK usage are included in the top-level `examples` directory.
+
+### Node scripts:
+
+Try the node script examples using ts-node!
+
+You'll need to set the following environment variables:
+
+```bash
+$ export LIGHTSPARK_API_TOKEN_CLIENT_ID=<your api token id>
+$ export LIGHTSPARK_API_TOKEN_CLIENT_SECRET=<your api token secret>
+$ export LIGHTSPARK_WALLET_NODE_ID=<the node ID of a node you can use as your default wallet>
+
+# If you want to run full_example.ts, you'll also need to set these:
+$ export LIGHTSPARK_EXAMPLE_NODE_1_NAME=<the display name of a node to use in the example>
+$ export LIGHTSPARK_EXAMPLE_NODE_1_PASSWORD=<the password used to unlock node 1>
+$ export LIGHTSPARK_EXAMPLE_NODE_2_NAME=<the display name of a node to use in the example>
+$ export LIGHTSPARK_EXAMPLE_NODE_2_PASSWORD=<the password used to unlock node 2>
+```
+
+Then, run the examples:
+
+```bash
+$ cd examples/node-scripts
+$ npm install
+$ ts-node getWalletDashboard.ts
+$ ts-node createInvoice.ts -a "100" -m "Whasssupppp"
+```
+
+### Streaming Wallet Extension
+
+This example is meant to be used in conjunction with the [Lightspark streaming sats demo](https://app.lightspark.com/demos/streaming). It can be built and installed as a Chrome extension by running:
+
+```bash
+$ cd examples/streaming-wallet-extension
+$ npm install
+$ npm run build
+```
+
+Then, go to `chrome://extensions` and click "Load unpacked" and select the `streaming-wallet-extension/build` directory.
+
+When the extension is installed, it will automatically open the streaming sats demo page. You can then click extension icon to open the extension popup, which will give you the ability to create a test account with 2 nodes - a viewer node (which acts as your wallet for the demo), and a creator node, which simulates the wallet of the creator of the streaming content. The page will reload and you'll be able to start streaming sats as the video plays!
+
+To see how it works, check out the background directory in the extension code. It uses the SDK to create an invoice on behalf of the creator node, then uses the SDK to pay the invoice on behalf of the viewer node. It also uses the SDK to get the current balance of both nodes and listen for transaction updates, which it broadcasts to the webpage.