Code Monkey home page Code Monkey logo

bolt-nfc-android-app's Introduction

Boltcard NFC Programming App

Quickly program a blank NFC card (NTAG424DNA) to act as your own personal Boltcard. A contactless / paywave like experience for the Lightning network. Before programming your NFC card you must set up your own boltcard server.

The boltcard can be used with Lightning PoS terminals that have NFC support, or Breez wallet PoS App.

Android only due to the NXP Taplinx library dependency which does not have an iOS version available.

Find out more at boltcard.org

Current Version

v0.1.3

NFC Card Support

  • NXP NTAG424 DNA
  • NXP NTAG424 DNA TT (Tag Tamper) Thanks to Bassim

Quick Install

Download the compiled APK from the latest release and install on your android phone.

Download from the Google Play store

Setup & Run instructions for Linux with Android

Build instructions

  1. Install android studio https://developer.android.com/studio
  2. Install Android 12 SDK version 31 reference: https://reactnative.dev/docs/environment-setup “Android Studio installs the latest Android SDK by default. Building a React Native app with native code, however, requires the Android 12 (S) SDK in particular. Additional Android SDKs can be installed through the SDK Manager in Android Studio.“
  3. Install Google APIs Intel x86 Atom_64 System Image
  4. Install node v14.X or v16.X (v14.20.0 & v16.14.2 are working)
  5. Install NPX https://www.npmjs.com/package/npx
  6. Install Yarn https://yarnpkg.com/
  7. Might also be needed: $ sudo corepack enable
  8. Install JDK $sudo apt install default-jdk
  9. clone repo to dir
  10. cd to dir and run yarn (might be some warnings)
  11. connect android phone to USB and enable USB debugging on phone.
  12. in the terminal type $npx react-native start
  13. Register an app key for the Taplinx SDK library on https://inspire.nxp.com/mifare/
  14. Rename .env-example to .env and set the Mifare package key in this file
  15. open another terminal in same dir and type $npx react-native run-android

Usage

  1. Install boltcard server and aquire some blank NTAG424DNA tags.
  2. When app has loaded go to the write screen and put your lnurlw domain and path in to the text box.
  3. When finished tap a card on the NFC scanner to write the card.
  4. Go to the read screen and check that your URL looks correct. Should also be outputting the PICC and CMAC as URL paramters
  5. To change your keys (to prevent malicious re-writing of your card) Go to the boltcard server terminal and run the command to show the card key change URL in QR code form and then scan this with the phone camera to load the server keys.
  6. When the keys are loaded, Hold the NFC card to the phone to run the key change on the card. Do not move the card until the key change has completed. Warning! If you lose the new keys then you will be unable to reprogram the card again

Wiping cards

To wipe a card get the keys into a json in the following format:

{
	"version": 1
	"action": "wipe",
	"k0": "11111111111111111111111111111111",
	"k1": "22222222222222222222222222222222",
	"k2": "33333333333333333333333333333333",
	"k3": "44444444444444444444444444444444",
	"k4": "55555555555555555555555555555555",
}

Go to the advanced > key reset screen and either paste this json from the clipboard or scan a QR code with this JSON encoded in it. Then press "reset card now" and tap and hold your card against the NFC reader.

Dependencies / Security considerations

We rely on the Taplinx 2.0 Android library supplied by NXP.

React native libraries are also used to make building the UI easier.

Keep all your keys secret, and be careful when creating your cards that there are no other potential listening devices in range.

Useful debug commands

  • npm run run-android
  • adb logcat -s "lightningnfcapp"
  • java --module-path ~/Android/javafx-sdk-18.0.2/lib --add-modules javafx.controls,javafx.fxml -jar TagXplorer-v1.2.jar
  • ./gradlew assembleRelease
  • \copy (select * from cards order by card_id) to export.csv CSV HEADER;

bolt-nfc-android-app's People

Contributors

boltcarddev avatar leesalminen avatar peterrounce avatar robertclarkson 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.