Struct ApiClientWrapper 

pub struct ApiClientWrapper<ApiClient> {
    pub api_client: GuardedApi<ApiClient>,
    /* private fields */
}

Fields

api_client: GuardedApi<ApiClient>

Implementations

impl<C: XmtpBackendClient> ApiClientWrapper<C>

pub async fn create_upload( &self, request: CreateUploadRequest, ) -> Result<CreateUploadResponse>

Get the request to send to the configured storage target.

impl<C: XmtpBackendClient> ApiClientWrapper<C>

pub async fn get_configuration(&self) -> Result<GetConfigurationResponse>

Read what the deployment publishes about itself.

Not retried here: the caller decides what a failure means. build fails with ConfigurationUnavailable; a refresh attempt logs and waits out its own schedule.

pub fn backend_url(&self) -> Option<&str>

The backend URL this client sends to, when the transport knows it. None skips the comparison with the stored backend URL.

pub fn has_credential_source(&self) -> bool

Whether a credential source was configured on the transport.

impl<C: XmtpBackendClient> ApiClientWrapper<C>

pub async fn publish_identity_update<U: Into<IdentityUpdate>>( &self, update: U, ) -> Result<Cursor>

pub async fn get_identity_updates_v2( &self, filters: Vec<GetIdentityUpdatesV2Filter>, ) -> Result<HashMap<String, Vec<IdentityUpdateLog>>>

pub async fn get_inbox_ids( &self, identifiers: Vec<ApiIdentifier>, ) -> Result<Vec<Option<String>>>

Return one optional inbox id for every input, in the same order.

pub async fn verify_smart_contract_wallet_signatures( &self, request: VerifySmartContractWalletSignaturesRequest, ) -> Result<VerifySmartContractWalletSignaturesResponse>

impl<C: XmtpBackendClient> ApiClientWrapper<C>

pub async fn query_group_messages( &self, group_id: GroupId, ) -> Result<Vec<GroupMessage>>

pub async fn query_group_messages_with_cursors( &self, cursors: TopicCursor, ) -> Result<Vec<GroupMessage>>

pub async fn query_latest_group_message( &self, group_id: GroupId, ) -> Result<Option<GroupMessage>>

pub async fn query_welcome_messages<Id: AsRef<[u8]> + Copy>( &self, installation_id: Id, ) -> Result<Vec<WelcomeMessage>>

pub async fn query_welcome_messages_with_cursors( &self, cursors: TopicCursor, ) -> Result<Vec<WelcomeMessage>>

pub async fn upload_key_package( &self, key_package: Vec<u8>, ) -> Result<EnvelopeMeta>

pub async fn fetch_key_packages( &self, keys: &[InstallationId], ) -> Result<KeyPackageMap>

pub async fn send_welcome_messages( &self, messages: &[WelcomeMessage], ) -> Result<Vec<EnvelopeMeta>>

pub async fn send_group_messages( &self, units: Vec<PublishUnit>, ) -> Result<Vec<EnvelopeMeta>>

pub async fn publish_commit_log( &self, entries: Vec<CommitLogEntry>, ) -> Result<Vec<EnvelopeMeta>>

pub async fn query_commit_log( &self, cursors: TopicCursor, ) -> Result<Vec<CommitLogEntry>>

pub async fn get_newest_message_metadata( &self, group_ids: &[GroupId], ) -> Result<HashMap<GroupId, GroupMessageMetadata>>

impl<C: XmtpMlsStreams + XmtpBackendClient> ApiClientWrapper<C>

where C::GroupMessageStream: 'static, C::WelcomeMessageStream: 'static,

pub async fn subscribe_group_messages( &self, groups: &[&GroupId], ) -> Result<<GuardedApi<C> as XmtpMlsStreams>::GroupMessageStream>

pub async fn subscribe_group_messages_with_cursors( &self, cursors: &TopicCursor, ) -> Result<<GuardedApi<C> as XmtpMlsStreams>::GroupMessageStream>

