Provider agnostic Dart implementation of the OpenCryptoPay payment flow for crypto wallets.

Features

• Decode scanned OpenCryptoPay QR links
• Fetch pending payment details for a given coin
• Fetch coins supported from provider
• Submit proof of payment
• Detect proof type (signed TX HEX vs tx hash) and instruct wallet accordingly
• Let wallet plug their own HTTP client (package:http Client) and coin type

Install

dependencies:
  opencryptopay: ^0.1.0

Usage

import 'package:http/http.dart';
import 'package:opencryptopay/opencryptopay.dart';

// 1. Implement CryptoCoin for your wallet's coin type.
class MyCoin implements CryptoCoin {
  const MyCoin(this.ticker, this.prettyName);
  @override final String ticker;
  @override final String prettyName;
}

// 2. Provide a package:http Client.
//    Configure Tor / SOCKS routing at the client level (ex: with an
//    IOClient wrapping a SOCKS-assigned HttpClient) — no per-request proxy
//    plumbing is needed here.
final client = Client();

// 3. Build the service + controller.
final controller = OpenCryptoPayController(
  service: OpenCryptoPayService(client: client),
);

// 4. Run the controller
final result = await controller.run(
  qrData: scannedQrData,
  coin: MyCoin('BTC', 'Bitcoin'),
  ownedCoins: [ /* the user's coins */ ],
);

switch (result) {
  case OpenCryptoPaySuccess(:final details, :final address, :final amount, :final proofType, :final coin):
    // prefill your send form with address/amount, then branch on proofType:
    switch (proofType) {
      case OpenCryptoPayProofType.signedTransactionHex:
        // Sign the transaction but do NOT broadcast it.
        // Submit the signed transaction HEX; the provider broadcasts it.
        await controller.submitProof(
          details: details, coin: coin, txProof: signedTxHex);
      case OpenCryptoPayProofType.transactionHash:
        // Sign AND broadcast the transaction yourself.
        // Submit the resulting transaction hash for verification.
        await controller.submitProof(
          details: details, coin: coin, txProof: txHash);
    }
  case OpenCryptoPayUnsupported(:final alternatives):
    // offer the user to pay with an alternative wallet.
  case OpenCryptoPayNoPending():
  case OpenCryptoPayLightning():
  case OpenCryptoPayInvalidAddress():
  case OpenCryptoPayError():
}