1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
use crate::{
    delay::{OrderedVaultsDelay, RandomDelay, ZeroDelay},
    error::Error,
    faucet, issue,
    metrics::{poll_metrics, publish_tokio_metrics, PerCurrencyMetrics},
    relay::run_relayer,
    service::{wait_or_shutdown, DynBitcoinCoreApi, MonitoringConfig, Service, ShutdownSender, *},
    Event, IssueRequests, CHAIN_HEIGHT_POLLING_INTERVAL,
};
use async_trait::async_trait;
use backoff::Error as BackoffError;
use bitcoin::{Error as BitcoinError, Network, PublicKey};
use clap::Parser;
use futures::{
    channel::{mpsc, mpsc::Sender},
    future::{join, join_all},
    Future, SinkExt, TryFutureExt,
};
use git_version::git_version;
use runtime::{
    cli::{parse_duration_minutes, parse_duration_ms},
    BtcRelayPallet, CollateralBalancesPallet, CurrencyId, Error as RuntimeError, InterBtcParachain, PrettyPrint,
    RegisterVaultEvent, RuntimeCurrencyInfo, StoreMainChainHeaderEvent, TryFromSymbol, UpdateActiveBlockEvent,
    UtilFuncs, VaultCurrencyPair, VaultId, VaultRegistryPallet,
};
use std::{collections::HashMap, pin::Pin, sync::Arc, time::Duration};
use tokio::{sync::RwLock, time::sleep};

pub const VERSION: &str = git_version!(args = ["--tags"]);
pub const AUTHORS: &str = env!("CARGO_PKG_AUTHORS");
pub const NAME: &str = env!("CARGO_PKG_NAME");
pub const ABOUT: &str = env!("CARGO_PKG_DESCRIPTION");

const RESTART_INTERVAL: Duration = Duration::from_secs(10800); // restart every 3 hours

fn parse_collateral_and_amount(
    input: &str,
) -> Result<(String, Option<u128>), Box<dyn std::error::Error + Send + Sync + 'static>> {
    let pos = input
        .find('=')
        .ok_or_else(|| format!("invalid CurrencyId=amount: no `=` found in `{input}`"))?;

    let val = &input[pos + 1..];
    Ok((
        input[..pos].to_string(),
        if val.contains("faucet") {
            None
        } else {
            Some(val.parse()?)
        },
    ))
}

#[derive(Parser, Clone, Debug)]
pub struct VaultServiceConfig {
    /// Automatically register the vault with the given amount of collateral and a newly generated address.
    #[clap(long, value_parser = parse_collateral_and_amount)]
    pub auto_register: Vec<(String, Option<u128>)>,

    /// Pass the faucet URL for auto-registration.
    #[clap(long)]
    pub faucet_url: Option<String>,

    /// Opt out of participation in replace requests.
    #[clap(long)]
    pub no_auto_replace: bool,

    /// Don't try to execute issues.
    #[clap(long)]
    pub no_issue_execution: bool,

    /// Don't run the RPC API.
    #[clap(long)]
    pub no_api: bool,

    /// Attempt to execute best-effort transactions immediately, rather than using a random delay.
    #[clap(long)]
    pub no_random_delay: bool,

    /// Timeout in milliseconds to repeat collateralization checks.
    #[clap(long, value_parser = parse_duration_ms, default_value = "5000")]
    pub collateral_timeout_ms: Duration,

    /// How many bitcoin confirmations to wait for. If not specified, the
    /// parachain settings will be used (recommended).
    #[clap(long)]
    pub btc_confirmations: Option<u32>,

    /// Minimum time to the the redeem/replace execution deadline to make the bitcoin payment.
    #[clap(long, value_parser = parse_duration_minutes, default_value = "120")]
    pub payment_margin_minutes: Duration,

    /// Timeout in milliseconds to poll Bitcoin.
    #[clap(long, value_parser = parse_duration_ms, default_value = "6000")]
    pub bitcoin_poll_interval_ms: Duration,

    /// Starting height to relay block headers, if not defined
    /// use the best height as reported by the relay module.
    #[clap(long)]
    pub bitcoin_relay_start_height: Option<u32>,

