Enum CheckpointObjectProof 

#[non_exhaustive]
pub enum CheckpointObjectProof {
    Inclusion {
        object_ref: ObjectReference,
        object: Option<Box<Object>>,
    },
    NonInclusion,
}

Available on crate feature unstable only.

The authenticated outcome of LightClient::prove_object_at_checkpoint.

Inclusion means the checkpoint modified the object id: the reference is authenticated by the OCS Merkle proof against the checkpoint’s BLS-verified summary. object is Some if the modification left the object live (created, mutated, or unwrapped) and BCS-decodes to a value whose (id, version, digest) matches object_ref. object is None if the modification was a deletion or wrap; in that case object_ref.digest() carries the framework’s sentinel digest for that operation, and the server omits the object_data bytes (there is no live object state to authenticate).

NonInclusion means the checkpoint did not modify this object id — cryptographically attested via a sorted-leaf id-strict-bracketing non-inclusion proof.

NonInclusion does not prove the object doesn’t exist on chain. An object that was last modified in an earlier checkpoint and was untouched at the requested checkpoint will produce a NonInclusion result. Callers that need the object’s state at a checkpoint when it wasn’t modified there must use a separate query — for example, ratchet back to the most recent modification, or use an unauthenticated read via LedgerService.GetObject. An authenticated “current state at this checkpoint when unmodified” query is future work tied to a different commitment scheme.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Inclusion

The checkpoint modified the requested object id.

Fields

object_ref: ObjectReference

The authenticated reference for the modified object.

object: Option<Box<Object>>

The decoded object at the version this checkpoint committed to, or None if the modification was a deletion or wrap.

NonInclusion

The checkpoint did not modify the requested object id. See the type-level doc for what this does and does not attest.

Trait Implementations

impl Debug for CheckpointObjectProof

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

Formats the value using the given formatter.