Enum IdentityStrategy 

pub enum IdentityStrategy {
    CreateIfNotFound {
        inbox_id: String,
        identifier: Identifier,
        nonce: u64,
    },
    CreateForIdentifier {
        identifier: Identifier,
        nonce: u64,
    },
    CachedOnly,
}

The identity strategy determines how the xmtp_mls::builder::ClientBuilder constructs an identity on startup.

IdentityStrategy::CreateIfNotFound will attempt to create a new identity if one isn’t found in the store. This is the default behavior.

IdentityStrategy::CreateForIdentifier acts as CreateIfNotFound for the inbox of an identifier, which the builder asks the backend for only after it has checked the backend’s deployment.

IdentityStrategy::CachedOnly will attempt to get an identity from the store. If not found, it will return an error. This is useful if you don’t want to create a new identity on startup because the caller does not have access to a signer.

IdentityStrategy::ExternalIdentity allows you to provide an already-constructed identity to the client. This is useful for testing and not expected to be used in production.

Variants

CreateIfNotFound

Tries to get an identity from the disk store. If not found, getting one from backend.

Fields

inbox_id: String

identifier: Identifier

nonce: u64

CreateForIdentifier

CreateIfNotFound for the inbox the backend associates with the identifier, or else the inbox its registration at the nonce creates.

Fields

identifier: Identifier

nonce: u64

CachedOnly

Identity that is already in the disk store

Implementations

impl IdentityStrategy

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

pub fn new( inbox_id: String, identifier: Identifier, nonce: u64, ) -> IdentityStrategy

Create a new Identity Strategy, with IdentityStrategy::CreateIfNotFound. If an Identity is not found in the local store, creates a new one.

pub fn for_identifier(identifier: Identifier, nonce: u64) -> IdentityStrategy

Create an IdentityStrategy::CreateForIdentifier, for a caller that does not know the identifier’s inbox. The build takes the inbox the backend names, or the one the identifier creates at nonce, and fails with IdentityError::IdentifierNotInInbox unless the identifier belongs to it, as xmtp_mls::builder::ClientBuilder::build describes. An offline build checks the newest state the database stores, which can predate a revocation.

pub async fn with_inbox<ApiClient>( self, api_client: &ApiClientWrapper<ApiClient>, ) -> Result<IdentityStrategy, IdentityError>

where ApiClient: XmtpApi,

Replace IdentityStrategy::CreateForIdentifier with IdentityStrategy::CreateIfNotFound for the identifier’s inbox. Call it only after the backend’s deployment is checked: the request carries the identifier.

impl IdentityStrategy

pub async fn initialize_identity<ApiClient, S>( self, api_client: &ApiClientWrapper<ApiClient>, mls_storage: &S, scw_signature_verifier: impl SmartContractSignatureVerifier, ) -> Result<Identity, IdentityError>

where ApiClient: XmtpApi, S: XmtpMlsStorageProvider,

• Initialize an identity from the given strategy. If a stored identity is found in the database,
• it will return that identity.
• If a stored identity is found, it will validate that the inbox_id of the stored identity matches
• the inbox_id configured on the strategy.

Trait Implementations

impl Clone for IdentityStrategy

fn clone(&self) -> IdentityStrategy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IdentityStrategy

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

Formats the value using the given formatter.