socks_socket 1.0.0

SOCKS version 5 sockets for Dart and Flutter, *eg.* ElectrumX and/or Fulcrum over Tor via socket(s).

example/lib/main.dart

// Example app deps, not necessarily needed for tor usage.
import 'dart:async';
import 'dart:convert';
import 'dart:io';

import 'package:flutter/material.dart';
import 'package:path_provider/path_provider.dart';
// Imports needed for tor usage:
import 'package:socks5_proxy/socks_client.dart'; // Just for example; can use any socks5 proxy package, pick your favorite.
import 'package:tor_ffi_plugin/tor_ffi_plugin.dart';
import 'package:tor_ffi_plugin/socks_socket.dart'; // For socket connections

void main() {
  runApp(const MyApp());
}

class MyApp extends StatelessWidget {
  const MyApp({super.key});

  @override
  Widget build(BuildContext context) {
    return const MaterialApp(
      home: Home(),
    );
  }
}

class Home extends StatefulWidget {
  const Home({super.key});

  @override
  State<Home> createState() => _MyAppState();
}

class _MyAppState extends State<Home> {
  // Flag to track if tor has started.
  bool torIsRunning = false;

  // Set the default text for the host input field.
  final hostController = TextEditingController(text: 'https://icanhazip.com/');
  // https://check.torproject.org is another good option.

  Future<void> startTor() async {
    // Start the Tor daemon.
    await Tor.instance.start(
      torDataDirPath: (await getApplicationSupportDirectory()).path,
    );

    // Toggle started flag.
    setState(() {
      torIsRunning = Tor.instance.status == TorStatus.on; // Update flag
    });

    print('Done awaiting; tor should be running');
  }

  @override
  void dispose() {
    // Clean up the controller when the widget is disposed.
    hostController.dispose();
    super.dispose();
  }

  @override
  Widget build(BuildContext context) {
    const spacerSmall = SizedBox(height: 10);
    return Scaffold(
      appBar: AppBar(
        title: const Text('Tor example'),
      ),
      body: SingleChildScrollView(
        child: Container(
          padding: const EdgeInsets.all(10),
          child: Column(
            children: [
              TextButton(
                onPressed: torIsRunning
                    ? null
                    : () async {
                  unawaited(
                    showDialog(
                      barrierDismissible: false,
                      context: context,
                      builder: (_) => const Dialog(
                        child: Padding(
                          padding: EdgeInsets.all(20.0),
                          child: Text("Starting tor..."),
                        ),
                      ),
                    ),
                  );

                  final time = DateTime.now();

                  print("NOW: $time");

                  await startTor();

                  print("Start tor took "
                      "${DateTime.now().difference(time).inSeconds} "
                      "seconds");

                  if (mounted) {
                    Navigator.of(context).pop();
                  }
                },
                child: const Text("Start tor"),
              ),
              Row(
                children: [
                  // Host input field.
                  Expanded(
                    child: TextField(
                      controller: hostController,
                      decoration: const InputDecoration(
                        border: OutlineInputBorder(),
                        hintText: 'Host to request',
                      ),
                    ),
                  ),
                  spacerSmall,
                  TextButton(
                    onPressed: torIsRunning
                        ? () async {
                      // `socks5_proxy` package example, use another socks5
                      // connection of your choice.

                      // Create HttpClient object
                      final client = HttpClient();

                      // Assign connection factory.
                      SocksTCPClient.assignToHttpClient(client, [
                        ProxySettings(InternetAddress.loopbackIPv4,
                            Tor.instance.port,
                            password:
                            null), // TODO Need to get from tor config file.
                      ]);

                      // GET request.
                      final request = await client
                          .getUrl(Uri.parse(hostController.text));
                      final response = await request.close();

                      // Print response.
                      var responseString =
                      await utf8.decodeStream(response);
                      print(responseString);
                      // If host input left to default icanhazip.com, a Tor
                      // exit node IP should be printed to the console.
                      //
                      // https://check.torproject.org is also good for
                      // doublechecking torability.

                      // Close client
                      client.close();
                    }
                        : null,
                    child: const Text("Make proxied request"),
                  ),
                ],
              ),
              spacerSmall,
              TextButton(
                onPressed: torIsRunning
                    ? () async {
                  // Instantiate a socks socket at localhost and on the port selected by the tor service.
                  var socksSocket = await SOCKSSocket.create(
                    proxyHost: InternetAddress.loopbackIPv4.address,
                    proxyPort: Tor.instance.port,
                    sslEnabled: true, // For SSL connections.
                  );

                  // Connect to the socks instantiated above.
                  await socksSocket.connect();

                  // Connect to bitcoin.stackwallet.com on port 50002 via socks socket.
                  //
                  // Note that this is an SSL example.
                  await socksSocket.connectTo(
                      'bitcoin.stackwallet.com', 50002);

                  // Send a server features command to the connected socket, see method for more specific usage example..
                  await socksSocket.sendServerFeaturesCommand();

                  // You should see a server response printed to the console.
                  //
                  // Example response:
                  // `flutter: secure responseData: {
                  // 	"id": "0",
                  // 	"jsonrpc": "2.0",
                  // 	"result": {
                  // 		"cashtokens": true,
                  // 		"dsproof": true,
                  // 		"genesis_hash": "000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f",
                  // 		"hash_function": "sha256",
                  // 		"hosts": {
                  // 			"bitcoin.stackwallet.com": {
                  // 				"ssl_port": 50002,
                  // 				"tcp_port": 50001,
                  // 				"ws_port": 50003,
                  // 				"wss_port": 50004
                  // 			}
                  // 		},
                  // 		"protocol_max": "1.5",
                  // 		"protocol_min": "1.4",
                  // 		"pruning": null,
                  // 		"server_version": "Fulcrum 1.9.1"
                  // 	}
                  // }

                  // Close the socket.
                  await socksSocket.close();
                }
                    : null,
                child: const Text(
                  "Connect to bitcoin.stackwallet.com:50002 (SSL) via socks socket",
                ),
              ),
            ],
          ),
        ),
      ),
    );
  }
}