Skip to content

v0.1.0

Choose a tag to compare

@jamaljsr jamaljsr released this 21 Jul 17:02
· 130 commits to main since this release
20d686c

First public release of the Wavelength SDK: a TypeScript SDK for embedding a self-custodial Bitcoin, Lightning, and Ark wallet directly in your web or React Native app. Your users send and receive Lightning payments with no node to run, no channels to open, and no inbound liquidity to manage, while their keys stay on their own device.

Building a pure-native Kotlin or Swift app? The same embedded wallet ships as a native mobile SDK in wavelength-mobile, documented in the Native iOS & Android section of the docs.

Packages

Published to npm under @lightninglabs:

  • @lightninglabs/wavelength-core: the transport- and framework-agnostic contract.
  • @lightninglabs/wavelength-web: the browser (WebAssembly) transport.
  • @lightninglabs/wavelength-react: React provider and hooks.
  • @lightninglabs/wavelength-react-native: the React Native transport.
# React + web
npm install @lightninglabs/wavelength-react @lightninglabs/wavelength-web

# React Native
npm install @lightninglabs/wavelength-react @lightninglabs/wavelength-react-native

Networks

Signet and testnet are open to anyone. Mainnet is gated to an approved allowlist: request access with your client's identity_pubkey (from wavecli getinfo) through the mainnet access request form. See Mainnet access in the docs for the full steps.

Runtime and native binaries

The web transport's WebAssembly runtime and the mobile native bindings are distributed as assets on the paired wavelength v0.1.0 release. Download the asset set (or build it from a wavelength checkout) and host or stage it yourself. See the docs for the exact steps per platform.

API stability

The client API is functional and supported, but method signatures and JSON field names are versioned together with the wallet runtime and can change between releases. Pin a specific version for production integrations.

Documentation

https://wavelength.lightning.engineering