Code Monkey home page Code Monkey logo

lightningatm's Introduction

LightningATM

This LightningATM was built to distribute small amounts of BTC - obviously - it only accepts coins. It shall demonstrate the power of Bitcoins Lightning Network. A two cent coin is enough to buy some satoshis at the LightningATM.

A physical coin exchanged into bitcoin and send to your lightning wallet in seconds. Use this project to educate your family and friends or guests at your bitcoin meetup - a convenient and easy on-boarding process for people that are new to bitcoin.

Please be aware that this is a hobbyist project and it is not secure and reliable enough to withstand attacks. I discourage the use of this setup in a professional environment - but it's rather a good educational tool

There are currently two versions of the Lightning ATM. The large full version with a camera for scanning invoices and a button for acknowledgment and other functions. And there is the somewhat slimmed-down version for mobile use, the pocket version.

Full Version Pocket Version

Required components

Installation guideline

Carry out the points step by step as described here. This is the quickest way to succeed. ๐Ÿ˜Š

If you want to update your ATM version, see this guide: Update

More information of how to setup the LightningATM can be found here https://docs.lightningatm.me. Also join the Telegram group of LightningATM builders here https://t.me/lightningatm_building or contact 21isenough on Twitter (https://twitter.com/21isenough).

To see the Lightning ATM in action, check out this video LightningATM in action

Mentioned

Documentations in other languages

Todo list

Prio 1

Prio 2

  • Dashboard for settings (via mobile)
  • Add second button and admin menu
  • Add admin function only available through qr pass
  • Run certain functions in threads
  • Additional button for restart and shutdown
  • Find solution to work without jumper cables
  • Add encrypted partition with sensible data

Prio 3

Done

  • Update doc with new features, screens
  • Check out BTCPay API to integrate backend
  • Add coin return stopper to 3d design
  • Try different e-ink screen
  • Add a language file to change strings easily
  • Write installations instructions (see docs.lightningatm.me)
  • Rethink the design decisions in regards to hardware (https://www.arrow.com/en/products)
  • Add encryption of admin.macaroon in idle mode
  • Design ideas for case
  • Slightly recline front board to the back, add immersion for camera
  • Move scanning function into utils
  • Move all display functions into display.py
  • Implement lnurl with lntxbot
  • Draw printer and boards in 3D (https://www.onshape.com/)
  • Write list of all compatible wallets/qr qr_codes
  • Test qr code on 2" eInk display (works)
  • Research camera resolutions / qr code scanning
  • Check if there's other zbar python libraries
  • Change to wide angle camera
  • Sort out scan errors
  • QR code scan function
  • Validate requested amount
  • Reject to high amounts
  • Add config file
  • Add parts list to readme
  • Ask for rescan of QR code
  • Inform about failed scan
  • Implement continuous QR Scan
  • Lower case ln invoices
  • Find a faster solution for QR scans (zbarcam)
  • Organize todos better

lightningatm's People

Contributors

21isenough avatar lightisfaster avatar willcl-ark avatar tomstammis avatar axelhamburch avatar emzy avatar abellykens avatar vnnkl avatar aarondewes avatar bengweeks avatar lth-elm avatar ferdymercury avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.