The Lightning Network is an open, low cost, interoperable payment network that settles in real time. Lightspark is the easiest, most reliable, enterprise-grade gateway to Lightning, enabling money to move just like bits and bytes do on the Internet. You can learn more about our products here.
Welcome to our github home! Here you'll find our open-source SDKs that you can use to enable Lightning payments in your app, website, or backend. You can find full documentation for our SDKs and APIs 📃 here. Here's a summary of some of the repositories you'll find in our org:
This repository contains all of the Lightspark Javascript/Typescript SDKs. Some of the included npm packages are:
- 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.
- react-native: Utilities and alternative implementations of some core Lightspark SDK interfaces to add compatibility with react-native.
- A few other small utility packages
Check out the READMEs for each package for more information on how to use them, or see the examples
directory in each package for sample use cases.
This is a Swift Wallet SDK for the Lightspark Wallet APIs. It can be used from an iOS environment to integrate with a Lightspark Lightning wallet. It also contains a demo iOS app to show how to use the SDK. You can also check out its documentation or API Reference.
This repository contains the Lightspark Kotlin (multiplatform) SDKs. They can be used from either Kotlin or Java, from Android or another JVM context. The repository also contains a sample Android app which uses the wallet-sdk to display basic node, channel, and transaction information. Modules are published to maven-central. Important modules include:
- lightspark-sdk: A simple wrapper around the Lightspark GraphQL server API. It's used to manage accounts, nodes, wallets, etc. It can authenticate using an Account API token retrieved from your Lightspark account dashboard or via the oauth module.
- wallet-sdk: An SDK for interacting with the Lightspark API for a single wallet user. See its documentation or API Reference. It can be used from an Android environment and is used by the sample app androidWalletDemo. See its README for more info.
- core. A module containing common utilities for networking, authentication, and more.
- There are also a few other small utility modules.
In addition to JS and Kotlin/Java, we also offer the Lightspark SDK in Rust, Python, and Golang. See the README file for your language or choice, and check out our API Docs to get started.