Struct AuditTrailClientReadOnly 

pub struct AuditTrailClientReadOnly { /* private fields */ }

A read-only client for interacting with audit-trail objects on a specific network.

This is the main entry point for applications that only need package resolution and typed read helpers. Once constructed, use Self::trail to create lightweight handles scoped to a single trail object.

For write flows, wrap this client in crate::AuditTrailClient.

Implementations

impl AuditTrailClientReadOnly

pub const fn network(&self) -> &NetworkName

Returns the name of the network the client is connected to.

pub fn chain_id(&self) -> &str

Returns the raw chain identifier for the network this client is connected to.

pub fn package_id(&self) -> ObjectID

Returns the package ID used by this client.

This is the deployed audit-trail Move package ID, not a trail object ID.

pub fn tf_components_package_id(&self) -> ObjectID

Returns the TfComponents package ID used by this client.

pub const fn iota_client(&self) -> &IotaClientAdapter

Returns a reference to the underlying IOTA client adapter.

pub fn trail<'a>(&'a self, trail_id: ObjectID) -> AuditTrailHandle<'a, Self>

Returns a typed handle bound to a specific trail object ID.

Creating the handle is cheap. Reads only happen when you call methods on the returned AuditTrailHandle, such as AuditTrailHandle::get.

pub async fn new(iota_client: IotaClient) -> Result<Self, Error>

Creates a new read-only client from an IOTA client.

The package IDs are resolved from the internal registry using the connected network name. This is the recommended constructor when connecting to official deployments whose package history is already tracked by the crate.

Errors

Returns an error if the network cannot be resolved or if the package IDs for that network cannot be determined.

pub async fn new_with_package_overrides( iota_client: IotaClient, package_overrides: PackageOverrides, ) -> Result<Self, Error>

Creates a new read-only client with explicit package-ID overrides.

This bypasses the default package-registry lookup for any IDs provided in PackageOverrides.

Prefer this constructor when talking to custom deployments, local networks, or preview environments whose package IDs are not yet part of the built-in registry.

Errors

Returns an error if the network cannot be resolved or if the resulting package-ID configuration is invalid.

Trait Implementations

impl Clone for AuditTrailClientReadOnly

fn clone(&self) -> AuditTrailClientReadOnly

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl CoreClientReadOnly for AuditTrailClientReadOnly

fn package_id(&self) -> ObjectID

Returns the package ID associated with the Client.

fn tf_components_package_id(&self) -> Option<ObjectID>

Returns the [TfComponents] package ID for this client’s network, if applicable.

fn network_name(&self) -> &NetworkName

Returns the name of the network the client is connected to.

fn client_adapter(&self) -> &IotaClientAdapter

Returns the underlying [IotaClientAdapter] used by this client.

fn package_history(&self) -> Vec<ObjectId>

Returns the IDs of all packages version, from initial to current.

fn get_object_by_id<'life0, 'async_trait, T>( &'life0 self, object_id: ObjectId, ) -> Pin<Box<dyn Future<Output = Result<T, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, T: 'async_trait + DeserializeOwned, Self: Sync + 'async_trait,

Retrieves a Move Object by its ID.

fn get_object_ref_by_id<'life0, 'async_trait>( &'life0 self, object_id: ObjectId, ) -> Pin<Box<dyn Future<Output = Result<Option<OwnedObjectRef>, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, Self: Sync + 'async_trait,

Retrieves an object’s [OwnedObjectRef], if any.

fn find_object_for_address<'life0, 'async_trait, T, P>( &'life0 self, address: Address, predicate: P, ) -> Pin<Box<dyn Future<Output = Result<Option<T>, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, T: MoveType + DeserializeOwned + 'async_trait, P: Fn(&T) -> bool + Send + 'async_trait, Self: Sync + 'async_trait,

Retrieves an object owned by the specified address that matches the given predicate.

fn get_iota_coins_with_at_least_balance<'life0, 'async_trait>( &'life0 self, owner: Address, balance: u64, ) -> Pin<Box<dyn Future<Output = Result<Vec<ObjectReference>, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, Self: Sync + 'async_trait,

Retrieves coins owned by the specified address with a balance of at least balance.

fn find_owned_ref_for_address<'life0, 'async_trait, P>( &'life0 self, address: Address, tag: StructTag, predicate: P, ) -> Pin<Box<dyn Future<Output = Result<Option<ObjectReference>, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, P: Fn(&IotaObjectData) -> bool + Send + 'async_trait, Self: Sync + 'async_trait,

Queries the object owned by this sender address and returns the first one that matches tag and for which predicate returns true.

impl Deref for AuditTrailClientReadOnly

type Target = IotaClientRustSdk

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.