    /// Max batch size for combined block header submission.
    #[clap(long, default_value = "16")]
    pub max_batch_size: u32,

    /// Number of confirmations a block needs to have before it is submitted.
    #[clap(long, default_value = "0")]
    pub bitcoin_relay_confirmations: u32,

    /// Don't relay bitcoin block headers.
    #[clap(long)]
    pub no_bitcoin_block_relay: bool,

    /// Deprecated - kept only to not break clients.
    #[clap(long)]
    pub no_auto_refund: bool,

    /// Bump bitcoin tx fees whenever the oracle reports a new,
    /// higher inclusion fee estimate.
    #[clap(long)]
    pub auto_rbf: bool,

    /// Path of a caching database. If you want to create a new database, set
    /// this to an unexisting path, e.g. `${pwd}/myvault.db`. If not set, a
    /// the path is generated from the --keyname argument
    #[clap(long)]
    pub db_path: Option<String>,
}

async fn active_block_listener(
    parachain_rpc: InterBtcParachain,
    issue_tx: Sender<Event>,
    replace_tx: Sender<Event>,
) -> Result<(), Error> {
    let issue_tx = &issue_tx;
    let replace_tx = &replace_tx;
    parachain_rpc
        .on_event::<UpdateActiveBlockEvent, _, _, _>(
            |event| async move {
                let _ = issue_tx.clone().send(Event::ParachainBlock(event.block_number)).await;
                let _ = replace_tx.clone().send(Event::ParachainBlock(event.block_number)).await;
            },
            |err| tracing::error!("Error (UpdateActiveBlockEvent): {}", err.to_human()),
        )
        .await?;
    Ok(())
}

async fn relay_block_listener(
    parachain_rpc: InterBtcParachain,
    issue_tx: Sender<Event>,
    replace_tx: Sender<Event>,
) -> Result<(), Error> {
    let issue_tx = &issue_tx;
    let replace_tx = &replace_tx;
    parachain_rpc
        .on_event::<StoreMainChainHeaderEvent, _, _, _>(
            |event| async move {
                let _ = issue_tx.clone().send(Event::BitcoinBlock(event.block_height)).await;
                let _ = replace_tx.clone().send(Event::BitcoinBlock(event.block_height)).await;
            },
            |err| tracing::error!("Error (StoreMainChainHeaderEvent): {}", err.to_human()),
        )
        .await?;
    Ok(())
}

#[derive(Clone)]
pub struct VaultData {
    pub vault_id: VaultId,
    pub btc_rpc: DynBitcoinCoreApi,
    pub metrics: PerCurrencyMetrics,
}

#[derive(Clone)]
pub struct DatabaseConfig {
    path: String,
}

impl DatabaseConfig {
    fn prefixed_key(vault_id: &VaultId, key: &str) -> Result<String, Error> {
        Ok(format!(
            "{}-{}-{}-{}",
            vault_id.account_id.pretty_print(), /* technically not needed since each client should have their own
                                                 * db, but doesn't hurt to be safe */
            vault_id
                .currencies
                .collateral
                .symbol()
                .map_err(|_| BitcoinError::FailedToConstructWalletName)?,
            vault_id
                .currencies
                .wrapped
                .symbol()
                .map_err(|_| BitcoinError::FailedToConstructWalletName)?,
            key
        ))
    }

    pub fn put<V: serde::Serialize>(&self, vault_id: &VaultId, key: &str, value: &V) -> Result<(), Error> {
        let db = rocksdb::DB::open_default(self.path.clone())?;
        let key = Self::prefixed_key(vault_id, key)?;
        db.put(key, serde_json::to_vec(value)?)?;
        Ok(())
    }

    pub fn get<T: serde::de::DeserializeOwned>(&self, vault_id: &VaultId, key: &str) -> Result<Option<T>, Error> {
        let db = rocksdb::DB::open_default(self.path.clone())?;
        let key = Self::prefixed_key(vault_id, key)?;

        let value = match db.get(key)? {
            None => return Ok(None),
            Some(x) => {
                let value = String::from_utf8(x)?;
                serde_json::from_str(&value)?
            }
        };
        Ok(value)
    }
}

