Module v1 

Modules

decrypt_response

Nested message and enum types in DecryptResponse.

decrypt_v1_request

Nested message and enum types in DecryptV1Request.

decrypt_v2_request

Nested message and enum types in DecryptV2Request.

encrypt_response

Nested message and enum types in EncryptResponse.

encrypt_v1_request

Nested message and enum types in EncryptV1Request.

encrypt_v2_request

Nested message and enum types in EncryptV2Request.

get_conversation_hmac_keys_response

Nested message and enum types in GetConversationHmacKeysResponse.

get_keystore_status_response

Nested message and enum types in GetKeystoreStatusResponse.

init_keystore_request

Nested message and enum types in InitKeystoreRequest.

save_invites_request

Nested message and enum types in SaveInvitesRequest.

save_invites_response

Nested message and enum types in SaveInvitesResponse.

self_decrypt_request

Nested message and enum types in SelfDecryptRequest.

self_encrypt_request

Nested message and enum types in SelfEncryptRequest.

self_encrypt_response

Nested message and enum types in SelfEncryptResponse.

sign_digest_request

Nested message and enum types in SignDigestRequest.

topic_map

Nested message and enum types in TopicMap.

Structs

CreateAuthTokenRequest

CreateAuthTokenRequest is used to create an auth token for the XMTP API

CreateInviteRequest

Request to create an invite payload, and store the topic keys in the Keystore

CreateInviteResponse

Response to a CreateInviteRequest

DecryptResponse

Response type for both V1 and V2 decryption requests

DecryptV1Request

Decrypt a batch of messages using X3DH key agreement

DecryptV2Request

Decrypt a batch of messages using the appropriate topic keys

EncryptResponse

Response type for both V1 and V2 encryption requests

EncryptV1Request

Encrypt a batch of messages using X3DH key agreement

EncryptV2Request

Encrypt a batch of messages using the appropriate topic keys

GetConversationHmacKeysRequest

Used to get a mapping of conversation topics to their HMAC keys

GetConversationHmacKeysResponse

A mapping of topics to their HMAC keys

GetConversationsResponse

Response for GetV2Conversations

GetKeystoreStatusRequest

Used to check if the Keystore implementation has been setup for the given wallet address Only used for MM Snap Keystore currently

GetKeystoreStatusResponse

Response to GetKeystoreStatusRequest

GetPrivatePreferencesTopicIdentifierResponse

Get the private preferences topic identifier

GetRefreshJobRequest

GetRefreshJobRequest is used to get the last run time of a refresh job

GetRefreshJobResponse

GetRefreshJobResponse is used to return the last run time of a refresh job

InitKeystoreRequest

Used to initialize the Keystore with a private key bundle retrieved from the client

InitKeystoreResponse

Response to the request to initialize the Keystore

KeystoreError

Wrapper class for errors from the Keystore API

PrivatePreferencesActionMap

A mapping of message hashes to their private preferences action

SaveInvitesRequest

Request to save a batch of invite messages to the Keystore

SaveInvitesResponse

Response to a SaveInvitesRequest

SaveV1ConversationsRequest

SaveV1ConversationsRequest is used to save a batch of conversations to the built in persistence

SaveV1ConversationsResponse

Placeholder response type for SaveV1Conversations

SelfDecryptRequest

SelfDecryptRequest

SelfEncryptRequest

Encrypt a message for yourself

SelfEncryptResponse

Response type for SelfEncryptRequest

SetRefeshJobRequest

SetRefreshJobRequest is used to set the last run time of a refresh job

SetRefreshJobResponse

SetRefreshJobResponse is an empty response type

SignDigestRequest

SignDigestRequest is used to sign a digest with either the identity key or a prekey

TopicMap

A mapping of topics to their decrypted invitations

Enums

ErrorCode

Application-specific error codes for the Keystore API.

JobType

JobType is used to specify the type of job the caller would like info on