Struct ChangeSet

pub struct ChangeSet {
    pub last_revealed: BTreeMap<DescriptorId, u32>,
    pub spk_cache: BTreeMap<DescriptorId, BTreeMap<u32, ScriptBuf>>,
}

ChangeSet represents persistent updates to a KeychainTxOutIndex.

It tracks:

1. last_revealed: the highest derivation index revealed per descriptor.
2. spk_cache: the cache of derived script pubkeys to persist across runs.

You can apply a ChangeSet to a KeychainTxOutIndex via KeychainTxOutIndex::apply_changeset, or merge two change sets with ChangeSet::merge.

Monotonicity

• last_revealed is monotonic: merging retains the maximum index for each descriptor and never decreases.
• spk_cache accumulates entries: once a script pubkey is persisted, it remains available for reload. If the same descriptor and index appear again with a new script pubkey, the latter value overrides the former.

Fields

last_revealed: BTreeMap<DescriptorId, u32>

Maps each DescriptorId to its last revealed derivation index.

spk_cache: BTreeMap<DescriptorId, BTreeMap<u32, ScriptBuf>>

Cache of derived script pubkeys to persist, keyed by descriptor ID and derivation index (u32).

Implementations

impl ChangeSet

pub const SCHEMA_NAME: &'static str = "bdk_keychaintxout"

Schema name for the changeset.

pub const LAST_REVEALED_TABLE_NAME: &'static str = "bdk_descriptor_last_revealed"

Name for table that stores last revealed indices per descriptor id.

pub const DERIVED_SPKS_TABLE_NAME: &'static str = "bdk_descriptor_derived_spks"

Name for table that stores derived spks.

pub fn schema_v0() -> String

Get v0 of sqlite keychain_txout::ChangeSet schema

pub fn schema_v1() -> String

Get v1 of sqlite keychain_txout::ChangeSet schema

pub fn init_sqlite_tables(db_tx: &Transaction<'_>) -> Result<()>

Initialize sqlite tables for persisting KeychainTxOutIndex.

pub fn from_sqlite(db_tx: &Transaction<'_>) -> Result<Self>

Construct KeychainTxOutIndex from sqlite database and given parameters.

Remember to call Self::init_sqlite_tables beforehand.

pub fn persist_to_sqlite(&self, db_tx: &Transaction<'_>) -> Result<()>

Persist changeset to the sqlite database.

Remember to call Self::init_sqlite_tables beforehand.

Trait Implementations

impl Clone for ChangeSet

fn clone(&self) -> ChangeSet

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ChangeSet

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

Formats the value using the given formatter.

impl Default for ChangeSet

fn default() -> ChangeSet

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ChangeSet

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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

fn from(indexer: ChangeSet) -> Self

Converts to this type from the input type.

impl Merge for ChangeSet

fn merge(&mut self, other: Self)

Merge another ChangeSet into self.

fn is_empty(&self) -> bool

Returns whether the changeset are empty.

fn take(&mut self) -> Option<Self>

Take the value, replacing it with the default value.

impl PartialEq for ChangeSet

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ChangeSet