Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Tor SOCKS option to ASB for registering to Tor Rendezvous servers and for Electrum client #1420

Open
wants to merge 9 commits into
base: master
Choose a base branch
from
4 changes: 2 additions & 2 deletions swap/src/asb/command.rs
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,7 @@ pub struct Arguments {
#[derive(Debug, PartialEq, Eq)]
pub enum Command {
Start {
resume_only: bool,
resume_only: bool
},
History,
Config,
Expand Down Expand Up @@ -266,7 +266,7 @@ pub enum RawCommand {
long = "resume-only",
help = "For maintenance only. When set, no new swap requests will be accepted, but existing unfinished swaps will be resumed."
)]
resume_only: bool,
resume_only: bool
},
#[structopt(about = "Prints swap-id and the state of each swap ever made.")]
History,
Expand Down
14 changes: 12 additions & 2 deletions swap/src/asb/network.rs
Original file line number Diff line number Diff line change
Expand Up @@ -29,15 +29,25 @@ use std::time::Duration;
use uuid::Uuid;

pub mod transport {
use libp2p::core::transport::OptionalTransport;
use crate::network::tor_transport::TorDialOnlyTransport;
use super::*;

/// Creates the libp2p transport for the ASB.
pub fn new(identity: &identity::Keypair) -> Result<Boxed<(PeerId, StreamMuxerBox)>> {
pub fn new(
identity: &identity::Keypair,
maybe_tor_socks5_port: Option<u16>,
) -> Result<Boxed<(PeerId, StreamMuxerBox)>> {
let tcp = TokioTcpConfig::new().nodelay(true);
let tcp_with_dns = TokioDnsConfig::system(tcp)?;
let websocket_with_dns = WsConfig::new(tcp_with_dns.clone());

let transport = tcp_with_dns.or_transport(websocket_with_dns).boxed();
let maybe_tor_transport = match maybe_tor_socks5_port {
Some(port) => OptionalTransport::some(TorDialOnlyTransport::new(port)),
None => OptionalTransport::none(),
};

let transport = maybe_tor_transport.or_transport(tcp_with_dns).or_transport(websocket_with_dns).boxed();

authenticate_and_multiplex(transport, identity)
}
Expand Down
57 changes: 31 additions & 26 deletions swap/src/bin/asb.rs
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,25 @@ async fn main() -> Result<()> {
let seed =
Seed::from_file_or_generate(&config.data.dir).expect("Could not retrieve/initialize seed");

let tor_client =
tor::Client::new(config.tor.socks5_port).with_control_port(config.tor.control_port);
let _ac = match tor_client.assert_tor_running().await {
Ok(_) => {
tracing::info!("Setting up Tor hidden service");
let ac =
register_tor_services(config.network.clone().listen, tor_client, &seed)
.await?;
Some(ac)
}
Err(_) => {
tracing::warn!("Tor not found. Running on clear net");
None
}
};
let tor_port = if _ac.is_some() { config.tor.socks5_port } else { 0u16 };
let proxy_string = if tor_port != 0u16 { format!("127.0.0.1:{}", tor_port) } else { "".to_string() };
tracing::info!(%proxy_string, "SOCKS5");
pokkst marked this conversation as resolved.
Show resolved Hide resolved

match cmd {
Command::Start { resume_only } => {
// check and warn for duplicate rendezvous points
Expand Down Expand Up @@ -140,29 +159,12 @@ async fn main() -> Result<()> {
}
}

let bitcoin_wallet = init_bitcoin_wallet(&config, &seed, env_config).await?;
let bitcoin_wallet = init_bitcoin_wallet(&config, &seed, env_config, proxy_string).await?;
let bitcoin_balance = bitcoin_wallet.balance().await?;
tracing::info!(%bitcoin_balance, "Bitcoin wallet balance");

let kraken_price_updates = kraken::connect(config.maker.price_ticker_ws_url.clone())?;

// setup Tor hidden services
let tor_client =
tor::Client::new(config.tor.socks5_port).with_control_port(config.tor.control_port);
let _ac = match tor_client.assert_tor_running().await {
Ok(_) => {
tracing::info!("Setting up Tor hidden service");
let ac =
register_tor_services(config.network.clone().listen, tor_client, &seed)
.await?;
Some(ac)
}
Err(_) => {
tracing::warn!("Tor not found. Running on clear net");
None
}
};

let kraken_rate = KrakenRate::new(config.maker.ask_spread, kraken_price_updates);
let namespace = XmrBtcNamespace::from_is_testnet(testnet);

Expand All @@ -175,7 +177,8 @@ async fn main() -> Result<()> {
env_config,
namespace,
&rendezvous_addrs,
)?;
tor_port
).await?;

for listen in config.network.listen.clone() {
Swarm::listen_on(&mut swarm, listen.clone())
Expand Down Expand Up @@ -241,7 +244,7 @@ async fn main() -> Result<()> {
println!("{}", config_json);
}
Command::WithdrawBtc { amount, address } => {
let bitcoin_wallet = init_bitcoin_wallet(&config, &seed, env_config).await?;
let bitcoin_wallet = init_bitcoin_wallet(&config, &seed, env_config, proxy_string).await?;

let amount = match amount {
Some(amount) => amount,
Expand All @@ -264,20 +267,20 @@ async fn main() -> Result<()> {
let monero_balance = monero_wallet.get_balance().await?;
tracing::info!(%monero_balance);

let bitcoin_wallet = init_bitcoin_wallet(&config, &seed, env_config).await?;
let bitcoin_wallet = init_bitcoin_wallet(&config, &seed, env_config, proxy_string).await?;
let bitcoin_balance = bitcoin_wallet.balance().await?;
tracing::info!(%bitcoin_balance);
tracing::info!(%bitcoin_balance, %monero_balance, "Current balance");
}
Command::Cancel { swap_id } => {
let bitcoin_wallet = init_bitcoin_wallet(&config, &seed, env_config).await?;
let bitcoin_wallet = init_bitcoin_wallet(&config, &seed, env_config, proxy_string).await?;

let (txid, _) = cancel(swap_id, Arc::new(bitcoin_wallet), db).await?;

tracing::info!("Cancel transaction successfully published with id {}", txid);
}
Command::Refund { swap_id } => {
let bitcoin_wallet = init_bitcoin_wallet(&config, &seed, env_config).await?;
let bitcoin_wallet = init_bitcoin_wallet(&config, &seed, env_config, proxy_string).await?;
let monero_wallet = init_monero_wallet(&config, env_config).await?;

refund(
Expand All @@ -291,7 +294,7 @@ async fn main() -> Result<()> {
tracing::info!("Monero successfully refunded");
}
Command::Punish { swap_id } => {
let bitcoin_wallet = init_bitcoin_wallet(&config, &seed, env_config).await?;
let bitcoin_wallet = init_bitcoin_wallet(&config, &seed, env_config, proxy_string).await?;

let (txid, _) = punish(swap_id, Arc::new(bitcoin_wallet), db).await?;

Expand All @@ -306,7 +309,7 @@ async fn main() -> Result<()> {
swap_id,
do_not_await_finality,
} => {
let bitcoin_wallet = init_bitcoin_wallet(&config, &seed, env_config).await?;
let bitcoin_wallet = init_bitcoin_wallet(&config, &seed, env_config, proxy_string).await?;

let (txid, _) = redeem(
swap_id,
Expand All @@ -319,7 +322,7 @@ async fn main() -> Result<()> {
tracing::info!("Redeem transaction successfully published with id {}", txid);
}
Command::ExportBitcoinWallet => {
let bitcoin_wallet = init_bitcoin_wallet(&config, &seed, env_config).await?;
let bitcoin_wallet = init_bitcoin_wallet(&config, &seed, env_config, proxy_string).await?;
let wallet_export = bitcoin_wallet.wallet_export("asb").await?;
println!("{}", wallet_export.to_string())
}
Expand All @@ -332,11 +335,13 @@ async fn init_bitcoin_wallet(
config: &Config,
seed: &Seed,
env_config: swap::env::Config,
proxy_string: String,
) -> Result<bitcoin::Wallet> {
tracing::debug!("Opening Bitcoin wallet");
let data_dir = &config.data.dir;
let wallet = bitcoin::Wallet::new(
config.bitcoin.electrum_rpc_url.clone(),
proxy_string.as_str(),
data_dir,
seed.derive_extended_private_key(env_config.bitcoin_network)?,
env_config,
Expand Down
1 change: 1 addition & 0 deletions swap/src/bin/swap.rs
Original file line number Diff line number Diff line change
Expand Up @@ -505,6 +505,7 @@ async fn init_bitcoin_wallet(

let wallet = bitcoin::Wallet::new(
electrum_rpc_url.clone(),
"",
data_dir,
xprivkey,
env_config,
Expand Down
22 changes: 14 additions & 8 deletions swap/src/bitcoin/wallet.rs
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ use ::bitcoin::Txid;
use anyhow::{bail, Context, Result};
use bdk::blockchain::{Blockchain, ElectrumBlockchain, GetTx};
use bdk::database::BatchDatabase;
use bdk::electrum_client::{ElectrumApi, GetHistoryRes};
use bdk::electrum_client::{ElectrumApi, GetHistoryRes, Socks5Config};
use bdk::sled::Tree;
use bdk::wallet::export::FullyNodedExport;
use bdk::wallet::AddressIndex;
Expand All @@ -20,6 +20,7 @@ use rust_decimal_macros::dec;
use std::collections::{BTreeMap, HashMap};
use std::convert::TryFrom;
use std::fmt;
use std::ops::Not;
use std::path::Path;
use std::sync::Arc;
use std::time::{Duration, Instant};
Expand Down Expand Up @@ -47,6 +48,7 @@ pub struct Wallet<D = Tree, C = Client> {
impl Wallet {
pub async fn new(
electrum_rpc_url: Url,
electrum_socks5_proxy_string: &str,
data_dir: impl AsRef<Path>,
xprivkey: ExtendedPrivKey,
env_config: env::Config,
Expand All @@ -70,7 +72,7 @@ impl Wallet {
err => err?,
};

let client = Client::new(electrum_rpc_url, env_config.bitcoin_sync_interval())?;
let client = Client::new(electrum_rpc_url, electrum_socks5_proxy_string, env_config.bitcoin_sync_interval())?;

let network = wallet.network();

Expand Down Expand Up @@ -723,19 +725,23 @@ pub struct Client {
}

impl Client {
fn new(electrum_rpc_url: Url, interval: Duration) -> Result<Self> {
let config = bdk::electrum_client::ConfigBuilder::default()
.retry(5)
.build();
let electrum = bdk::electrum_client::Client::from_config(electrum_rpc_url.as_str(), config)
fn new(electrum_rpc_url: Url, electrum_socks5_proxy_string: &str, interval: Duration) -> Result<Self> {
let mut config_builder = bdk::electrum_client::ConfigBuilder::default()
.retry(5);
if electrum_socks5_proxy_string.is_empty().not() {
config_builder = config_builder
.socks5(Option::from(Socks5Config::new(electrum_socks5_proxy_string.to_string()))).unwrap() // use Tor with the Electrum client
}
let config = config_builder.build();
let electrum = bdk::electrum_client::Client::from_config(electrum_rpc_url.as_str(), config.clone())
.context("Failed to initialize Electrum RPC client")?;
// Initially fetch the latest block for storing the height.
// We do not act on this subscription after this call.
let latest_block = electrum
.block_headers_subscribe()
.context("Failed to subscribe to header notifications")?;

let client = bdk::electrum_client::Client::new(electrum_rpc_url.as_str())
let client = bdk::electrum_client::Client::from_config(electrum_rpc_url.as_str(), config.clone())
.context("Failed to initialize Electrum RPC client")?;
let blockchain = ElectrumBlockchain::from(client);
let last_sync = Instant::now()
Expand Down
10 changes: 8 additions & 2 deletions swap/src/network/swarm.rs
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ use libp2p::{identity, Multiaddr, Swarm};
use std::fmt::Debug;

#[allow(clippy::too_many_arguments)]
pub fn asb<LR>(
pub async fn asb<LR>(
seed: &Seed,
min_buy: bitcoin::Amount,
max_buy: bitcoin::Amount,
Expand All @@ -18,10 +18,16 @@ pub fn asb<LR>(
env_config: env::Config,
namespace: XmrBtcNamespace,
rendezvous_addrs: &[Multiaddr],
tor_socks5_port: u16
) -> Result<Swarm<asb::Behaviour<LR>>>
where
LR: LatestRate + Send + 'static + Debug + Clone,
{
let maybe_tor_socks5_port = match tor::Client::new(tor_socks5_port).assert_tor_running().await {
Ok(()) => Some(tor_socks5_port),
Err(_) => None,
};

let identity = seed.derive_libp2p_identity();

let rendezvous_nodes = rendezvous_addrs
Expand All @@ -45,7 +51,7 @@ where
rendezvous_nodes,
);

let transport = asb::transport::new(&identity)?;
let transport = asb::transport::new(&identity, maybe_tor_socks5_port)?;
let peer_id = identity.public().into();

let swarm = SwarmBuilder::new(transport, behaviour, peer_id)
Expand Down