Struct vault::VaultServiceConfig

pub struct VaultServiceConfig {

    pub auto_register: Vec<(String, Option<u128>)>,
    pub faucet_url: Option<String>,
    pub no_auto_replace: bool,
    pub no_issue_execution: bool,
    pub no_api: bool,
    pub no_random_delay: bool,
    pub collateral_timeout_ms: Duration,
    pub btc_confirmations: Option<u32>,
    pub payment_margin_minutes: Duration,
    pub bitcoin_poll_interval_ms: Duration,
    pub bitcoin_relay_start_height: Option<u32>,
    pub max_batch_size: u32,
    pub bitcoin_relay_confirmations: u32,
    pub no_bitcoin_block_relay: bool,
    pub no_auto_refund: bool,
    pub auto_rbf: bool,
    pub db_path: Option<String>,
}

Fields

auto_register: Vec<(String, Option<u128>)>

Automatically register the vault with the given amount of collateral and a newly generated address.

faucet_url: Option<String>

Pass the faucet URL for auto-registration.

no_auto_replace: bool

Opt out of participation in replace requests.

no_issue_execution: bool

Don’t try to execute issues.

no_api: bool

Don’t run the RPC API.

no_random_delay: bool

Attempt to execute best-effort transactions immediately, rather than using a random delay.

collateral_timeout_ms: Duration

Timeout in milliseconds to repeat collateralization checks.

btc_confirmations: Option<u32>

How many bitcoin confirmations to wait for. If not specified, the parachain settings will be used (recommended).

payment_margin_minutes: Duration

Minimum time to the the redeem/replace execution deadline to make the bitcoin payment.

bitcoin_poll_interval_ms: Duration

Timeout in milliseconds to poll Bitcoin.

bitcoin_relay_start_height: Option<u32>

Starting height to relay block headers, if not defined use the best height as reported by the relay module.

max_batch_size: u32

Max batch size for combined block header submission.

bitcoin_relay_confirmations: u32

Number of confirmations a block needs to have before it is submitted.

no_bitcoin_block_relay: bool

Don’t relay bitcoin block headers.

no_auto_refund: bool

Deprecated - kept only to not break clients.

auto_rbf: bool

Bump bitcoin tx fees whenever the oracle reports a new, higher inclusion fee estimate.

db_path: Option<String>

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

Trait Implementations

impl Args for VaultServiceConfig

fn group_id() -> Option<Id>

Report the [ArgGroup::id][crate::ArgGroup::id] for this set of arguments

fn augment_args<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate Self.

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to [Command] so it can update self.

impl Clone for VaultServiceConfig

fn clone(&self) -> VaultServiceConfig

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl CommandFactory for VaultServiceConfig

fn command<'b>() -> Command

Build a [Command] that can instantiate Self.

fn command_for_update<'b>() -> Command

Build a [Command] that can update self.

impl Debug for VaultServiceConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl FromArgMatches for VaultServiceConfig

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches ) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Parser for VaultServiceConfig

fn parse() -> Self

Parse from std::env::args_os(), exit on error

fn try_parse() -> Result<Self, Error<RichFormatter>>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Selfwhere I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, exit on error

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error<RichFormatter>>where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I)where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, exit on error

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error<RichFormatter>>where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.

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

fn start<'life0, 'async_trait>( &'life0 self ) -> Pin<Box<dyn Future<Output = Result<(), BackoffError<Error>>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,