Struct BridgeConfig

pub struct BridgeConfig {

    pub protocol_paramset: &'static ProtocolParamset,
    pub host: String,
    pub port: u16,
    pub secret_key: SecretKey,
    pub operator_withdrawal_fee_sats: Option<Amount>,
    pub bitcoin_rpc_url: String,
    pub bitcoin_rpc_user: SecretString,
    pub bitcoin_rpc_password: SecretString,
    pub mempool_api_host: Option<String>,
    pub mempool_api_endpoint: Option<String>,
    pub db_host: String,
    pub db_port: usize,
    pub db_user: SecretString,
    pub db_password: SecretString,
    pub db_name: String,
    pub citrea_rpc_url: String,
    pub citrea_light_client_prover_url: String,
    pub citrea_chain_id: u32,
    pub citrea_request_timeout: Option<Duration>,
    pub bridge_contract_address: String,
    pub header_chain_proof_path: Option<PathBuf>,
    pub header_chain_proof_batch_size: u32,
    pub security_council: SecurityCouncil,
    pub verifier_endpoints: Option<Vec<String>>,
    pub operator_endpoints: Option<Vec<String>>,
    pub operator_reimbursement_address: Option<Address<NetworkUnchecked>>,
    pub operator_collateral_funding_outpoint: Option<OutPoint>,
    pub server_cert_path: PathBuf,
    pub server_key_path: PathBuf,
    pub client_cert_path: PathBuf,
    pub client_key_path: PathBuf,
    pub ca_cert_path: PathBuf,
    pub client_verification: bool,
    pub aggregator_cert_path: PathBuf,
    pub telemetry: Option<TelemetryConfig>,
    pub aggregator_verification_address: Option<Address>,
    pub emergency_stop_encryption_public_key: Option<[u8; 32]>,
    pub time_to_send_watchtower_challenge: u16,
    pub grpc: GrpcLimits,
    pub tx_sender_limits: TxSenderLimits,
}

Configuration options for any Clementine target (tests, binaries etc.).

Fields

protocol_paramset: &'static ProtocolParamset

Protocol paramset

Sourced from either a file or the environment, is set to REGTEST_PARAMSET in tests

Skipped in deserialization and replaced by either file/environment source. See crate::cli::get_cli_config

host: String

Host of the operator or the verifier

port: u16

Port of the operator or the verifier

secret_key: SecretKey

Secret key for the operator or the verifier.

operator_withdrawal_fee_sats: Option<Amount>

Operator’s fee for withdrawal, in satoshis.

bitcoin_rpc_url: String

Bitcoin remote procedure call URL.

bitcoin_rpc_user: SecretString

Bitcoin RPC user.

bitcoin_rpc_password: SecretString

Bitcoin RPC user password.

mempool_api_host: Option<String>

mempool.space API host for retrieving the fee rate. If None, Bitcoin Core RPC will be used.

mempool_api_endpoint: Option<String>

mempool.space API endpoint for retrieving the fee rate. If None, Bitcoin Core RPC will be used.

db_host: String

PostgreSQL database host address.

db_port: usize

PostgreSQL database port.

db_user: SecretString

PostgreSQL database user name.

db_password: SecretString

PostgreSQL database user password.

db_name: String

PostgreSQL database name.

citrea_rpc_url: String

Citrea RPC URL.

citrea_light_client_prover_url: String

Citrea light client prover RPC URL.

citrea_chain_id: u32

Citrea’s EVM Chain ID.

citrea_request_timeout: Option<Duration>

Timeout in seconds for Citrea RPC calls.

bridge_contract_address: String

Bridge contract address.

header_chain_proof_path: Option<PathBuf>

header_chain_proof_batch_size: u32

Batch size of the header chain proofs

security_council: SecurityCouncil

Security council.

verifier_endpoints: Option<Vec<String>>

Verifier endpoints. For the aggregator only

operator_endpoints: Option<Vec<String>>

Operator endpoint. For the aggregator only

operator_reimbursement_address: Option<Address<NetworkUnchecked>>

Own operator’s reimbursement address.

operator_collateral_funding_outpoint: Option<OutPoint>

Own operator’s collateral funding outpoint.

server_cert_path: PathBuf

Path to the server certificate file.

Required for all entities.

server_key_path: PathBuf

Path to the server key file.

client_cert_path: PathBuf

Path to the client certificate file. (used to communicate with other gRPC services)

