Struct DepositData

pub struct DepositData {
    pub nofn_xonly_pk: Option<XOnlyPublicKey>,
    pub deposit: DepositInfo,
    pub actors: Actors,
    pub security_council: SecurityCouncil,
}

Data structure to represent a deposit.

• nofn_xonly_pk is cached to avoid recomputing it each time.
• deposit includes the actual information about the deposit.
• actors includes the public keys of the actors that will participate in the deposit.
• security_council includes the public keys of the security council that can unlock the deposit to create a replacement deposit in case a bug is found in the bridge.

Fields

nofn_xonly_pk: Option<XOnlyPublicKey>

Cached nofn xonly public key used for deposit.

deposit: DepositInfo

actors: Actors

security_council: SecurityCouncil

Implementations

impl DepositData

pub fn get_deposit_outpoint(&self) -> OutPoint

Returns the outpoint of the deposit.

pub fn get_nofn_xonly_pk(&mut self) -> Result<XOnlyPublicKey, BridgeError>

Returns the nofn xonly public key of the deposit. It is additionally cached to avoid recomputing it each time.

pub fn get_num_verifiers(&self) -> usize

Returns the number of verifiers in the deposit.

pub fn get_num_watchtowers(&self) -> usize

Returns the number of watchtowers in the deposit.

pub fn get_verifier_index( &self, public_key: &PublicKey, ) -> Result<usize, Report>

Returns the index of a verifier in the deposit, in the sorted order of verifiers pk.

pub fn get_watchtower_index( &self, xonly_pk: &XOnlyPublicKey, ) -> Result<usize, Report>

Returns the index of a watchtower in the deposit, in the sorted order of watchtowers pk.

pub fn get_operator_index( &self, xonly_pk: XOnlyPublicKey, ) -> Result<usize, Report>

Returns the index of an operator in the deposit, in the sorted order of operators pk.

pub fn get_verifiers(&self) -> Vec<PublicKey>

Returns sorted verifiers, they are sorted so that their order is deterministic.

pub fn get_watchtowers(&self) -> Vec<XOnlyPublicKey>

Returns sorted watchtowers, they are sorted so that their order is deterministic. It is very important for watchtowers to be sorted, as this is the order the watchtower challenge utxo’s will be in the kickoff tx. So any change in order will change the kickoff txid’s.

pub fn get_operators(&self) -> Vec<XOnlyPublicKey>

Returns sorted operators, they are sorted so that their order is deterministic.

pub fn get_num_operators(&self) -> usize

Returns the number of operators in the deposit.

pub fn get_deposit_scripts( &mut self, paramset: &'static ProtocolParamset, ) -> Result<Vec<Arc<dyn SpendableScript>>, BridgeError>

Returns the scripts a taproot address of a deposit_outpoint must have to spend the deposit. Deposits not having these scripts and corresponding taproot address should be rejected.

Trait Implementations

impl Clone for DepositData

fn clone(&self) -> DepositData

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DepositData

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DepositData

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<DepositData> for DepositParams

fn from(value: DepositData) -> Self

Converts to this type from the input type.

impl PartialEq for DepositData

fn eq(&self, other: &Self) -> 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 DepositData

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<DepositParams> for DepositData

type Error = Status

The type returned in the event of a conversion error.

fn try_from(value: DepositParams) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for DepositData