#[derive(Clone)]
pub struct VaultIdManager {
    vault_data: Arc<RwLock<HashMap<VaultId, VaultData>>>,
    btc_parachain: InterBtcParachain,
    btc_rpc_master_wallet: DynBitcoinCoreApi,
    // TODO: refactor this
    #[allow(clippy::type_complexity)]
    constructor: Arc<Box<dyn Fn(VaultId) -> Result<DynBitcoinCoreApi, BitcoinError> + Send + Sync>>,
    db: DatabaseConfig,
}

impl VaultIdManager {
    pub fn new(
        btc_parachain: InterBtcParachain,
        btc_rpc_master_wallet: DynBitcoinCoreApi,
        constructor: impl Fn(VaultId) -> Result<DynBitcoinCoreApi, BitcoinError> + Send + Sync + 'static,
        db_path: String,
    ) -> Self {
        Self {
            vault_data: Arc::new(RwLock::new(HashMap::new())),
            constructor: Arc::new(Box::new(constructor)),
            btc_rpc_master_wallet,
            btc_parachain,
            db: DatabaseConfig { path: db_path },
        }
    }

    // used for testing only
    pub fn from_map(
        btc_parachain: InterBtcParachain,
        btc_rpc_master_wallet: DynBitcoinCoreApi,
        map: HashMap<VaultId, DynBitcoinCoreApi>,
        db_path: &str,
    ) -> Self {
        let vault_data = map
            .into_iter()
            .map(|(key, value)| {
                (
                    key.clone(),
                    VaultData {
                        vault_id: key,
                        btc_rpc: value,
                        metrics: PerCurrencyMetrics::dummy(),
                    },
                )
            })
            .collect();
        Self {
            vault_data: Arc::new(RwLock::new(vault_data)),
            constructor: Arc::new(Box::new(|_| unimplemented!())),
            btc_rpc_master_wallet,
            btc_parachain,
            db: DatabaseConfig {
                path: db_path.to_string(),
            },
        }
    }

    async fn add_vault_id(&self, vault_id: VaultId) -> Result<(), Error> {
        let btc_rpc = (*self.constructor)(vault_id.clone())?;

        // load wallet. Exit on failure, since without wallet we can't do a lot
        btc_rpc
            .create_or_load_wallet()
            .await
            .map_err(Error::WalletInitializationFailure)?;

        tracing::info!("Adding derivation key...");
        let derivation_key = self
            .btc_parachain
            .get_public_key()
            .await?
            .ok_or(BitcoinError::MissingPublicKey)?;

        // migration to the new shared public key setup: copy the public key from the
        // currency-specific wallet to the master wallet. This can be removed once all
        // vaults have migrated
        let public_key = PublicKey::from_slice(&derivation_key.0).map_err(BitcoinError::KeyError)?;
        if let Ok(private_key) = btc_rpc.dump_derivation_key(&public_key) {
            self.btc_rpc_master_wallet.import_derivation_key(&private_key)?;
        }

        // Copy the derivation key from the master wallet to use currency-specific wallet
        match self.btc_rpc_master_wallet.dump_derivation_key(&public_key) {
            Ok(private_key) => {
                btc_rpc.import_derivation_key(&private_key)?;
            }
            Err(err) => {
                tracing::error!("Could not find the derivation key in the bitcoin wallet");
                return Err(err.into());
            }
        }

        tracing::info!("Adding keys from past issues...");

        issue::add_keys_from_past_issue_request(&btc_rpc, &self.btc_parachain, &vault_id, &self.db).await?;

        tracing::info!("Initializing metrics...");
        let metrics = PerCurrencyMetrics::new(&vault_id);
        let data = VaultData {
            vault_id: vault_id.clone(),
            btc_rpc: btc_rpc.clone(),
            metrics: metrics.clone(),
        };
        PerCurrencyMetrics::initialize_values(self.btc_parachain.clone(), &data).await;

        self.vault_data.write().await.insert(vault_id, data.clone());

        Ok(())
    }

