Struct bdk_chain::keychain::ChangeSet

pub struct ChangeSet<K> {
    pub keychains_added: BTreeMap<K, Descriptor<DescriptorPublicKey>>,
    pub last_revealed: BTreeMap<DescriptorId, u32>,
}

Represents updates to the derivation index of a KeychainTxOutIndex. It maps each keychain K to a descriptor and its last revealed index.

It can be applied to KeychainTxOutIndex with apply_changeset. `ChangeSet are monotone in that they will never decrease the revealed derivation index.

Fields

keychains_added: BTreeMap<K, Descriptor<DescriptorPublicKey>>

Contains the keychains that have been added and their respective descriptor

last_revealed: BTreeMap<DescriptorId, u32>

Contains for each descriptor_id the last revealed index of derivation

Trait Implementations

impl<K: Ord> Append for ChangeSet<K>

fn append(&mut self, other: Self)

Append another ChangeSet into self.

For each keychain in keychains_added in the given ChangeSet: If the keychain already exist with a different descriptor, we overwrite the old descriptor.

For each last_revealed in the given ChangeSet: If the keychain already exists, increase the index when the other’s index > self’s index.

fn is_empty(&self) -> bool

Returns whether the changeset are empty.

impl<K: Clone> Clone for ChangeSet<K>

fn clone(&self) -> ChangeSet<K>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<K: Debug> Debug for ChangeSet<K>

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

Formats the value using the given formatter.

impl<K> Default for ChangeSet<K>

fn default() -> Self

Returns the “default value” for a type.

impl<'de, K> Deserialize<'de> for ChangeSet<K>where
    K: Ord + Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<A, K> From<ChangeSet<K>> for ChangeSet<A, ChangeSet<K>>

fn from(indexer: ChangeSet<K>) -> Self

Converts to this type from the input type.

impl<K: PartialEq> PartialEq<ChangeSet<K>> for ChangeSet<K>

fn eq(&self, other: &ChangeSet<K>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl<K> Serialize for ChangeSet<K>where
    K: Ord + Serialize,

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

Serialize this value into the given Serde serializer.

impl<K> StructuralPartialEq for ChangeSet<K>