diff --git a/README.md b/README.md index e3f4099..30e8edd 100644 --- a/README.md +++ b/README.md @@ -1,35 +1,40 @@ - + + + + LNbits + + -# LNPoS, the DIY Point of Sale device -## Free and open-source bitcoin offline LN pos, onchain pos, offline (meatbag) atm -Join us t.me/lnbits, t.me/makerbits -> To be used with extensions LNPoS, FOSSA +[![License: MIT](https://img.shields.io/badge/License-MIT-success?logo=open-source-initiative&logoColor=white)](./LICENSE) +[![Built for LNbits](https://img.shields.io/badge/Built%20for-LNbits-4D4DFF?logo=lightning&logoColor=white)](https://github.com/lnbits/lnbits) -### Installation: -Old tutorial that needs updating -> https://www.youtube.com/watch?v=IhwCEDwGg2E +# LNPoS - [LNbits](https://lnbits.com) extension -1. Web-installer. -Easy setup using browser https://lnpos.lnbits.com. +A lightning point of sale terminal for offline hardware devices. LNPoS turns cheap ESP32 hardware into a portable payment terminal that works without constant internet connection. -2. Terminal -Build the project `sh build.sh`, find the USB device `sh debug.sh `, push the firmware `sh debug.sh /dev/ttyACM0 (<-whatever your device is called)` +Flash your own device using the web installer at [lnpos.lnbits.com](https://lnpos.lnbits.com) -### Hardware: +## How it works -- Lilygo TTGO/Tdisplay -- The Lilygo Keyboard specifically made for LNPoS -=> or get yourself the LNPoS Kit, dimensions 40x52x11mm e.g. in the [LNbits shop](https://shop.lnbits.com/product-category/hardware/point-of-sale-devices) -- 3.7V lithium iron flat battery with 1.25mm JST with < 1000 mAh to fit inside the standard LNPoS Kit -- LNbits LNURLdevice extension +The extension generates LNURL endpoints that your hardware device can use to create invoices and verify payments. Once configured, the device only needs to connect briefly to fetch invoice data, making it work in low-connectivity environments. -### LNPoS – Offline Lightning Network payments +## Features -A random pin generated on the device is encrypted and passed trough the payee. When the payment has been made the unencrypted pin is sent as a receipt. This function makes use of LNURL-pay protocol. Uses LNbits LNURLDevice extension. +- Offline-capable point of sale for ESP32 devices +- LNURL-pay and LNURL-withdraw support +- Works with various display types (OLED, TFT, E-Paper) +- Web-based firmware installer for easy setup -### Onchain – Generate fresh addresses using an xPub +## Usage -Use an xPub to generate a fresh address for every payment. Useful for large purchases. Includes a mempool.space QR so the payment can be verified. +1. Enable the extension in LNbits +2. Create a new LNPoS device and link it to a wallet +3. Flash your ESP32 using the web installer +4. Enter the device credentials and start accepting payments -### LNATM – Meatbag ATM, give refunds, accept cash for sats. +## Powered by LNbits -Create withdraw/faucet links. Uses more-or-less. This function makes use of LNURL-withdraw protocol. Uses LNbits LNURLDevice extension. +[LNbits](https://lnbits.com) is a free and open-source lightning accounts system. + +[![Visit LNbits Shop](https://img.shields.io/badge/Visit-LNbits%20Shop-7C3AED?logo=shopping-cart&logoColor=white&labelColor=5B21B6)](https://shop.lnbits.com/) +[![Try myLNbits SaaS](https://img.shields.io/badge/Try-myLNbits%20SaaS-2563EB?logo=lightning&logoColor=white&labelColor=1E40AF)](https://my.lnbits.com/login) diff --git a/config.json b/config.json new file mode 100644 index 0000000..eda205d --- /dev/null +++ b/config.json @@ -0,0 +1,55 @@ +{ + "id": "lnpos", + "version": "1.1.2", + "name": "LNPoS", + "repo": "https://github.com/lnbits/lnpos_extension", + "short_description": "LNPoS lightning point of sale", + "description": "", + "tile": "/lnpos/static/image/lnpos.png", + "min_lnbits_version": "1.3.0", + "contributors": [ + { + "name": "Ben Arc", + "uri": "mailto:ben@lnbits.com", + "role": "Developer" + }, + { + "name": "BlackCoffee", + "uri": "https://github.com/blackcoffee", + "role": "Developer" + }, + { + "name": "Vlad Stan", + "uri": "https://github.com/arcbtc", + "role": "Developer" + }, + { + "name": "dni", + "uri": "https://github.com/dni", + "role": "Developer" + } + ], + "images": [ + { + "uri": "https://raw.githubusercontent.com/lnbits/lnpos_extension/main/static/image/uPxF8SO.png", + "link": "https://www.youtube.com/watch?v=98VYC99s770", + "tooltip": "demo video" + }, + { + "uri": "https://raw.githubusercontent.com/lnbits/lnpos_extension/main/static/image/oS5VEEf.png" + }, + { + "uri": "https://raw.githubusercontent.com/lnbits/lnpos_extension/main/static/image/U8dgtSl.png" + }, + { + "uri": "https://raw.githubusercontent.com/lnbits/lnpos_extension/main/static/image/7Nz9PyU.png" + } + ], + "description_md": "https://raw.githubusercontent.com/lnbits/lnpos_extension/main/description.md", + "terms_and_conditions_md": "https://raw.githubusercontent.com/lnbits/lnpos_extension/main/toc.md", + "license": "MIT", + "paid_features": "", + "tags": ["Merchant", "Point of Sale", "Hardware"], + "donate": "", + "hidden": false +} diff --git a/description.md b/description.md new file mode 100644 index 0000000..8dbba89 --- /dev/null +++ b/description.md @@ -0,0 +1,10 @@ +Build and manage LNPoS hardware terminals for accepting Lightning payments. + +Its functions include: + +- Configuring Point of Sale terminal settings +- Generating payment requests on hardware devices +- Supporting offline-capable PoS operations +- Managing multiple terminal deployments + +A robust solution for merchants and makers who want to build dedicated hardware terminals for accepting Lightning payments. diff --git a/static/image/7Nz9PyU.png b/static/image/7Nz9PyU.png new file mode 100644 index 0000000..81ecff4 Binary files /dev/null and b/static/image/7Nz9PyU.png differ diff --git a/static/image/U8dgtSl.png b/static/image/U8dgtSl.png new file mode 100644 index 0000000..8df0696 Binary files /dev/null and b/static/image/U8dgtSl.png differ diff --git a/static/image/lnpos.png b/static/image/lnpos.png new file mode 100644 index 0000000..3a5304f Binary files /dev/null and b/static/image/lnpos.png differ diff --git a/static/image/oS5VEEf.png b/static/image/oS5VEEf.png new file mode 100644 index 0000000..36135ef Binary files /dev/null and b/static/image/oS5VEEf.png differ diff --git a/static/image/uPxF8SO.png b/static/image/uPxF8SO.png new file mode 100644 index 0000000..3b73a94 Binary files /dev/null and b/static/image/uPxF8SO.png differ diff --git a/toc.md b/toc.md new file mode 100644 index 0000000..baa0342 --- /dev/null +++ b/toc.md @@ -0,0 +1,29 @@ +# Terms and Conditions for LNbits Extension + +## 1. Acceptance of Terms + +By installing and using the LNbits extension ("Extension"), you agree to be bound by these terms and conditions ("Terms"). If you do not agree to these Terms, do not use the Extension. + +## 2. License + +The Extension is free and open-source software, released under [specify the FOSS license here, e.g., GPL-3.0, MIT, etc.]. You are permitted to use, copy, modify, and distribute the Extension under the terms of that license. + +## 3. No Warranty + +The Extension is provided "as is" and with all faults, and the developer expressly disclaims all warranties of any kind, whether express, implied, statutory, or otherwise, including but not limited to warranties of merchantability, fitness for a particular purpose, non-infringement, and any warranties arising out of course of dealing or usage of trade. No advice or information, whether oral or written, obtained from the developer or elsewhere will create any warranty not expressly stated in this Terms. + +## 4. Limitation of Liability + +In no event will the developer be liable to you or any third party for any direct, indirect, incidental, special, consequential, or punitive damages, including lost profit, lost revenue, loss of data, or other damages arising out of or in connection with your use of the Extension, even if the developer has been advised of the possibility of such damages. The foregoing limitation of liability shall apply to the fullest extent permitted by law in the applicable jurisdiction. + +## 5. Modification of Terms + +The developer reserves the right to modify these Terms at any time. You are advised to review these Terms periodically for any changes. Changes to these Terms are effective when they are posted on the appropriate location within or associated with the Extension. + +## 6. General Provisions + +If any provision of these Terms is held to be invalid or unenforceable, that provision will be enforced to the maximum extent permissible, and the other provisions of these Terms will remain in full force and effect. These Terms constitute the entire agreement between you and the developer regarding the use of the Extension. + +## 7. Contact Information + +If you have any questions about these Terms, please contact the developer at [developer's contact information].