    pub async fn fetch_vault_ids(&self) -> Result<(), Error> {
        for vault_id in self
            .btc_parachain
            .get_vaults_by_account_id(self.btc_parachain.get_account_id())
            .await?
        {
            match is_vault_registered(&self.btc_parachain, &vault_id).await {
                Err(Error::RuntimeError(RuntimeError::VaultLiquidated)) => {
                    tracing::error!(
                        "[{}] Vault is liquidated -- not going to process events for this vault.",
                        vault_id.pretty_print()
                    );
                }
                Ok(_) => {
                    self.add_vault_id(vault_id.clone()).await?;
                }
                Err(x) => {
                    return Err(x);
                }
            }
        }
        Ok(())
    }

    pub async fn listen_for_vault_id_registrations(self) -> Result<(), Error> {
        Ok(self
            .btc_parachain
            .on_event::<RegisterVaultEvent, _, _, _>(
                |event| async {
                    let vault_id = event.vault_id;
                    if self.btc_parachain.is_this_vault(&vault_id) {
                        tracing::info!("New vault registered: {}", vault_id.pretty_print());
                        let _ = self.add_vault_id(vault_id).await;
                    }
                },
                |err| tracing::error!("Error (RegisterVaultEvent): {}", err.to_human()),
            )
            .await?)
    }

    pub async fn get_bitcoin_rpc(&self, vault_id: &VaultId) -> Option<DynBitcoinCoreApi> {
        self.vault_data.read().await.get(vault_id).map(|x| x.btc_rpc.clone())
    }

    pub async fn get_vault(&self, vault_id: &VaultId) -> Option<VaultData> {
        self.vault_data.read().await.get(vault_id).cloned()
    }

    pub async fn get_entries(&self) -> Vec<VaultData> {
        self.vault_data
            .read()
            .await
            .iter()
            .map(|(_, value)| value.clone())
            .collect()
    }

    pub async fn get_vault_ids(&self) -> Vec<VaultId> {
        self.vault_data
            .read()
            .await
            .iter()
            .map(|(vault_id, _)| vault_id.clone())
            .collect()
    }

    pub async fn get_vault_btc_rpcs(&self) -> Vec<(VaultId, DynBitcoinCoreApi)> {
        self.vault_data
            .read()
            .await
            .iter()
            .map(|(vault_id, data)| (vault_id.clone(), data.btc_rpc.clone()))
            .collect()
    }
}

pub struct VaultService {
    btc_parachain: InterBtcParachain,
    btc_rpc_master_wallet: DynBitcoinCoreApi,
    config: VaultServiceConfig,
    monitoring_config: MonitoringConfig,
    shutdown: ShutdownSender,
    vault_id_manager: VaultIdManager,
}

#[async_trait]
impl Service<VaultServiceConfig> for VaultService {
    const NAME: &'static str = NAME;
    const VERSION: &'static str = VERSION;

    fn new_service(
        btc_parachain: InterBtcParachain,
        btc_rpc_master_wallet: DynBitcoinCoreApi,
        config: VaultServiceConfig,
        monitoring_config: MonitoringConfig,
        shutdown: ShutdownSender,
        constructor: Box<dyn Fn(VaultId) -> Result<DynBitcoinCoreApi, BitcoinError> + Send + Sync>,
        db_path: String,
    ) -> Self {
        VaultService::new(
            btc_parachain,
            btc_rpc_master_wallet,
            config,
            monitoring_config,
            shutdown,
            constructor,
            db_path,
        )
    }

    async fn start(&self) -> Result<(), BackoffError<Error>> {
        self.run_service().await
    }
}

async fn run_and_monitor_tasks(shutdown_tx: ShutdownSender, items: Vec<(&str, ServiceTask)>) -> Result<(), Error> {
    let (metrics_iterators, tasks): (HashMap<String, _>, Vec<_>) = items
        .into_iter()
        .filter_map(|(name, task)| {
            let monitor = tokio_metrics::TaskMonitor::new();
            let metrics_iterator = monitor.intervals();
            let task = match task {
                ServiceTask::Optional(true, t) | ServiceTask::Essential(t) => {
                    Some(wait_or_shutdown(shutdown_tx.clone(), t))
                }
                _ => None,
            }?;
            let task = monitor.instrument(task);
            let task = tokio::spawn(task);
            Some(((name.to_string(), metrics_iterator), task))
        })
        .unzip();

    let tokio_metrics = tokio::spawn(wait_or_shutdown(
        shutdown_tx.clone(),
        publish_tokio_metrics(metrics_iterators),
    ));

    match join(tokio_metrics, join_all(tasks)).await {
        (Ok(Err(err)), _) => Err(err),
        (_, results) => results
            .into_iter()
            .find(|res| matches!(res, Ok(Err(_))))
            .and_then(|res| res.ok())
            .unwrap_or(Ok(())),
    }
}

