Struct VcExternalCommitJoinBuilder 

pub struct VcExternalCommitJoinBuilder { /* private fields */ }

Available on crate feature virtual-clients-draft and (32-bit or 64-bit) only.

Builder for bootstrapping a virtual client’s sibling emulator client into a higher-level group by processing another sibling’s external commit, when this client is not yet a member of that group.

The first emulator client joined the higher-level group via an external commit. A second emulator client (this one), sharing the same emulation epoch, reconstructs the resulting group state from that commit.

The join happens in two steps. Self::process_commit rebuilds the prior-epoch group and verifies the commit, returning a StagedVcExternalCommitJoin. The application inspects the verified proposals it exposes, resolves any AppDataUpdate proposals, and completes the join with StagedVcExternalCommitJoin::into_group.

Implementations

impl VcExternalCommitJoinBuilder

pub fn new() -> Self

Creates a new VcExternalCommitJoinBuilder with default values.

pub fn with_config(self, join_config: MlsGroupJoinConfig) -> Self

Specifies the configuration to use for the joined group.

pub fn with_ratchet_tree(self, ratchet_tree: RatchetTreeIn) -> Self

Specifies the prior-epoch ratchet tree. This is only used if the ratchet tree is not provided in the VerifiableGroupInfo extensions. A ratchet tree must be provided, either in the VerifiableGroupInfo extensions or via this method.

pub fn skip_lifetime_validation(self) -> Self

Skip the validation of lifetimes in leaf nodes in the ratchet tree. Note that only the leaf nodes are checked that were never updated.

By default they are validated.

pub fn process_commit<Provider: OpenMlsProvider>( self, provider: &Provider, verifiable_group_info: VerifiableGroupInfo, external_commit: impl Into<ProtocolMessage>, epoch_id: EpochId, ) -> Result<StagedVcExternalCommitJoin, VcExternalCommitJoinError<Provider::StorageError>>

Rebuilds the higher-level group at the epoch before the external commit from verifiable_group_info (and the ratchet tree, taken from the GroupInfo’s ratchet_tree extension or Self::with_ratchet_tree), and verifies external_commit against it: the GroupInfo signature and tree, the commit’s signature and external-commit shape, and that the commit’s derivation info references the shared emulation epoch epoch_id.

Nothing is consumed or persisted at this point. Dropping the returned StagedVcExternalCommitJoin discards the join without advancing the shared operation secret tree.

Trait Implementations

impl Debug for VcExternalCommitJoinBuilder

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

Formats the value using the given formatter.

impl Default for VcExternalCommitJoinBuilder

fn default() -> VcExternalCommitJoinBuilder

Returns the “default value” for a type.