Flutter TxMS

A Flutter package for encoding and decoding hex messages for SMS/MMS communication. This package provides a robust solution for handling hex-encoded messages across multiple platforms.

Features

• 🔄 Hex encoding and decoding
• 📱 SMS/MMS message generation
• 📊 Message segmentation counting
• 💾 File download support
• 📲 Direct SMS/MMS client opening
• 🌐 Cross-platform support (iOS, Android, Web, Desktop)
• 🔀 Country, calling-code, EFTA, EEA, EU, WB6, and organization-aware number selection
• 🧩 Extensible blockchain number pools and aliases
• 🔒 Null safety
• 📚 Comprehensive documentation

Getting Started

Add this to your package's pubspec.yaml file:

dependencies:
  flutter_txms: ^1.0.0

Usage

Parse transaction receipt SMS

final receipt = Txms().parseSMS(
  '+12019715152',
  'OK -1.25 USDX TxID: 0xabc',
);

print(receipt?.amount); // 1.25 (exact decimal string)
print(receipt?.asset); // USDX
print(receipt?.direction); // TxmsTransactionDirection.outgoing

The sign is returned separately as direction; amount is always unsigned. A missing sign is treated as incoming. Labeled and minimal receipt formats remain unsupported.

Basic Example

import 'package:flutter_txms/flutter_txms.dart';

void main() {
  final txms = Txms();

  // Encode a hex string
  final encoded = txms.encode('0x48656c6c6f20576f726c64'); // "Hello World"
  print('Encoded: $encoded');

  // Decode back to hex
  final decoded = txms.decode(encoded);
  print('Decoded: $decoded');
}

SMS Generation and Opening

final txms = Txms();

// Generate SMS URI
final smsUri = txms.sms(
  number: '+12019715152',
  message: '0x48656c6c6f',
  network: 'mainnet',
);
print('SMS URI: $smsUri');

// Open SMS client directly with encoded message
await txms.openSmsClient(
  number: '+12019715152',
  message: '0x48656c6c6f',
  network: 'mainnet',
);

// Open MMS client directly with encoded message
await txms.openMmsClient(
  number: '+12019715152',
  message: '0x48656c6c6f',
  network: 'mainnet',
);

File Operations

final txms = Txms();

// Save message to file
final filePath = await txms.downloadMessage(
  '0x48656c6c6f20576f726c64',
  optionalFilename: 'hello',
);
print('Saved to: $filePath');

Message Counting

final txms = Txms();

// Count SMS segments
final smsCount = txms.count('0x48656c6c6f20576f726c64', 'sms');
print('Number of SMS segments: $smsCount');

// Count MMS segments
final mmsCount = txms.count('0x48656c6c6f20576f726c64', 'mms');
print('Number of MMS segments: $mmsCount');

Number Selection and Custom Pools

final txms = Txms();

// Select directly or fall back through shared calling codes, EFTA/EEA/EU or
// WB6/EU, other supported organizations, then the global endpoint.
final number = txms.getNumber(iso3166A2: 'ca', network: 'xcb');

// Add a blockchain pool and an alias without changing the library.
Txms.addCountry('teth', 'global', ['+441234567890']);
Txms.addCountry('teth', 'gb', ['+441234567890']);
Txms.addAlias('testnet', 'teth');

final customNumber = txms.getNumber(
  iso3166A2: 'gb',
  network: 'testnet',
);

Platform Support

Android	iOS	Web	macOS	Windows	Linux
✅	✅	✅	✅	✅	✅

Additional Features

• Custom network aliases
• Named xcb and xab number pools
• Country-specific endpoints
• Batch message processing
• Platform-specific URI generation
• Comprehensive error handling
• Direct SMS/MMS client launching

Contributing

Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.

License

This project is licensed under the CORE License - see the LICENSE file for details.