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
// Copyright 2022 Webb Technologies Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
#![warn(missing_docs)]
//! # Relayer Configuration Module 🕸️
//!
//! A module for configuring the relayer.
//!
//! ## Overview
//!
//! The relayer configuration module is responsible for configuring the relayer.
//! Possible configuration include:
//! * `port`: The port the relayer will listen on. Defaults to 9955
//! * `evm`: EVM based networks and the configuration. See [config/config-6sided-eth-bridge](./config/config-6sided-eth-bridge)
//! for an example.
//! * `substrate`: Substrate based networks and the configuration. See [config/local-substrate](./config/local-substrate) for an example.
//! * `cosmwasm`: Cosmos-SDK based networks and the configuration.
//!
//! Checkout [config](./config) for useful default configurations for many networks.
//! These config files can be changed to your preferences.
use std::path::Path;
use std::{collections::HashMap, path::PathBuf};
use ethereum_types::{Address, U256};
use serde::{Deserialize, Serialize};
use webb::substrate::subxt::sp_core::sr25519::Public;
use crate::types::{
mnemonic::Mnemonic, private_key::PrivateKey, rpc_url::RpcUrl, suri::Suri,
};
/// The default port the relayer will listen on. Defaults to 9955.
const fn default_port() -> u16 {
9955
}
/// Leaves watcher is set to `true` by default.
const fn enable_leaves_watcher_default() -> bool {
true
}
/// Data query access is set to `true` by default.
const fn enable_data_query_default() -> bool {
true
}
/// The maximum events per step is set to `100` by default.
const fn max_blocks_per_step_default() -> u64 {
100
}
/// The print progress interval is set to `7_000` by default.
const fn print_progress_interval_default() -> u64 {
7_000
}
/// WebbRelayerConfig is the configuration for the webb relayer.
#[derive(Debug, Clone, Deserialize, Serialize, Default)]
#[serde(rename_all = "kebab-case")]
pub struct WebbRelayerConfig {
/// WebSocket Server Port number
///
/// default to 9955
#[serde(default = "default_port", skip_serializing)]
pub port: u16,
/// EVM based networks and the configuration.
///
/// a map between chain name and its configuration.
#[serde(default)]
pub evm: HashMap<String, EvmChainConfig>,
/// Substrate based networks and the configuration.
///
/// a map between chain name and its configuration.
#[serde(default)]
pub substrate: HashMap<String, SubstrateConfig>,
/// Cosmwasm based networks and the configuration.
///
/// a map between chain name and its configuration.
#[serde(default)]
pub cosmwasm: HashMap<String, CosmwasmConfig>,
/// For Experimental Options
#[serde(default)]
pub experimental: ExperimentalConfig,
/// Configuration for running relayer
///
/// by deafult all features are enabled
/// Features:
/// 1. Data quering for leafs
/// 2. Governance relaying
/// 3. Private transaction relaying
#[serde(default)]
pub features: FeaturesConfig,
}
/// EvmChainConfig is the configuration for the EVM based networks.
#[derive(Debug, Clone, Deserialize, Serialize)]
#[serde(rename_all = "kebab-case")]
pub struct EvmChainConfig {
/// String that groups configuration for this chain on a human-readable name.
pub name: String,
/// Boolean indicating EVM based networks are enabled or not.
#[serde(default)]
pub enabled: bool,
/// Http(s) Endpoint for quick Req/Res
#[serde(skip_serializing)]
pub http_endpoint: RpcUrl,
/// Websocket Endpoint for long living connections
#[serde(skip_serializing)]
pub ws_endpoint: RpcUrl,
/// Block Explorer for this chain.
///
/// Optional, and only used for printing a clickable links
/// for transactions and contracts.
#[serde(skip_serializing)]
pub explorer: Option<url::Url>,
/// chain specific id (output of chainId opcode on EVM networks)
#[serde(rename(serialize = "chainId"))]
pub chain_id: u32,
/// The Private Key of this account on this network
/// the format is more dynamic here:
/// 1. if it starts with '0x' then this would be raw (64 bytes) hex encoded
/// private key.
/// Example: 0x8917174396171783496173419137618235192359106130478137647163400318
///
/// 2. if it starts with '$' then it would be considered as an Enviroment variable
/// of a hex-encoded private key.
/// Example: $HARMONY_PRIVATE_KEY
///
/// 3. if it starts with '> ' then it would be considered as a command that
/// the relayer would execute and the output of this command would be the
/// hex encoded private key.
/// Example: > pass harmony-privatekey
///
/// 4. if it doesn't contains special characters and has 12 or 24 words in it
/// then we should process it as a mnemonic string: 'word two three four ...'
#[serde(skip_serializing)]
pub private_key: Option<PrivateKey>,
/// Optionally, a user can specify an account to receive rewards for relaying
pub beneficiary: Option<Address>,
/// Supported contracts over this chain.
#[serde(default)]
pub contracts: Vec<Contract>,
/// TxQueue configuration
#[serde(skip_serializing, default)]
pub tx_queue: TxQueueConfig,
}
/// SubstrateConfig is the configuration for the Substrate based networks.
#[derive(Debug, Clone, Deserialize, Serialize)]
#[serde(rename_all = "kebab-case")]
pub struct SubstrateConfig {
/// String that groups configuration for this chain on a human-readable name.
pub name: String,
/// Boolean indicating Substrate networks are enabled or not.
#[serde(default)]
pub enabled: bool,
/// Http(s) Endpoint for quick Req/Res
#[serde(skip_serializing)]
pub http_endpoint: RpcUrl,
/// Websocket Endpoint for long living connections
#[serde(skip_serializing)]
pub ws_endpoint: RpcUrl,
/// Block Explorer for this Substrate node.
///
/// Optional, and only used for printing a clickable links
/// for transactions and contracts.
#[serde(skip_serializing)]
pub explorer: Option<url::Url>,
/// chain specific id (output of ChainIdentifier constant on LinkableTree Pallet)
#[serde(rename(serialize = "chainId"))]
pub chain_id: u32,
/// Interprets the string in order to generate a key Pair. in the
/// case that the pair can be expressed as a direct derivation from a seed (some cases, such as Sr25519 derivations
/// with path components, cannot).
///
/// This takes a helper function to do the key generation from a phrase, password and
/// junction iterator.
///
/// - If `s` begins with a `$` character it is interpreted as an environment variable.
/// - If `s` is a possibly `0x` prefixed 64-digit hex string, then it will be interpreted
/// directly as a `MiniSecretKey` (aka "seed" in `subkey`).
/// - If `s` is a valid BIP-39 key phrase of 12, 15, 18, 21 or 24 words, then the key will
/// be derived from it. In this case:
/// - the phrase may be followed by one or more items delimited by `/` characters.
/// - the path may be followed by `///`, in which case everything after the `///` is treated
/// as a password.
/// - If `s` begins with a `/` character it is prefixed with the Substrate public `DEV_PHRASE` and
/// interpreted as above.
///
/// In this case they are interpreted as HDKD junctions; purely numeric items are interpreted as
/// integers, non-numeric items as strings. Junctions prefixed with `/` are interpreted as soft
/// junctions, and with `//` as hard junctions.
///
/// There is no correspondence mapping between SURI strings and the keys they represent.
/// Two different non-identical strings can actually lead to the same secret being derived.
/// Notably, integer junction indices may be legally prefixed with arbitrary number of zeros.
/// Similarly an empty password (ending the SURI with `///`) is perfectly valid and will generally
/// be equivalent to no password at all.
///
/// `None` is returned if no matches are found.
#[serde(skip_serializing)]
pub suri: Option<Suri>,
/// Optionally, a user can specify an account to receive rewards for relaying
pub beneficiary: Option<Public>,
/// Which Substrate Runtime to use?
pub runtime: SubstrateRuntime,
/// Supported pallets over this substrate node.
#[serde(default)]
pub pallets: Vec<Pallet>,
/// TxQueue configuration
#[serde(skip_serializing, default)]
pub tx_queue: TxQueueConfig,
}
/// CosmwasmConfig is the configuration for the Cosmwasm based networks.
#[derive(Debug, Clone, Deserialize, Serialize)]
#[serde(rename_all = "kebab-case")]
pub struct CosmwasmConfig {
/// String that groups configuration for this chain on a human-readable name.
pub name: String,
/// Boolean indicating Cosmwasm based networks are enabled or not.
#[serde(default)]
pub enabled: bool,
/// Http(s) Endpoint for quick Req/Res
#[serde(skip_serializing)]
pub http_endpoint: RpcUrl,
/// Websocket Endpoint for long living connections
#[serde(skip_serializing)]
pub ws_endpoint: RpcUrl,
/// Block Explorer for this chain.
///
/// Optional, and only used for printing a clickable links
/// for transactions and contracts.
#[serde(skip_serializing)]
pub explorer: Option<url::Url>,
/// chain specific id (output of chainId opcode on Cosmwasm networks)
#[serde(rename(serialize = "chainId"))]
pub chain_id: u32,
/// The Mnemonic of this account on this network
/// the format is more dynamic here:
/// 1. if it starts with '$' then it would be considered as an Enviroment variable
/// of a hex-encoded private key.
/// Example: $RELAYER_MNEMONIC
///
/// 2. if it starts with '> ' then it would be considered as a command that
/// the relayer would execute and the output of this command would be the
/// hex encoded private key.
/// Example: > pass relayer_mnemonic
///
/// 3. if it doesn't contains special characters and has 12 or 24 words in it
/// then we should process it as a mnemonic string: 'word two three four ...'
#[serde(skip_serializing)]
pub mnemonic: Mnemonic,
/// Optionally, a user can specify an account to receive rewards for relaying
pub beneficiary: Option<Address>,
/// Supported contracts over this chain.
#[serde(default)]
pub contracts: Vec<Contract>,
/// TxQueue configuration
#[serde(skip_serializing, default)]
pub tx_queue: TxQueueConfig,
}
/// ExperimentalConfig is the configuration for the Experimental Options.
#[derive(Debug, Clone, Copy, Deserialize, Serialize, Default)]
#[serde(rename_all = "kebab-case")]
pub struct ExperimentalConfig {
/// Enable the Smart Anchor Updates when it comes to signaling
/// the bridge to create the proposals.
pub smart_anchor_updates: bool,
/// The number of retries to check if an anchor is updated before sending our update
/// or not, before actually sending our update.
pub smart_anchor_updates_retries: u32,
}
/// FeaturesConfig is the configuration for running relayer with option.
#[derive(Debug, Clone, Copy, Deserialize, Serialize)]
#[serde(rename_all = "kebab-case")]
pub struct FeaturesConfig {
/// Enable data quering for leafs
pub data_query: bool,
/// Enable governance relaying
pub governance_relay: bool,
/// Enable private tx relaying
pub private_tx_relay: bool,
}
impl Default for FeaturesConfig {
fn default() -> Self {
Self {
data_query: true,
governance_relay: true,
private_tx_relay: true,
}
}
}
/// TxQueueConfig is the configuration for the TxQueue.
#[derive(Debug, Clone, Deserialize, Serialize)]
#[serde(rename_all = "kebab-case")]
pub struct TxQueueConfig {
/// Maximum number of milliseconds to wait before dequeuing a transaction from
/// the queue.
pub max_sleep_interval: u64,
}
impl Default for TxQueueConfig {
fn default() -> Self {
Self {
max_sleep_interval: 10_000,
}
}
}
/// EventsWatchConfig is the configuration for the events watch.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "kebab-case")]
pub struct EventsWatcherConfig {
/// A flag for enabling API endpoints for querying data from the relayer.
#[serde(default = "enable_data_query_default")]
pub enable_data_query: bool,
#[serde(default = "enable_leaves_watcher_default")]
/// if it is enabled for this chain or not.
pub enabled: bool,
/// Polling interval in milliseconds
#[serde(rename(serialize = "pollingInterval"))]
pub polling_interval: u64,
/// The maximum number of events to fetch in one request.
#[serde(skip_serializing, default = "max_blocks_per_step_default")]
pub max_blocks_per_step: u64,
/// print sync progress frequency in milliseconds
/// if it is zero, means no progress will be printed.
#[serde(skip_serializing, default = "print_progress_interval_default")]
pub print_progress_interval: u64,
}
/// VAnchorWithdrawConfig is the configuration for the VAnchor Withdraw.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "kebab-case")]
pub struct VAnchorWithdrawConfig {
/// The fee percentage that your account will receive when you relay a transaction
/// over this chain.
#[serde(rename(serialize = "withdrawFeePercentage"))]
pub withdraw_fee_percentage: f64,
/// A hex value of the gaslimit when doing a withdraw relay transaction on this chain.
#[serde(rename(serialize = "withdrawGaslimit"))]
pub withdraw_gaslimit: U256,
}
/// LinkedVAnchorConfig is the configuration for the linked Vanchor.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "kebab-case")]
pub struct LinkedVAnchorConfig {
/// The Chain name where this anchor belongs to.
/// and it is case-insensitive.
pub chain: String,
/// The chain ID
pub chain_id: String,
/// The Anchor Contract Address.
pub address: Address,
}
/// SubstrateLinkedVAnchorConfig is the configuration for the linked Vanchor of substrate.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "kebab-case")]
pub struct SubstrateLinkedVAnchorConfig {
/// The Chain Id where this anchor belongs to.
pub chain: u32,
/// The chain ID
pub chain_id: String,
/// Tree Id of the anchor
#[serde(rename(serialize = "tree"))]
pub tree: u32,
}
/// Enumerates the supported contract configurations.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(tag = "contract")]
pub enum Contract {
/// The VAnchor contract configuration.
VAnchor(VAnchorContractConfig),
/// The Signature Bridge contract configuration.
SignatureBridge(SignatureBridgeContractConfig),
}
/// Enumerates the supported pallets configurations.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(tag = "pallet")]
pub enum Pallet {
/// `dkg-metadata` or as named in the runtime as `DKG` pallet.
#[serde(rename = "DKG")]
Dkg(DKGPalletConfig),
/// `dkg-proposals` or as named in the runtime as `DKGProposals` pallet.
DKGProposals(DKGProposalsPalletConfig),
/// `dkg-proposal-handler` or as named in the runtime as `DKGProposalHandler` pallet.
DKGProposalHandler(DKGProposalHandlerPalletConfig),
/// `signature-bridge` or as named in the runtime as `SignatureBridge` pallet.
SignatureBridge(SignatureBridgePalletConfig),
/// `vanchor-bn256` or as named in the runtime as `VAnchorBn256` pallet.
VAnchorBn254(VAnchorBn254PalletConfig),
}
/// Enumerates the supported Substrate runtimes.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub enum SubstrateRuntime {
/// The DKG runtime. (dkg-substrate)
#[serde(rename = "DKG")]
Dkg,
/// The Webb Protocol runtime. (protocol-substrate)
WebbProtocol,
}
/// CommonContractConfig represents the common configuration for contracts.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "kebab-case")]
pub struct CommonContractConfig {
/// The address of this contract on this chain.
pub address: Address,
/// the block number where this contract got deployed at.
#[serde(rename(serialize = "deployedAt"))]
pub deployed_at: u64,
}
/// VAnchorContractConfig represents the configuration for the VAnchor contract.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "kebab-case")]
pub struct VAnchorContractConfig {
/// Common contract configuration.
#[serde(flatten)]
pub common: CommonContractConfig,
/// Controls the events watcher
#[serde(rename(serialize = "eventsWatcher"))]
pub events_watcher: EventsWatcherConfig,
/// Anchor withdraw configuration.
#[serde(rename(serialize = "withdrawConfig"))]
pub withdraw_config: Option<VAnchorWithdrawConfig>,
/// The type of the optional signing backend used for signing proposals. It can be None for pure Tx relayers
#[serde(rename(serialize = "proposalSigningBackend"))]
pub proposal_signing_backend: Option<ProposalSigningBackendConfig>,
/// A List of linked Anchor Contracts (on other chains) to this contract.
#[serde(rename(serialize = "linkedAnchors"), default)]
pub linked_anchors: Option<Vec<LinkedVAnchorConfig>>,
}
/// Signature Bridge contract configuration.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "kebab-case")]
pub struct SignatureBridgeContractConfig {
/// Common contract configuration.
#[serde(flatten)]
pub common: CommonContractConfig,
/// Controls the events watcher
#[serde(rename(serialize = "eventsWatcher"))]
pub events_watcher: EventsWatcherConfig,
}
/// DKGProposalsPalletConfig represents the configuration for the DKGProposals pallet.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "kebab-case")]
pub struct DKGProposalsPalletConfig {
/// Controls the events watcher
#[serde(rename(serialize = "eventsWatcher"))]
pub events_watcher: EventsWatcherConfig,
}
/// DKGPalletConfig represents the configuration for the DKG pallet (dkg-metadata).
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "kebab-case")]
pub struct DKGPalletConfig {
/// Controls the events watcher
#[serde(rename(serialize = "eventsWatcher"))]
pub events_watcher: EventsWatcherConfig,
}
/// DKGProposalHandlerPalletConfig represents the configuration for the DKGProposalHandler pallet.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "kebab-case")]
pub struct DKGProposalHandlerPalletConfig {
/// Controls the events watcher
#[serde(rename(serialize = "eventsWatcher"))]
pub events_watcher: EventsWatcherConfig,
}
/// SignatureBridgePalletConfig represents the configuration for the SignatureBridge pallet.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "kebab-case")]
pub struct SignatureBridgePalletConfig {
/// Controls the events watcher
#[serde(rename(serialize = "eventsWatcher"))]
pub events_watcher: EventsWatcherConfig,
}
/// VAnchorBn254PalletConfig represents the configuration for the VAnchorBn254 pallet.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "kebab-case")]
pub struct VAnchorBn254PalletConfig {
/// Controls the events watcher
#[serde(rename(serialize = "eventsWatcher"))]
pub events_watcher: EventsWatcherConfig,
/// The type of the optional signing backend used for signing proposals. It can be None for pure Tx relayers
#[serde(rename(serialize = "proposalSigningBackend"))]
pub proposal_signing_backend: Option<ProposalSigningBackendConfig>,
/// A List of linked Anchor on this chain.
#[serde(rename(serialize = "linkedAnchors"), default)]
pub linked_anchors: Option<Vec<SubstrateLinkedVAnchorConfig>>,
}
/// Enumerates the supported different signing backends configurations.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(tag = "type")]
pub enum ProposalSigningBackendConfig {
/// Uses an already running and configured DKG Node for signing proposals.
#[serde(rename = "DKGNode")]
DkgNode(DkgNodeProposalSigningBackendConfig),
/// Uses the Private Key of the current Governor to sign proposals.
Mocked(MockedProposalSigningBackendConfig),
}
/// DKGNodeSigningBackendConfig represents the configuration for the DKGNode signing backend.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "kebab-case")]
pub struct DkgNodeProposalSigningBackendConfig {
/// The name of the DKG Node that this contract will use.
///
/// Must be defined in the config.
pub node: String,
}
/// MockedSigningBackendConfig represents the configuration for the Mocked signing backend.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "kebab-case")]
pub struct MockedProposalSigningBackendConfig {
/// The private key of the current Governor.
#[serde(skip_serializing)]
pub private_key: PrivateKey,
}
impl WebbRelayerConfig {
/// Makes sure that the config is valid, by going
/// through the whole config and doing some basic checks.
#[allow(unused)] // TODO(@shekohex): remove this once we convert the relayer into a crate.
pub fn verify(&self) -> crate::Result<()> {
// The first check is to make sure that the private key is there when needed.
// to say more on the above check, we **must** have a private key in the following conditions:
// 1. We are running the relayer as a private transaction relayer.
// 2. we are running the relayer as a governance system.
//
// However, if we are running the relayer as only a data serving relayer, we don't need a private key.
let check_features =
self.features.governance_relay || self.features.private_tx_relay;
let check_evm = check_features
&& self
.evm
.iter()
.filter(|(_k, v)| v.enabled)
.all(|(_k, v)| v.private_key.is_some());
let check_substrate = check_features
&& self
.substrate
.iter()
.filter(|(_k, v)| v.enabled)
.all(|(_k, v)| v.suri.is_some());
(check_evm && check_substrate)
.then_some(())
.ok_or(crate::Error::MissingSecrets)
}
}
/// A helper function that will search for all config files in the given directory and return them as a vec
/// of the paths.
///
/// Supported file extensions are:
/// - `.toml`.
/// - `.json`.
pub fn search_config_files<P: AsRef<Path>>(
base_dir: P,
) -> crate::Result<Vec<PathBuf>> {
// A pattern that covers all toml or json files in the config directory and subdirectories.
let toml_pattern = format!("{}/**/*.toml", base_dir.as_ref().display());
let json_pattern = format!("{}/**/*.json", base_dir.as_ref().display());
tracing::trace!(
"Loading config files from {} and {}",
toml_pattern,
json_pattern
);
let toml_files = glob::glob(&toml_pattern)?;
let json_files = glob::glob(&json_pattern)?;
toml_files
.chain(json_files)
.map(|v| v.map_err(crate::Error::from))
.collect()
}
/// Try to parse the [`WebbRelayerConfig`] from the given config file(s).
pub fn parse_from_files(files: &[PathBuf]) -> crate::Result<WebbRelayerConfig> {
let mut cfg = config::Config::new();
let contracts: HashMap<String, Vec<Contract>> = HashMap::new();
// read through all config files for the first time
// build up a collection of [contracts]
for config_file in files {
tracing::trace!("Loading config file: {}", config_file.display());
// get file extension
let ext = config_file
.extension()
.map(|e| e.to_str().unwrap_or(""))
.unwrap_or("");
let format = match ext {
"toml" => config::FileFormat::Toml,
"json" => config::FileFormat::Json,
_ => {
tracing::warn!("Unknown file extension: {}", ext);
continue;
}
};
let file = config::File::from(config_file.as_path()).format(format);
if let Err(e) = cfg.merge(file) {
tracing::warn!("Error while loading config file: {} skipping!", e);
continue;
}
}
// also merge in the environment (with a prefix of WEBB).
cfg.merge(config::Environment::with_prefix("WEBB").separator("_"))?;
// and finally deserialize the config and post-process it
let config: Result<
WebbRelayerConfig,
serde_path_to_error::Error<config::ConfigError>,
> = serde_path_to_error::deserialize(cfg);
match config {
Ok(mut c) => {
// merge in all of the contracts into the config
for (network_name, network_chain) in c.evm.iter_mut() {
if let Some(stored_contracts) = contracts.get(network_name) {
network_chain.contracts = stored_contracts.clone();
}
}
// merge in all of the contracts into the config
for (network_name, network_chain) in c.cosmwasm.iter_mut() {
if let Some(stored_contracts) = contracts.get(network_name) {
network_chain.contracts = stored_contracts.clone();
}
}
postloading_process(c)
}
Err(e) => {
tracing::error!("{}", e);
Err(e.into())
}
}
}
/// Load the configuration files and
///
/// Returns `Ok(WebbRelayerConfig)` on success, or `Err(anyhow::Error)` on failure.
///
/// # Arguments
///
/// * `path` - The path to the configuration file
///
/// # Example
///
/// ```
/// let path = "/path/to/config.toml";
/// config::load(path);
/// ```
///
/// it is the same as using the [`search_config_files`] and [`parse_from_files`] functions combined.
pub fn load<P: AsRef<Path>>(path: P) -> crate::Result<WebbRelayerConfig> {
parse_from_files(&search_config_files(path)?)
}
/// The postloading_process exists to validate configuration and standardize
/// the format of the configuration
fn postloading_process(
mut config: WebbRelayerConfig,
) -> crate::Result<WebbRelayerConfig> {
tracing::trace!("Checking configration sanity ...");
tracing::trace!(
"postloaded config: {}",
serde_json::to_string_pretty(&config)?
);
// make all chain names lower case
// 1. drain everything, and take enabled chains.
let old_evm = config
.evm
.drain()
.filter(|(_, chain)| chain.enabled)
.collect::<HashMap<_, _>>();
// 2. insert them again, as lowercased.
for (_, v) in old_evm {
config.evm.insert(v.chain_id.to_string(), v);
}
// do the same for substrate
let old_substrate = config
.substrate
.drain()
.filter(|(_, chain)| chain.enabled)
.collect::<HashMap<_, _>>();
for (_, v) in old_substrate {
config.substrate.insert(v.chain_id.to_string(), v);
}
// do the same for cosmwasm
let old_cosmwasm = config
.cosmwasm
.drain()
.filter(|(_, chain)| chain.enabled)
.collect::<HashMap<_, _>>();
for (_, v) in old_cosmwasm {
config.cosmwasm.insert(v.chain_id.to_string(), v);
}
// check that all required chains are already present in the config.
for (chain_id, chain_config) in &config.evm {
let vanchors = chain_config.contracts.iter().filter_map(|c| match c {
Contract::VAnchor(cfg) => Some(cfg),
_ => None,
});
// validation checks for vanchor
for anchor in vanchors {
// validate config for data querying
if config.features.data_query {
// check if events watcher is enabled
if !anchor.events_watcher.enabled {
tracing::warn!(
"!!WARNING!!: In order to enable data querying,
event-watcher should also be enabled for ({})",
anchor.common.address
);
}
// check if data-query is enabled in evenst-watcher config
if !anchor.events_watcher.enable_data_query {
tracing::warn!(
"!!WARNING!!: In order to enable data querying,
enable-data-query in events-watcher config should also be enabled for ({})",
anchor.common.address
);
}
}
// validate config for governance relaying
if config.features.governance_relay {
// check if proposal signing backend is configured
if anchor.proposal_signing_backend.is_none() {
tracing::warn!(
"!!WARNING!!: In order to enable governance relaying,
proposal-signing-backend should be configured for ({})",
anchor.common.address
);
}
// check if event watchers is enabled
if !anchor.events_watcher.enabled {
tracing::warn!(
"!!WARNING!!: In order to enable governance relaying,
event-watcher should also be enabled for ({})",
anchor.common.address
);
}
// check if linked anchor is configured
match &anchor.linked_anchors {
None => {
tracing::warn!(
"!!WARNING!!: In order to enable governance relaying,
linked-anchors should also be configured for ({})",
anchor.common.address
);
}
Some(linked_anchors) => {
if linked_anchors.is_empty() {
tracing::warn!(
"!!WARNING!!: In order to enable governance relaying,
linked-anchors cannot be empty.
Please congigure Linked anchors for ({})",
anchor.common.address
);
} else {
for linked_anchor in linked_anchors {
let chain_defined = config
.evm
.contains_key(&linked_anchor.chain_id);
if !chain_defined {
tracing::warn!("!!WARNING!!: chain {} with id {} is not defined in the config.
which is required by the Anchor Contract ({}) defined on {} chain.
Please, define it manually, to allow the relayer to work properly.",
linked_anchor.chain,
linked_anchor.chain_id,
anchor.common.address,
chain_id
);
}
}
}
}
}
}
// validate config for private transaction relaying
if config.features.private_tx_relay {
// check if withdraw fee is configured
if anchor.withdraw_config.is_none() {
tracing::warn!(
"!!WARNING!!: In order to enable private transaction relaying,
withdraw-config should also be configured for ({})",
anchor.common.address
);
}
}
}
}
Ok(config)
}