type Task = Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'static>>;

enum ServiceTask {
    Optional(bool, Task),
    Essential(Task),
}

fn maybe_run<F, E>(should_run: bool, task: F) -> ServiceTask
where
    F: Future<Output = Result<(), E>> + Send + 'static,
    E: Into<Error>,
{
    ServiceTask::Optional(should_run, Box::pin(task.map_err(|x| x.into())))
}

fn run<F, E>(task: F) -> ServiceTask
where
    F: Future<Output = Result<(), E>> + Send + 'static,
    E: Into<Error>,
{
    ServiceTask::Essential(Box::pin(task.map_err(|x| x.into())))
}

impl VaultService {
    fn new(
        btc_parachain: InterBtcParachain,
        btc_rpc_master_wallet: DynBitcoinCoreApi,
        config: VaultServiceConfig,
        monitoring_config: MonitoringConfig,
        shutdown: ShutdownSender,
        constructor: impl Fn(VaultId) -> Result<DynBitcoinCoreApi, BitcoinError> + Send + Sync + 'static,
        db_path: String,
    ) -> Self {
        Self {
            btc_parachain: btc_parachain.clone(),
            btc_rpc_master_wallet: btc_rpc_master_wallet.clone(),
            config,
            monitoring_config,
            shutdown,
            vault_id_manager: VaultIdManager::new(btc_parachain, btc_rpc_master_wallet, constructor, db_path),
        }
    }

    fn get_vault_id(&self, collateral_currency: CurrencyId) -> VaultId {
        let account_id = self.btc_parachain.get_account_id();
        let wrapped_currency = self.btc_parachain.wrapped_currency_id;

        VaultId {
            account_id: account_id.clone(),
            currencies: VaultCurrencyPair {
                collateral: collateral_currency,
                wrapped: wrapped_currency,
            },
        }
    }

    async fn validate_bitcoin_network(&self) -> Result<(), Error> {
        let bitcoin_network = match self.btc_rpc_master_wallet.network() {
            Network::Bitcoin => "mainnet",
            Network::Testnet => "testnet",
            Network::Regtest => "regtest",
            Network::Signet => "signet",
            _ => {
                // enum marked as non-exhaustive
                return Err(
                    runtime::Error::BitcoinNetworkMismatch("".to_string(), "UnknownNetwork".to_string()).into(),
                );
            }
        };
        let system_properties = self.btc_parachain.get_rpc_properties().await.unwrap_or_default();

        if let Some(parachain_bitcoin_network) = system_properties.get("bitcoinNetwork") {
            let parachain_bitcoin_network_string = parachain_bitcoin_network.as_str().unwrap_or_default().to_string();
            // `parachain_bitcoin_network` can be `bitcoin-mainnet`, `bitcoin-testnet`, or `bitcoin-regtest`
            // source: https://github.com/interlay/interbtc/blob/a71b970616b0a4a59cd2e709a606a9a78fce80ff/primitives/src/lib.rs#L23
            // `bitcoin_network` can be `mainnet`, `testnet`, regtest.
            // source: https://developer.bitcoin.org/reference/rpc/getblockchaininfo.html
            if !parachain_bitcoin_network_string.contains(bitcoin_network) {
                return Err(runtime::Error::BitcoinNetworkMismatch(
                    parachain_bitcoin_network_string,
                    bitcoin_network.to_string(),
                )
                .into());
            }
        }

        Ok(())
    }

