This repository contains all of the Lightspark Javascript/Typescript SDKs. The SDKs are organized into the following packages:
- lightspark-sdk: A high-level management SDK that can be used from a node or browser environment. It's used to manage accounts, nodes, wallets, etc. and should be authenticated via API token or OAuth.
- wallet-sdk: A client-side wallet SDK, which can be used from a browser or React Native environment. It's meant to interact with a single wallet user.
- react-wallet: A React library that wraps the wallet SDK and provides some convenient React hooks.
- oauth: A client-side OAuth library, which can be used from a browser or React Native environment. This library currently only authenticates lightspark administrator accounts, not wallet users. Note: This package is currently in unpublished beta, and is subject to change.
Most of our SDK packages are available on npm under @lightsparkdev. We have a number of example apps also available in this repository that you may run directly. To do so we recommend using a version of Node >= LTS and Yarn v3. With Node you can easily install and enable the correct yarn version by running the following:
git clone git@github.com:lightsparkdev/js-sdk.git
cd js-sdk
corepack enable
corepack prepare --activate
yarn
This will install the proper version of yarn and all dependencies for the Lightspark js-sdk workspaces.
Then to build dependencies and run a specific example - get the package.json name of the example and run this from the repo root:
yarn start --filter=@lightsparkdev/remote-signing-server
Or to build all packages and run all examples simply do:
yarn start
Please see the README files in the examples directory for instructions on running the examples. Please note that some packages such as @lightsparkdev/ui are for building the examples only and not necessary for your implementation of our published SDK packages.