https://github.com/getalby/js-sdk
JavaScript SDK for the Alby OAuth2 Wallet API and the Nostr Wallet Connect API.
https://github.com/getalby/js-sdk
bitcoin javascript lightning-network nostr nostrwalletconnect oauth2 sdk
Last synced: about 2 months ago
JSON representation
JavaScript SDK for the Alby OAuth2 Wallet API and the Nostr Wallet Connect API.
- Host: GitHub
- URL: https://github.com/getalby/js-sdk
- Owner: getAlby
- Created: 2022-10-15T22:33:27.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2025-04-05T18:29:02.000Z (2 months ago)
- Last Synced: 2025-04-05T23:32:05.808Z (2 months ago)
- Topics: bitcoin, javascript, lightning-network, nostr, nostrwalletconnect, oauth2, sdk
- Language: TypeScript
- Homepage: https://npmjs.com/package/@getalby/sdk
- Size: 982 KB
- Stars: 71
- Watchers: 6
- Forks: 24
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Alby JS SDK
## Introduction
Build zero-custody bitcoin payments into apps with a few lines of code.
This JavaScript SDK is for interacting with a bitcoin lightning wallet via Nostr Wallet Connect or the Alby Wallet API.
## Installing
```bash
npm install @getalby/sdk
```
or
```bash
yarn add @getalby/sdk
```
or for use without any build tools:
```html
import { nwc, webln } from "https://esm.sh/@getalby/[email protected]"; // jsdelivr.net, skypack.dev also work
// ... then use nwc.NWCClient or webln.NWC (see documentation below)
```
## Lightning Network Client (LN) Documentation
Quickly get started adding lightning payments to your app.
> The easiest way to provide credentials is with an [NWC connection secret](https://nwc.dev). Get one in minutes by connecting to [Alby Hub](https://albyhub.com/), [coinos](https://coinos.io/apps/new), [Primal](https://primal.net/downloads), [lnwallet.app](https://lnwallet.app/), [Yakihonne](https://yakihonne.com/), [or other NWC-enabled wallets](https://github.com/getAlby/awesome-nwc?tab=readme-ov-file#nwc-wallets).
For example, to make a payment:
```js
import { LN, USD } from "@getalby/sdk";
const credentials = "nostr+walletconnect://..."; // the NWC connection credentials
await new LN(credentials).pay("lnbc..."); // pay a lightning invoice
await new LN(credentials).pay("[email protected]", USD(1)); // or pay $1 USD to a lightning address
```
Or to request a payment to be received:
```js
const request = await new LN(credentials).receive(USD(1.0));
// give request.invoice to someone...
request.onPaid(giveAccess);
```
[Read more](./docs/lnclient.md)
For more flexibility you can access the underlying NWC wallet directly. Continue to read the Nostr Wallet Connect documentation below.
## Nostr Wallet Connect Documentation
[Nostr Wallet Connect](https://nwc.dev) is an open protocol enabling applications to interact with bitcoin lightning wallets. It allows users to connect their existing wallets to your application allowing developers to easily integrate bitcoin lightning functionality.
For apps, see [NWC client and NWA client documentation](./docs/nwc.md)
For wallet services, see [NWC wallet service documentation](./docs/nwc-wallet-service.md)
## Alby Wallet API Documentation
The [Alby OAuth API](https://guides.getalby.com/alby-wallet-api/reference/getting-started) allows you to integrate bitcoin lightning functionality provided by the Alby Wallet into your applications, with the Alby Wallet API. Send & receive payments, create invoices, setup payment webhooks, access Podcasting 2.0 and more!
[Read more](./docs/oauth.md)
### NodeJS
#### Fetch
**This library relies on a global fetch() function which will work in browsers and node v18.x or newer.** (In older versions you have to use a polyfill.)
#### Websocket polyfill
To use this on Node.js you first must install `[email protected]` and import it:
```js
import "websocket-polyfill";
// or: require('websocket-polyfill');
```
## WebLN Documentation
The JS SDK also has some implementations for [WebLN](https://webln.guide).
See the [NostrWebLNProvider documentation](./docs/nwc.md) and [OAuthWebLNProvider documentation](./docs/oauth.md).
## More Documentation
Read the [auto-generated documentation](https://getalby.github.io/js-sdk/modules.html)
## Need help?
We are happy to help, please contact us or create an issue.
- [Twitter: @getAlby](https://twitter.com/getAlby)
- [Telegram Community Chat](https://t.me/getAlby)
- e-mail to [email protected]
- [bitcoin.design](https://bitcoin.design/) Slack community [#lightning-browser-extension](https://bitcoindesign.slack.com/archives/C02591ADXM2)
- Read the [Alby developer guide](https://guides.getalby.com/developer-guide) to better understand how Alby packages and APIs can be used to power your app.
## Thanks
The client and the setup is inspired and based on the [twitter-api-typescript-sdk](https://github.com/twitterdev/twitter-api-typescript-sdk).
## License
MIT