https://github.com/lnbits/scrub

https://github.com/lnbits/scrub

Last synced: 8 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/lnbits/scrub
• Owner: lnbits
• License: mit
• Created: 2023-02-15T08:20:47.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-12-12T14:59:09.000Z (over 1 year ago)
• Last Synced: 2024-12-12T15:37:51.678Z (over 1 year ago)
• Language: HTML
• Size: 128 KB
• Stars: 5
• Watchers: 4
• Forks: 2
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-lnbits - Scrub - Automatically forward funds that get paid to a wallet/LNURL (Uncategorized / Uncategorized)

README

          
# Scrub - [LNbits](https://github.com/lnbits/lnbits) extension

For more about LNBits extension check [this tutorial](https://github.com/lnbits/lnbits/wiki/LNbits-Extensions)

## Automatically forward funds (Scrub) that get paid to the wallet to an LNURLpay or Lightning Address

SCRUB is a small but handy extension that allows a user to take advantage of all the functionalities inside **LNbits** and upon a payment received to your LNbits wallet, automatically forward it to your desired wallet via LNURL or LNAddress!

Only whole values, integers, are Scrubbed, amounts will be rounded down (example: 6.3 will be 6)! The decimals, if existing, will be kept in your wallet!

[**Wallets supporting LNURL**](https://github.com/fiatjaf/awesome-lnurl#wallets)

## Usage

1. Create an scrub (New Scrub link)\

   ![create scrub](https://i.imgur.com/LUeNkzM.jpg)

   - select the wallet to be _scrubbed_

   - make a small description

   - enter either an LNURL pay or a lightning address

   Make sure your LNURL or LNaddress is correct!

2. A new scrub will show on the _Scrub links_ section\

   ![scrub](https://i.imgur.com/LNoFkeu.jpg)

   - only one scrub can be created for each wallet!

   - You can _edit_ or _delete_ the Scrub at any time\

     ![edit scrub](https://i.imgur.com/Qu65lGG.jpg)

3. On your wallet, you'll see a transaction of a payment received and another right after it as apayment sent, marked with **#scrubed**\

   ![wallet view](https://i.imgur.com/S6EWWCP.jpg)