Required for all entities. This is used to authenticate requests. Aggregator’s client certificate should match the expected aggregator certificate in other entities.

Aggregator needs this to call other entities, other entities need this to call their own internal endpoints.

client_key_path: PathBuf

Path to the client key file.

ca_cert_path: PathBuf

Path to the CA certificate file which is used to verify client certificates.

client_verification: bool

Whether client certificates should be restricted to Aggregator and Self certificates.

Client certificates are always validated against the CA certificate according to mTLS regardless of this setting.

aggregator_cert_path: PathBuf

Path to the aggregator certificate file. (used to authenticate requests from aggregator)

Aggregator’s client cert should be equal to the this certificate.

telemetry: Option<TelemetryConfig>

Telemetry configuration

aggregator_verification_address: Option<Address>

The ECDSA address of the citrea/aggregator that will sign the withdrawal params after manual verification of the optimistic payout and operator’s withdrawal. Used for both an extra verification of aggregator’s identity and to force citrea to check withdrawal params manually during some time after launch.

emergency_stop_encryption_public_key: Option<[u8; 32]>

The X25519 public key that will be used to encrypt the emergency stop message.

time_to_send_watchtower_challenge: u16

Time to wait after a kickoff to send a watchtower challenge

grpc: GrpcLimits

gRPC client/server limits

tx_sender_limits: TxSenderLimits

Hard cap on tx sender fee rate (sat/vB).

Implementations

impl BridgeConfig

pub fn get_num_required_nofn_sigs(&self, deposit_data: &DepositData) -> usize

Returns the number of required signatures for N-of-N signing session.

Arguments

• deposit_data - The deposit data for which to calculate required signatures.

Returns

The number of required N-of-N signatures for the deposit.

pub fn get_num_required_operator_sigs( &self, deposit_data: &DepositData, ) -> usize

Returns the number of required operator signatures for a deposit.

Arguments

• deposit_data - The deposit data for which to calculate required signatures.

Returns

The number of required operator signatures for the deposit.

pub fn get_num_required_nofn_sigs_per_kickoff( &self, deposit_data: &DepositData, ) -> usize

Returns the number of required N-of-N signatures per kickoff for a deposit.

Arguments

• deposit_data - The deposit data for which to calculate required signatures per kickoff.

Returns

The number of required N-of-N signatures per kickoff.

pub fn get_num_required_operator_sigs_per_kickoff( &self, deposit_data: &DepositData, ) -> usize

Returns the number of required operator signatures per kickoff for a deposit.

Arguments

• deposit_data - The deposit data for which to calculate required signatures per kickoff.

Returns

The number of required operator signatures per kickoff.

pub fn get_num_kickoff_winternitz_pks(&self) -> usize

Returns the total number of Winternitz public keys used in kickoff UTXOs for blockhash commits.

Returns

The number of Winternitz public keys required for all rounds and kickoffs.

pub fn get_num_unspent_kickoff_sigs(&self) -> usize

Returns the total number of unspent kickoff signatures needed from each operator.

Returns

The number of unspent kickoff signatures required for all rounds from one operator.

pub fn get_num_challenge_ack_hashes(&self, deposit_data: &DepositData) -> usize

Returns the number of challenge ack hashes needed for a single operator for each round.

Arguments

• deposit_data - The deposit data for which to calculate required challenge ack hashes.

Returns

The number of challenge ack hashes required for the deposit.

impl BridgeConfig

pub fn from_env() -> Result<Self, BridgeError>

impl BridgeConfig

pub fn new() -> Self

Create a new BridgeConfig with default values.

pub fn protocol_paramset(&self) -> &'static ProtocolParamset

Get the protocol paramset defined by the paramset name.

pub fn try_parse_file(path: PathBuf) -> Result<Self, BridgeError>

Read contents of a TOML file and generate a BridgeConfig.

pub fn try_parse_from(input: String) -> Result<Self, BridgeError>

Try to parse a BridgeConfig from given TOML formatted string and generate a BridgeConfig.

pub async fn check_general_requirements(&self) -> Result<(), BridgeError>

Check general requirements for the configuration irrespective of the network.

pub fn check_mainnet_requirements( &self, actor_type: Actors, ) -> Result<(), BridgeError>

Checks various variables if they are correct for mainnet deployment.

Trait Implementations

impl Clone for BridgeConfig

fn clone(&self) -> BridgeConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BridgeConfig

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

Formats the value using the given formatter.

impl Default for BridgeConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for BridgeConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.