Struct ConsensusPegInTweakIdxesUsedTracker

pub struct ConsensusPegInTweakIdxesUsedTracker {
    used_tweak_idxes: BTreeSet<TweakIdx>,
    pending_pubkey_scripts: BTreeMap<ScriptBuf, TweakIdx>,
    next_pending_tweak_idx: TweakIdx,
    decoys: VecDeque<ScriptBuf>,
    decoy_session_threshold: u64,
}

Tracks addresses TweakIdxs/addresses that are expected to have been used against the stream of addresses that were actually used for peg-ins in the Federation.

Since replaying Federation history is entirely private, the goal here is to find the last peg-in address already used without compromising privacy like when querying Bitcoin node.

While at it, collect some addresses that were actually used for peg-ins by other clients, just to query for them as decoys and thus hopefully make the malicious Bitcoin node operator have less confidence about which addresses are actually linked with each other.

Fields

used_tweak_idxes: BTreeSet<TweakIdx>

Any time we detect one of the scripts in pending_pubkey_scripts was used we insert the tweak_idx, so we can skip asking network about them (which would be bad for privacy)

pending_pubkey_scripts: BTreeMap<ScriptBuf, TweakIdx>

All the pubkey scripts we are looking for in the federation history, to detect previous successful peg-ins.

next_pending_tweak_idx: TweakIdx

Next tweak idx to add to pending_pubkey_scripts

decoys: VecDeque<ScriptBuf>

Collection of recent scripts from federation history that do not belong to us

decoy_session_threshold: u64

Implementations

impl ConsensusPegInTweakIdxesUsedTracker

pub(crate) fn new( previous_next_unused_idx: TweakIdx, start_session_idx: u64, current_session_count: u64, data: &WalletClientModuleData, ) -> Self

fn init(&mut self, data: &WalletClientModuleData)

pub fn used_tweak_idxes(&self) -> &BTreeSet<TweakIdx>

fn generate_next_pending_tweak_idx(&mut self, data: &WalletClientModuleData)

fn refill_pending_pool_up_to_tweak_idx( &mut self, data: &WalletClientModuleData, tweak_idx: TweakIdx, )

pub(crate) fn handle_script( &mut self, data: &WalletClientModuleData, script: &ScriptBuf, session_idx: u64, )

fn push_decoy(&mut self, script: &ScriptBuf)

Write a someone-elses used deposit address to use a decoy

pub(crate) fn pop_decoy(&mut self) -> Option<ScriptBuf>

Pop a someone-elses used deposit address to use a decoy

Trait Implementations

impl Clone for ConsensusPegInTweakIdxesUsedTracker

fn clone(&self) -> ConsensusPegInTweakIdxesUsedTracker

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ConsensusPegInTweakIdxesUsedTracker

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

Formats the value using the given formatter.

impl Decodable for ConsensusPegInTweakIdxesUsedTracker

fn consensus_decode_from_finite_reader<D: Read>( d: &mut D, modules: &ModuleDecoderRegistry, ) -> Result<Self, DecodeError>

Decode Self from a size-limited reader.

fn consensus_decode_whole( slice: &[u8], modules: &ModuleRegistry<Decoder, DecodingMode>, ) -> Result<Self, DecodeError>

fn consensus_decode<R>( r: &mut R, modules: &ModuleRegistry<Decoder, DecodingMode>, ) -> Result<Self, DecodeError>

where R: Read,

Decode an object with a well-defined format.

fn consensus_decode_hex( hex: &str, modules: &ModuleRegistry<Decoder, DecodingMode>, ) -> Result<Self, DecodeError>

Decode an object from hex

fn consensus_decode_vec( bytes: Vec<u8>, modules: &ModuleRegistry<Decoder, DecodingMode>, ) -> Result<Self, DecodeError>

impl Encodable for ConsensusPegInTweakIdxesUsedTracker

fn consensus_encode<W: Write>(&self, writer: &mut W) -> Result<usize, Error>

Encode an object with a well-defined format. Returns the number of bytes written on success.

fn consensus_encode_to_vec(&self) -> Vec<u8>

Self::consensus_encode to newly allocated Vec<u8>

fn consensus_encode_to_hex(&self) -> String

Encode and convert to hex string representation

fn consensus_encode_to_len(&self) -> usize

Encode without storing the encoding, return the size

fn consensus_hash<H>(&self) -> H

where H: Hash, <H as Hash>::Engine: Write,

Generate a SHA256 hash of the consensus encoding using the default hash engine for H.

fn consensus_hash_sha256(&self) -> Hash

Self::consensus_hash for [bitcoin::hashes::sha256::Hash]