    async fn run_service(&self) -> Result<(), BackoffError<Error>> {
        self.validate_bitcoin_network()
            .await
            .map_err(|err| BackoffError::Permanent(err))?;
        let account_id = self.btc_parachain.get_account_id().clone();

        let parsed_auto_register = self
            .config
            .auto_register
            .clone()
            .into_iter()
            .map(|(symbol, amount)| Ok((CurrencyId::try_from_symbol(symbol)?, amount)))
            .into_iter()
            .collect::<Result<Vec<_>, Error>>()?;

        // exit if auto-register uses faucet and faucet url not set
        if parsed_auto_register.iter().any(|(_, o)| o.is_none()) && self.config.faucet_url.is_none() {
            // TODO: validate before bitcoin / parachain connections
            return Err(BackoffError::Permanent(Error::FaucetUrlNotSet));
        }

        let num_confirmations = match self.config.btc_confirmations {
            Some(x) => x,
            None => self
                .btc_parachain
                .get_bitcoin_confirmations()
                .await
                .map_err(|err| Error::RuntimeError(err))?,
        };
        tracing::info!("Using {} bitcoin confirmations", num_confirmations);

        // Subscribe to an event (any event will do) so that a period of inactivity
        // does not close the jsonrpsee connection
        tracing::info!("Subscribing to error events...");
        let err_provider = self.btc_parachain.clone();
        // NOTE: this will block if subsequent errors do not trigger shutdown
        let err_listener = wait_or_shutdown(self.shutdown.clone(), async move {
            err_provider
                .on_event_error(|e| tracing::debug!("Received error event: {}", e.to_human()))
                .await?;
            Ok::<_, Error>(())
        });
        tokio::task::spawn(err_listener);

        self.maybe_register_public_key().await?;
        match join_all(
            parsed_auto_register
                .iter()
                .map(|(currency_id, amount)| self.maybe_register_vault(currency_id, amount)),
        )
        .await
        .into_iter()
        .collect::<Result<(), Error>>()
        {
            Err(Error::RuntimeError(err)) if err.is_threshold_not_set() => Err(BackoffError::Permanent(err.into())),
            Err(err) => Err(err.into()),
            Ok(_) => Ok(()),
        }?;

        // purposefully _after_ maybe_register_vault and _before_ other calls
        self.vault_id_manager.fetch_vault_ids().await?;

        let startup_height = self.await_parachain_block().await?;

        let open_request_executor = execute_open_requests(
            self.shutdown.clone(),
            self.btc_parachain.clone(),
            self.vault_id_manager.clone(),
            self.btc_rpc_master_wallet.clone(),
            num_confirmations,
            self.config.payment_margin_minutes,
            self.config.auto_rbf,
        );

        let shutdown_clone = self.shutdown.clone();
        spawn_cancelable(self.shutdown.subscribe(), async move {
            tracing::info!("Checking for open requests...");
            match open_request_executor.await {
                Ok(_) => tracing::info!("Done processing open requests"),
                Err(e) => {
                    tracing::error!("Failed to process open requests: {}", e);
                    if let Err(err) = shutdown_clone.send(()) {
                        tracing::error!("Failed to send shutdown signal: {}", err);
                    }
                }
            }
        });

        // get the relay chain tip but don't error because the relay may not be initialized
        let initial_btc_height = self.btc_parachain.get_best_block_height().await.unwrap_or_default();

        // issue handling
        let issue_set = Arc::new(IssueRequests::new());
        let oldest_issue_btc_height =
            issue::initialize_issue_set(&self.btc_rpc_master_wallet, &self.btc_parachain, &issue_set).await?;

        let random_delay: Arc<Box<dyn RandomDelay + Send + Sync>> = if self.config.no_random_delay {
            Arc::new(Box::new(ZeroDelay))
        } else {
            Arc::new(Box::new(
                OrderedVaultsDelay::new(self.btc_parachain.clone())
                    .await
                    .map_err(|err| Error::RuntimeError(err))?,
            ))
        };

        let (issue_event_tx, issue_event_rx) = mpsc::channel::<Event>(32);
        let (replace_event_tx, replace_event_rx) = mpsc::channel::<Event>(16);

        let listen_for_registered_assets =
            |rpc: InterBtcParachain| async move { rpc.listen_for_registered_assets().await };

        let listen_for_lending_markets = |rpc: InterBtcParachain| async move { rpc.listen_for_lending_markets().await };

        let listen_for_fee_rate_estimate_changes =
            |rpc: InterBtcParachain| async move { rpc.listen_for_fee_rate_changes().await };

        tracing::info!("Starting all services...");
        let tasks = vec![
            (
                "Registered Asset Listener",
                run(listen_for_registered_assets(self.btc_parachain.clone())),
            ),
            (
                "Lending Market Listener",
                run(listen_for_lending_markets(self.btc_parachain.clone())),
            ),
            (
                "Fee Estimate Listener",
                run(listen_for_fee_rate_estimate_changes(self.btc_parachain.clone())),
            ),
            (
                "Issue Request Listener",
                run(listen_for_issue_requests(
                    self.vault_id_manager.clone(),
                    self.btc_parachain.clone(),
                    issue_event_tx.clone(),
                    issue_set.clone(),
                )),
            ),
            (
                "Issue Execute Listener",
                run(listen_for_issue_executes(
                    self.btc_parachain.clone(),
                    issue_event_tx.clone(),
                    issue_set.clone(),
                )),
            ),
            (
                "Issue Cancel Listener",
                run(listen_for_issue_cancels(self.btc_parachain.clone(), issue_set.clone())),
            ),
            (
                "Issue Cancel Scheduler",
                run(CancellationScheduler::new(
                    self.btc_parachain.clone(),
                    startup_height,
                    initial_btc_height,
                    account_id.clone(),
                )
                .handle_cancellation::<IssueCanceller>(issue_event_rx)),
            ),
            (
                "Request Replace Listener",
                run(listen_for_replace_requests(
                    self.btc_parachain.clone(),
                    self.vault_id_manager.clone(),
                    replace_event_tx.clone(),
                    !self.config.no_auto_replace,
                )),
            ),
            (
                "Accept Replace Listener",
                run(listen_for_accept_replace(
                    self.shutdown.clone(),
                    self.btc_parachain.clone(),
                    self.vault_id_manager.clone(),
                    num_confirmations,
                    self.config.payment_margin_minutes,
                    self.config.auto_rbf,
                )),
            ),
            (
                "Execute Replace Listener",
                run(listen_for_execute_replace(
                    self.btc_parachain.clone(),
                    replace_event_tx.clone(),
                )),
            ),
            (
                "Replace Cancellation Scheduler",
                run(CancellationScheduler::new(
                    self.btc_parachain.clone(),
                    startup_height,
                    initial_btc_height,
                    account_id.clone(),
                )
                .handle_cancellation::<ReplaceCanceller>(replace_event_rx)),
            ),
            (
                "Parachain Block Listener",
                run(active_block_listener(
                    self.btc_parachain.clone(),
                    issue_event_tx.clone(),
                    replace_event_tx.clone(),
                )),
            ),
            (
                "Bitcoin Block Listener",
                run(relay_block_listener(
                    self.btc_parachain.clone(),
                    issue_event_tx.clone(),
                    replace_event_tx.clone(),
                )),
            ),
            (
                "Redeem Request Listener",
                run(listen_for_redeem_requests(
                    self.shutdown.clone(),
                    self.btc_parachain.clone(),
                    self.vault_id_manager.clone(),
                    num_confirmations,
                    self.config.payment_margin_minutes,
                    self.config.auto_rbf,
                )),
            ),
            (
                "VaultId Registration Listener",
                run(self.vault_id_manager.clone().listen_for_vault_id_registrations()),
            ),
            (
                "Bitcoin Relay",
                maybe_run(
                    !self.config.no_bitcoin_block_relay,
                    run_relayer(Runner::new(
                        self.btc_rpc_master_wallet.clone(),
                        self.btc_parachain.clone(),
                        Config {
                            start_height: self.config.bitcoin_relay_start_height,
                            max_batch_size: self.config.max_batch_size,
                            interval: Some(self.config.bitcoin_poll_interval_ms),
                            btc_confirmations: self.config.bitcoin_relay_confirmations,
                        },
                        random_delay.clone(),
                    )),
                ),
            ),
            (
                "Issue Executor",
                maybe_run(
                    !self.config.no_issue_execution && self.btc_rpc_master_wallet.is_full_node(),
                    issue::process_issue_requests(
                        self.btc_rpc_master_wallet.clone(),
                        self.btc_parachain.clone(),
                        issue_set.clone(),
                        oldest_issue_btc_height,
                        num_confirmations,
                        random_delay,
                    ),
                ),
            ),
            (
                "Bridge Metrics Listener",
                maybe_run(
                    !self.monitoring_config.no_prometheus,
                    monitor_bridge_metrics(self.btc_parachain.clone(), self.vault_id_manager.clone()),
                ),
            ),
            (
                "Bridge Metrics Poller",
                maybe_run(
                    !self.monitoring_config.no_prometheus,
                    poll_metrics(self.btc_parachain.clone(), self.vault_id_manager.clone()),
                ),
            ),
            (
                "Restart Timer",
                run(async move {
                    tokio::time::sleep(RESTART_INTERVAL).await;
                    tracing::info!("Initiating periodic restart...");
                    Err(Error::ClientShutdown)
                }),
            ),
        ];

        run_and_monitor_tasks(self.shutdown.clone(), tasks).await?;
        Ok(())
    }

