New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More →

@getalby/lightning-wallet-connect

Package Overview

Dependencies

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

@getalby/lightning-wallet-connect

Web components to connect to a lightning wallet and power a website with WebLN

1.0.0
npm

Version published: 2 years ago

Weekly downloads: 22; increased by2100%

Maintainers: 4

Weekly downloads

Created: 2 years ago

Source

Lightning Wallet Connect

This project includes web components for connecting to Lightning Wallets and enabling WebLN. Websites only need to implement a single interface to connect with multiple wallets (WebLN), and users can connect from both desktop and mobile devices. These components work with pure HTML and all Javascript libraries frameworks such as React, Angular, Vue, Solid.js, etc.

🚀 Quick Start

npm install @getalby/lightning-wallet-connect

yarn add @getalby/lightning-wallet-connect

or for use without any build tools:

<script src="https://cdn.jsdelivr.net/npm/@getalby/lightning-wallet-connect@1.0.0/dist/index.browser.js"></script>

📽️ Demo

https://user-images.githubusercontent.com/33993199/234830578-0baf25f9-0179-4244-941c-0c558c613a7a.mov

🤙 Usage

Lightning wallet connect exposes the following web components for allowing user to connect their desired Lightning wallet:

<lwc-button/> - launches the LWC Modal on click
- Optional Arguments:
  - icon-only - display the button as an icon without "Connect wallet"
  - disabled - mark the button as disabled. NOTE: in react disabled={false} will not work - attribute must be omitted
<lwc-modal/> - render the modal on its own
<lwc-connector-list/> - render the list of connectors on their own
more components coming soon

Lightning wallet connect exposes the following events:

lwc:connected window event which fires when a wallet is connected and window.webln is ready to use
lwc:modalclosed window event which fires when Lightning Wallet Connect modal is closed

Current wallets supported:

[Alby Browser extension] (https://getalby.com)
Alby NWC

Pure HTML

<html>
  <body>
    <lwc-button></lwc-button>
    <script src="https://cdn.jsdelivr.net/npm/@getalby/lightning-wallet-connect@1.0.0/dist/index.browser.js"></script>
    <script>
      window.addEventListener('lwc:connected', async () => {
        // TODO: hide the lwc-button
        const invoice = // (...invoice generated by backend)
          await window.webln.sendPayment(invoice);
        confetti();
      });
    </script>
  </body>
</html>

React

import '@getalby/lightning-wallet-connect';

// in your component, listen to lightning wallet connected event
const [lwcConnected, setLwcConnected] = React.useState(false);

React.useEffect(() => {
  const onConnected = () => setLwcConnected(true);
  window.addEventListener('lwc:connected', onConnected);

  return () => {
    window.removeEventListener('lwc:connected', onConnected);
  };
}, []);

const invoice = // (...invoice generated by backend)

return lwcConnected ? <>
    <button onClick={() => window.webln.sendPayment(invoice)}/>
  </> : <lwc-button/>;

🔥 Lit

This project is powered by Lit.

See Get started on the Lit site for more information.

🛠️ Development

yarn dev

Build

yarn build

Testing

yarn test

Need help?

We are happy to help, please contact us or create an issue.

Twitter: @getAlby
Telegram group
support at getalby.com
bitcoin.design Discord community (find us on the #alby channel)
Read the Alby developer guide to better understand how Alby packages and APIs can be used to power your app.

License

MIT

Keywords

FAQs

What is @getalby/lightning-wallet-connect?

Is @getalby/lightning-wallet-connect popular?

Is @getalby/lightning-wallet-connect well maintained?

Package last updated on 01 Aug 2023

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install