react-native-litecard-nfc
v0.1.0
Published
React Native NFC read/write library for MIFARE Ultralight AES (LiteCard mnemonic storage)
Maintainers
Readme
react-native-litecard-nfc
React Native NFC read/write library for MIFARE Ultralight AES (LiteCard mnemonic storage).
Features
- Reader: Check card status, read mnemonic (with PIN), read user nickname
- Writer: Initialize card, update mnemonic, change PIN, write nickname, reset card
- Based on MIFARE Ultralight AES (MF0AES(H)20) data sheet; BIP39 entropy storage with CRC16
Installation
From npm (when published)
yarn add react-native-litecard-nfc
# or
npm install react-native-litecard-nfcFrom Git
yarn add react-native-litecard-nfc@git+https://github.com/your-org/react-native-litecard-nfc.gitPeer dependencies
Install in your app:
react-native(>= 0.70.0)react-native-nfc-manager(>= 3.0.0)
Usage
import {
ReaderResultCode,
WriterResultCode,
checkCard,
readMnemonic,
initializeCard,
updatePassword,
resetCard,
type NfcResult,
} from 'react-native-litecard-nfc';
// Check if card is empty or has data
const result = await checkCard();
if (result.success && result.code === ReaderResultCode.CHECK_EMPTY) {
// Initialize new card
await initializeCard(mnemonic, pin, onCardIdentified);
} else {
// Read or update
const read = await readMnemonic(pin, onCardIdentified);
}API
- Reader:
checkCard,readMnemonic,readUserNickname,cardInfoToJson,ReaderResultCode, lock/cleanup helpers - Writer:
initializeCard,updateCard,updatePassword,writeUserNickname,resetCard,WriterResultCode, lock helpers - Types:
NfcResult,NfcReaderResult
Development
yarn install
yarn buildLicense
MIT