    async fn maybe_register_public_key(&self) -> Result<(), Error> {
        if let Some(faucet_url) = &self.config.faucet_url {
            // fund the native token first to pay for tx fees
            crate::faucet::fund_account(faucet_url, &self.get_vault_id(self.btc_parachain.native_currency_id)).await?;
        }

        if self.btc_parachain.get_public_key().await?.is_none() {
            tracing::info!("Registering bitcoin public key to the parachain...");
            let public_key = self.btc_rpc_master_wallet.get_new_public_key().await?;
            self.btc_parachain
                .register_public_key(public_key.inner.serialize().into())
                .await?;
        }

        Ok(())
    }

    async fn maybe_register_vault(
        &self,
        collateral_currency: &CurrencyId,
        maybe_collateral_amount: &Option<u128>,
    ) -> Result<(), Error> {
        let vault_id = self.get_vault_id(*collateral_currency);

        match is_vault_registered(&self.btc_parachain, &vault_id).await {
            Err(Error::RuntimeError(RuntimeError::VaultLiquidated)) | Ok(true) => {
                tracing::info!(
                    "[{}] Not registering vault -- already registered",
                    vault_id.pretty_print()
                );
            }
            Ok(false) => {
                tracing::info!("[{}] Not registered", vault_id.pretty_print());
                if let Some(collateral) = maybe_collateral_amount {
                    tracing::info!("[{}] Automatically registering...", vault_id.pretty_print());
                    let free_balance = self
                        .btc_parachain
                        .get_free_balance(vault_id.collateral_currency())
                        .await?;
                    self.btc_parachain
                        .register_vault(
                            &vault_id,
                            if collateral.gt(&free_balance) {
                                tracing::warn!(
                                    "Cannot register with {}, using the available free balance: {}",
                                    collateral,
                                    free_balance
                                );
                                free_balance
                            } else {
                                *collateral
                            },
                        )
                        .await?;
                } else if let Some(faucet_url) = &self.config.faucet_url {
                    tracing::info!("[{}] Automatically registering...", vault_id.pretty_print());
                    faucet::fund_and_register(&self.btc_parachain, faucet_url, &vault_id).await?;
                }
            }
            Err(x) => return Err(x),
        }

        Ok(())
    }

    async fn await_parachain_block(&self) -> Result<u32, Error> {
        // wait for a new block to arrive, to prevent processing an event that potentially
        // has been processed already prior to restarting
        tracing::info!("Waiting for new block...");
        let startup_height = self.btc_parachain.get_current_chain_height().await?;
        while startup_height == self.btc_parachain.get_current_chain_height().await? {
            sleep(CHAIN_HEIGHT_POLLING_INTERVAL).await;
        }
        tracing::info!("Got new block...");
        Ok(startup_height)
    }
}

pub(crate) async fn is_vault_registered(parachain_rpc: &InterBtcParachain, vault_id: &VaultId) -> Result<bool, Error> {
    match parachain_rpc.get_vault(vault_id).await {
        Ok(_) => Ok(true),
        Err(RuntimeError::VaultNotFound) => Ok(false),
        Err(err) => Err(err.into()),
    }
}