Struct ProtocolParamset

pub struct ProtocolParamset {

    pub network: Network,
    pub num_round_txs: usize,
    pub num_kickoffs_per_round: usize,
    pub num_signed_kickoffs: usize,
    pub bridge_amount: Amount,
    pub kickoff_amount: Amount,
    pub operator_challenge_amount: Amount,
    pub collateral_funding_amount: Amount,
    pub kickoff_blockhash_commit_length: u32,
    pub watchtower_challenge_bytes: usize,
    pub winternitz_log_d: u32,
    pub user_takes_after: u16,
    pub operator_challenge_timeout_timelock: u16,
    pub operator_challenge_nack_timelock: u16,
    pub disprove_timeout_timelock: u16,
    pub assert_timeout_timelock: u16,
    pub latest_blockhash_timeout_timelock: u16,
    pub operator_reimburse_timelock: u16,
    pub watchtower_challenge_timeout_timelock: u16,
    pub finality_depth: u32,
    pub start_height: u32,
    pub genesis_height: u32,
    pub genesis_chain_state_hash: [u8; 32],
    pub bridge_nonstandard: bool,
}

Protocol parameters that affect the transactions in the contract (which also change the pre-calculated txids and sighashes).

These parameters are used when generating the transactions and changing them will break compatibility between actors, making deposits impossible. A paramset is chosen by the actor by choosing a ParamsetName inside the crate::config::BridgeConfig.

Fields

network: Network

Bitcoin network to work on (mainnet, testnet, regtest).

num_round_txs: usize

Number of round transactions that the operator will create.

num_kickoffs_per_round: usize

Number of kickoff UTXOs per round transaction.

num_signed_kickoffs: usize

Number of kickoffs that are signed per round and deposit. There are num_kickoffs_per_round utxo’s, but only num_signed_kickoffs are signed.

bridge_amount: Amount

Bridge deposit amount that users can deposit.

kickoff_amount: Amount

Amount allocated for each kickoff UTXO.

operator_challenge_amount: Amount

Amount allocated for operator challenge transactions.

collateral_funding_amount: Amount

Collateral funding amount for operators used to fund the round transaction chain.

kickoff_blockhash_commit_length: u32

Length of the blockhash commitment in kickoff transactions.

watchtower_challenge_bytes: usize

Total number of bytes of a watchtower challenge.

winternitz_log_d: u32

Winternitz derivation log_d (shared for all WOTS commitments) Currently used in statics and thus cannot be different from WINTERNITZ_LOG_D.

user_takes_after: u16

Number of blocks after which user can take deposit back if deposit request fails.

operator_challenge_timeout_timelock: u16

Number of blocks for operator challenge timeout timelock (currently BLOCKS_PER_WEEK)

operator_challenge_nack_timelock: u16

Number of blocks for operator challenge NACK timelock (currently BLOCKS_PER_WEEK * 3)

disprove_timeout_timelock: u16

Number of blocks for disprove timeout timelock (currently BLOCKS_PER_WEEK * 5)

assert_timeout_timelock: u16

Number of blocks for assert timeout timelock (currently BLOCKS_PER_WEEK * 4)

latest_blockhash_timeout_timelock: u16

Number of blocks for latest blockhash timeout timelock (currently BLOCKS_PER_WEEK * 2.5)

operator_reimburse_timelock: u16

Number of blocks for operator reimburse timelock (currently BLOCKS_PER_DAY * 2) Timelocks operator from sending the next Round Tx after the Ready to Reimburse Tx.

watchtower_challenge_timeout_timelock: u16

Number of blocks for watchtower challenge timeout timelock (currently BLOCKS_PER_WEEK * 2)

finality_depth: u32

Amount of depth a block should have from the current head to be considered finalized Also means finality_confirmations, how many confirmations are needed for a block to be considered finalized The chain tip has 1 confirmation. Minimum value should be 1.

start_height: u32

start height to sync the chain from, i.e. the height bridge was deployed

genesis_height: u32

Genesis height to sync the header chain proofs from

genesis_chain_state_hash: [u8; 32]

Genesis chain state hash

bridge_nonstandard: bool

Denotes if the bridge is non-standard, i.e. uses 0 sat outputs for round tx (except collateral) and kickoff outputs

Implementations

impl ProtocolParamset

pub fn from_toml_file(path: &Path) -> Result<Self, BridgeError>

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

pub fn default_utxo_amount(&self) -> Amount

pub fn anchor_amount(&self) -> Amount

pub fn is_block_finalized( &self, block_height: u32, chain_tip_height: u32, ) -> bool

Checks if a block is finalized. In clementine and citrea, finality depth means the amount of confirmations needed for a block to be considered finalized. The chain tip has 1 confirmation.

pub fn bridge_circuit_constant(&self) -> Result<&[u8; 32], BridgeError>

pub fn get_lcp_image_id(&self) -> Result<[u8; 32], BridgeError>

Get the light client proof image id for the network.

pub fn is_regtest(&self) -> bool

Trait Implementations

impl Clone for ProtocolParamset

fn clone(&self) -> ProtocolParamset

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ProtocolParamset

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

Formats the value using the given formatter.

impl Default for &'static ProtocolParamset

fn default() -> Self

Returns the “default value” for a type.

impl Default for ProtocolParamset

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ProtocolParamset

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<ProtocolParamsetName> for &'static ProtocolParamset

fn from(name: ProtocolParamsetName) -> Self

Converts to this type from the input type.

impl Hash for ProtocolParamset

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ProtocolParamset

fn eq(&self, other: &ProtocolParamset) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ProtocolParamset

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for ProtocolParamset

impl StructuralPartialEq for ProtocolParamset