Struct AuditTrailBuilder 

pub struct AuditTrailBuilder {
    pub admin: Option<IotaAddress>,
    pub initial_record: Option<InitialRecord>,
    pub locking_config: LockingConfig,
    pub trail_metadata: Option<ImmutableMetadata>,
    pub updatable_metadata: Option<String>,
    pub record_tags: HashSet<String>,
}

Builder for creating an audit trail.

The builder collects the full create-time configuration before it is normalized into the Move create call. Any tag list configured here becomes the trail-owned registry that later role-tag and record-tag checks refer to.

Creation has three additional on-chain effects worth noting:

• The trail object is published as a shared object.
• A reserved Admin role is seeded with the permissions returned by PermissionSet::admin_permissions, and an initial-admin capability is minted and transferred to the configured admin address.
• When Self::with_initial_record is set, that record is stored as sequence number 0. Its tag (if any) must already appear in the configured record tags; otherwise the on-chain create call aborts with ERecordTagNotDefined.
• An AuditTrailCreated event is emitted.

Fields

admin: Option<IotaAddress>

Initial admin address that should receive the initial admin capability.

initial_record: Option<InitialRecord>

Optional initial record created together with the trail.

locking_config: LockingConfig

Locking rules to apply at creation time.

trail_metadata: Option<ImmutableMetadata>

Immutable metadata stored once at creation time.

updatable_metadata: Option<String>

Mutable metadata stored on the trail object.

record_tags: HashSet<String>

Canonical list of record tags owned by the trail.

Implementations

impl AuditTrailBuilder

pub fn with_initial_record(self, initial_record: InitialRecord) -> Self

Sets the full initial record input used during trail creation.

When present, the initial record is created as sequence number 0.

pub fn with_initial_record_parts( self, data: impl Into<Data>, metadata: Option<String>, tag: Option<String>, ) -> Self

Convenience helper for constructing the initial record inline.

pub fn with_locking_config(self, config: LockingConfig) -> Self

Sets the locking configuration for the trail.

This replaces the entire create-time locking configuration.

pub fn with_trail_metadata(self, metadata: ImmutableMetadata) -> Self

Sets immutable metadata for the trail.

Immutable metadata is stored once during creation and cannot be updated later.

pub fn with_trail_metadata_parts( self, name: impl Into<String>, description: Option<String>, ) -> Self

Sets immutable metadata by parts.

pub fn with_updatable_metadata(self, metadata: impl Into<String>) -> Self

Sets updatable metadata for the trail.

This seeds the mutable metadata field that later update_metadata calls can replace or clear.

pub fn with_record_tags<I, S>(self, tags: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Sets the canonical list of tags that may be used on records in this trail.

The list is deduplicated into the trail-owned tag registry during creation.

pub fn with_admin(self, admin: IotaAddress) -> Self

Sets the admin address that receives the initial-admin capability.

pub fn finish(self) -> Result<TransactionBuilder<CreateTrail>, Error>

Finalizes the builder and creates the trail-creation transaction builder.

Validates the configured LockingConfig before returning the transaction. Currently this rejects:

• LockingWindow::CountBased with count == 0 (mirrors the Move ECountWindowMustBePositive abort).
• TimeLock::UntilDestroyed used as delete_trail_lock (mirrors the Move EUntilDestroyedNotSupportedForDeleteTrail abort). write_lock may still be UntilDestroyed.

Errors

Returns Error::InvalidArgument when the locking configuration is invalid.

Trait Implementations

impl Clone for AuditTrailBuilder

fn clone(&self) -> AuditTrailBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AuditTrailBuilder

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

Formats the value using the given formatter.

impl Default for AuditTrailBuilder

fn default() -> AuditTrailBuilder

Returns the “default value” for a type.