pub async fn subscribe_welcome_messages( &self, installations: &[&InstallationId], ) -> Result<<GuardedApi<C> as XmtpMlsStreams>::WelcomeMessageStream>

pub async fn subscribe_welcome_messages_with_cursors( &self, cursors: &TopicCursor, ) -> Result<<GuardedApi<C> as XmtpMlsStreams>::WelcomeMessageStream>

impl<C: XmtpBackendClient> ApiClientWrapper<C>

pub async fn register(&self, request: RegisterRequest) -> Result<RecipientState>

Create or renew a notification recipient.

pub async fn unregister( &self, request: UnregisterRequest, ) -> Result<UnregisterResponse>

Delete a notification recipient and its subscriptions.

pub async fn update_subscriptions( &self, request: UpdateSubscriptionsRequest, ) -> Result<RecipientState>

Atomically update notification subscriptions and renew the recipient.

impl<C: XmtpBackendClient> ApiClientWrapper<C>

pub async fn publish_units( &self, units: Vec<PublishUnit>, ) -> Result<Vec<EnvelopeMeta>>

Publish each atomic unit and return metadata in envelope order.

pub async fn query_ordered_page( &self, cursors: TopicCursor, limit: u32, limits: IncomingBatchLimits, ) -> Result<OrderedQueryPage>

Read one bounded ordered page without decoding MLS payloads. Commit each batch before requesting more from the new received prefix F.

pub async fn newest_topic_cursors( &self, topics: Vec<Topic>, ) -> Result<TopicCursor>

Capture fixed newest targets. Absent topics have target zero. Keep these targets unchanged while waiting for processing to reach them.

pub async fn query_all( &self, cursors: TopicCursor, limit: u32, ) -> Result<Vec<ServerEnvelope>>

Read every page. Each topic advances only to its own returned cursor.

pub async fn settle_units( &self, units: &[PublishUnit], ) -> Result<Vec<Option<EnvelopeMeta>>>

Settle a publish whose outcome is unknown without resending it: a Query of every topic in units, from the start, returns the stored metadata of each envelope in envelope order, matched by its canonical hash. None marks an envelope the backend did not store. Pages that match nothing are dropped, and the read stops once every envelope matched. A record without valid metadata fails the read: it could be any envelope, so the read cannot prove one absent.

impl<ApiClient> ApiClientWrapper<ApiClient>

pub fn new( api_client: ApiClient, retry_strategy: Retry<ExponentialBackoff>, ) -> Self

pub fn set_configuration(&mut self, configuration: Arc<ServerConfiguration>)

Chunk and pre-validate every later request against this snapshot. Called once, by build, before the client runs.

pub fn configuration(&self) -> &ServerConfiguration

What this wrapper chunks and pre-validates against.

pub fn limits(&self) -> &LimitsConfiguration

The request shapes the deployment accepts.

pub fn attach_inbox_id(&mut self, inbox_id: Option<String>)

Attach an InboxId to this API Client Wrapper. Attaches an inbox_id context to tracing logs, useful for debugging

Trait Implementations

impl<A> Clone for ApiClientWrapper<A>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<ApiClient: Debug> Debug for ApiClientWrapper<ApiClient>

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

Formats the value using the given formatter.

impl<C> SmartContractSignatureVerifier for ApiClientWrapper<C>

where C: XmtpBackendClient,

fn is_valid_signature<'life0, 'async_trait>( &'life0 self, account_id: AccountId, hash: [u8; 32], signature: Bytes, block_number: Option<BlockNumber>, ) -> Pin<Box<dyn Future<Output = Result<ValidationResponse, VerifierError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Verifies an ERC-6492https://eips.ethereum.org/EIPS/eip-6492 signature.

Arguments

• signer - can be the smart wallet address or EOA address.
• hash - Message digest for the signature.
• signature - Could be encoded smart wallet signature or raw ECDSA signature.