Structures

The following structures are available globally.

  • Specify configuration options for creating a Client.

    See more

    Declaration

    Swift

    public struct ClientOptions

  • Undocumented

    See more

    Declaration

    Swift

    public struct Attachment : Codable

  • Undocumented

    See more

    Declaration

    Swift

    public struct AttachmentCodec : ContentCodec

  • Undocumented

    Declaration

    Swift

    public struct DecodedComposite

  • Undocumented

    See more

    Declaration

    Swift

    public struct EncryptedEncodedContent

  • Undocumented

    See more

    Declaration

    Swift

    public struct Reaction : Codable

  • Undocumented

    See more

    Declaration

    Swift

    public struct ReactionCodec : ContentCodec

  • Undocumented

    See more

    Declaration

    Swift

    public struct ReadReceipt

  • Undocumented

    See more

    Declaration

    Swift

    public struct ReadReceiptCodec : ContentCodec

  • Undocumented

    See more

    Declaration

    Swift

    public struct RemoteAttachment

  • Undocumented

    See more

    Declaration

    Swift

    public struct RemoteAttachmentCodec : ContentCodec

  • Undocumented

    See more

    Declaration

    Swift

    public struct Reply

  • Undocumented

    See more

    Declaration

    Swift

    public struct ReplyCodec : ContentCodec

  • Undocumented

    See more

    Declaration

    Swift

    public struct TextCodec : ContentCodec

  • Undocumented

    See more

    Declaration

    Swift

    public struct ConsentListEntry : Codable, Hashable

  • Undocumented

    Declaration

    Swift

    public struct ConversationV1Container : Codable

  • Handles legacy message conversations.

    See more

    Declaration

    Swift

    public struct ConversationV1

  • Undocumented

    See more

    Declaration

    Swift

    public struct ConversationV2Container : Codable

  • Handles V2 Message conversations.

    See more

    Declaration

    Swift

    public struct ConversationV2

  • Decrypted messages from a conversation.

    See more

    Declaration

    Swift

    public struct DecodedMessage : Sendable

  • Undocumented

    See more

    Declaration

    Swift

    public struct DecryptedMessage

  • Undocumented

    See more

    Declaration

    Swift

    public struct Pagination

  • Undocumented

    See more

    Declaration

    Swift

    public struct PreparedMessage

  • Wrapper class for errors from the Keystore API

    See more

    Declaration

    Swift

    public struct Xmtp_KeystoreApi_V1_KeystoreError
    extension Xmtp_KeystoreApi_V1_KeystoreError: @unchecked Sendable
    extension Xmtp_KeystoreApi_V1_KeystoreError: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding

  • Decrypt a batch of messages using X3DH key agreement

    See more

    Declaration

    Swift

    public struct Xmtp_KeystoreApi_V1_DecryptV1Request
    extension Xmtp_KeystoreApi_V1_DecryptV1Request: @unchecked Sendable
    extension Xmtp_KeystoreApi_V1_DecryptV1Request: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding

  • Response type for both V1 and V2 decryption requests

    See more

    Declaration

    Swift

    public struct Xmtp_KeystoreApi_V1_DecryptResponse
    extension Xmtp_KeystoreApi_V1_DecryptResponse: @unchecked Sendable
    extension Xmtp_KeystoreApi_V1_DecryptResponse: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding

  • Decrypt a batch of messages using the appropriate topic keys

    See more

    Declaration

    Swift

    public struct Xmtp_KeystoreApi_V1_DecryptV2Request
    extension Xmtp_KeystoreApi_V1_DecryptV2Request: @unchecked Sendable
    extension Xmtp_KeystoreApi_V1_DecryptV2Request: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding

  • Encrypt a batch of messages using X3DH key agreement

    See more

    Declaration

    Swift

    public struct Xmtp_KeystoreApi_V1_EncryptV1Request
    extension Xmtp_KeystoreApi_V1_EncryptV1Request: @unchecked Sendable
    extension Xmtp_KeystoreApi_V1_EncryptV1Request: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding

  • Response type for both V1 and V2 encryption requests

    See more

    Declaration

    Swift

    public struct Xmtp_KeystoreApi_V1_EncryptResponse
    extension Xmtp_KeystoreApi_V1_EncryptResponse: @unchecked Sendable
    extension Xmtp_KeystoreApi_V1_EncryptResponse: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding

  • Encrypt a batch of messages using the appropriate topic keys

    See more

    Declaration

    Swift

    public struct Xmtp_KeystoreApi_V1_EncryptV2Request
    extension Xmtp_KeystoreApi_V1_EncryptV2Request: @unchecked Sendable
    extension Xmtp_KeystoreApi_V1_EncryptV2Request: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding

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

    See more

    Declaration

    Swift

    public struct Xmtp_KeystoreApi_V1_CreateInviteRequest
    extension Xmtp_KeystoreApi_V1_CreateInviteRequest: @unchecked Sendable
    extension Xmtp_KeystoreApi_V1_CreateInviteRequest: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding

  • Response to a CreateInviteRequest

    See more

    Declaration

    Swift

    public struct Xmtp_KeystoreApi_V1_CreateInviteResponse
    extension Xmtp_KeystoreApi_V1_CreateInviteResponse: @unchecked Sendable
    extension Xmtp_KeystoreApi_V1_CreateInviteResponse: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding

  • Request to save a batch of invite messages to the Keystore

    See more

    Declaration

    Swift

    public struct Xmtp_KeystoreApi_V1_SaveInvitesRequest
    extension Xmtp_KeystoreApi_V1_SaveInvitesRequest: @unchecked Sendable
    extension Xmtp_KeystoreApi_V1_SaveInvitesRequest: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding

  • Response to a SaveInvitesRequest

    See more

    Declaration

    Swift

    public struct Xmtp_KeystoreApi_V1_SaveInvitesResponse
    extension Xmtp_KeystoreApi_V1_SaveInvitesResponse: @unchecked Sendable
    extension Xmtp_KeystoreApi_V1_SaveInvitesResponse: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding

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

    See more

    Declaration

    Swift

    public struct Xmtp_KeystoreApi_V1_CreateAuthTokenRequest
    extension Xmtp_KeystoreApi_V1_CreateAuthTokenRequest: @unchecked Sendable
    extension Xmtp_KeystoreApi_V1_CreateAuthTokenRequest: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding

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

    See more

    Declaration

    Swift

    public struct Xmtp_KeystoreApi_V1_SaveV1ConversationsRequest
    extension Xmtp_KeystoreApi_V1_SaveV1ConversationsRequest: @unchecked Sendable
    extension Xmtp_KeystoreApi_V1_SaveV1ConversationsRequest: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding

  • Placeholder response type for SaveV1Conversations

    See more

    Declaration

    Swift

    public struct Xmtp_KeystoreApi_V1_SaveV1ConversationsResponse
    extension Xmtp_KeystoreApi_V1_SaveV1ConversationsResponse: @unchecked Sendable
    extension Xmtp_KeystoreApi_V1_SaveV1ConversationsResponse: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding

  • Response for GetV2Conversations

    See more

    Declaration

    Swift

    public struct Xmtp_KeystoreApi_V1_GetConversationsResponse
    extension Xmtp_KeystoreApi_V1_GetConversationsResponse: @unchecked Sendable
    extension Xmtp_KeystoreApi_V1_GetConversationsResponse: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding

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

    See more

    Declaration

    Swift

    public struct Xmtp_KeystoreApi_V1_GetKeystoreStatusRequest
    extension Xmtp_KeystoreApi_V1_GetKeystoreStatusRequest: @unchecked Sendable
    extension Xmtp_KeystoreApi_V1_GetKeystoreStatusRequest: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding

  • Response to GetKeystoreStatusRequest

    See more

    Declaration

    Swift

    public struct Xmtp_KeystoreApi_V1_GetKeystoreStatusResponse
    extension Xmtp_KeystoreApi_V1_GetKeystoreStatusResponse: @unchecked Sendable
    extension Xmtp_KeystoreApi_V1_GetKeystoreStatusResponse: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding

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

    See more

    Declaration

    Swift

    public struct Xmtp_KeystoreApi_V1_InitKeystoreRequest
    extension Xmtp_KeystoreApi_V1_InitKeystoreRequest: @unchecked Sendable
    extension Xmtp_KeystoreApi_V1_InitKeystoreRequest: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding

  • Response to the request to initialize the Keystore

    See more

    Declaration

    Swift

    public struct Xmtp_KeystoreApi_V1_InitKeystoreResponse
    extension Xmtp_KeystoreApi_V1_InitKeystoreResponse: @unchecked Sendable
    extension Xmtp_KeystoreApi_V1_InitKeystoreResponse: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding

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

    See more

    Declaration

    Swift

    public struct Xmtp_KeystoreApi_V1_SignDigestRequest
    extension Xmtp_KeystoreApi_V1_SignDigestRequest: @unchecked Sendable
    extension Xmtp_KeystoreApi_V1_SignDigestRequest: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding

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

    See more

    Declaration

    Swift

    public struct Xmtp_KeystoreApi_V1_GetRefreshJobRequest
    extension Xmtp_KeystoreApi_V1_GetRefreshJobRequest: @unchecked Sendable
    extension Xmtp_KeystoreApi_V1_GetRefreshJobRequest: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding

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

    See more

    Declaration

    Swift

    public struct Xmtp_KeystoreApi_V1_GetRefreshJobResponse
    extension Xmtp_KeystoreApi_V1_GetRefreshJobResponse: @unchecked Sendable
    extension Xmtp_KeystoreApi_V1_GetRefreshJobResponse: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding

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

    See more

    Declaration

    Swift

    public struct Xmtp_KeystoreApi_V1_SetRefeshJobRequest
    extension Xmtp_KeystoreApi_V1_SetRefeshJobRequest: @unchecked Sendable
    extension Xmtp_KeystoreApi_V1_SetRefeshJobRequest: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding

  • SetRefreshJobResponse is an empty response type

    See more

    Declaration

    Swift

    public struct Xmtp_KeystoreApi_V1_SetRefreshJobResponse
    extension Xmtp_KeystoreApi_V1_SetRefreshJobResponse: @unchecked Sendable
    extension Xmtp_KeystoreApi_V1_SetRefreshJobResponse: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding

  • A mapping of topics to their decrypted invitations

    See more

    Declaration

    Swift

    public struct Xmtp_KeystoreApi_V1_TopicMap
    extension Xmtp_KeystoreApi_V1_TopicMap: @unchecked Sendable
    extension Xmtp_KeystoreApi_V1_TopicMap: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding

  • Token is used by clients to prove to the nodes that they are serving a specific wallet.

    See more

    Declaration

    Swift

    public struct Xmtp_MessageApi_V1_Token
    extension Xmtp_MessageApi_V1_Token: @unchecked Sendable
    extension Xmtp_MessageApi_V1_Token: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding

  • AuthData carries token parameters that are authenticated by the identity key signature. It is embedded in the Token structure as bytes so that the bytes don’t need to be reconstructed to verify the token signature.

    See more

    Declaration

    Swift

    public struct Xmtp_MessageApi_V1_AuthData
    extension Xmtp_MessageApi_V1_AuthData: @unchecked Sendable
    extension Xmtp_MessageApi_V1_AuthData: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding

  • This is based off of the go-waku Index type, but with the receiverTime and pubsubTopic removed for simplicity. Both removed fields are optional

    See more

    Declaration

    Swift

    public struct Xmtp_MessageApi_V1_IndexCursor
    extension Xmtp_MessageApi_V1_IndexCursor: @unchecked Sendable
    extension Xmtp_MessageApi_V1_IndexCursor: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding

  • Wrapper for potentially multiple types of cursor

    See more

    Declaration

    Swift

    public struct Xmtp_MessageApi_V1_Cursor
    extension Xmtp_MessageApi_V1_Cursor: @unchecked Sendable
    extension Xmtp_MessageApi_V1_Cursor: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding

  • This is based off of the go-waku PagingInfo struct, but with the direction changed to our SortDirection enum format

    See more

    Declaration

    Swift

    public struct Xmtp_MessageApi_V1_PagingInfo
    extension Xmtp_MessageApi_V1_PagingInfo: @unchecked Sendable
    extension Xmtp_MessageApi_V1_PagingInfo: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding

  • Envelope encapsulates a message while in transit.

    See more

    Declaration

    Swift

    public struct Xmtp_MessageApi_V1_Envelope
    extension Xmtp_MessageApi_V1_Envelope: @unchecked Sendable
    extension Xmtp_MessageApi_V1_Envelope: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding

  • Publish

    See more

    Declaration

    Swift

    public struct Xmtp_MessageApi_V1_PublishRequest
    extension Xmtp_MessageApi_V1_PublishRequest: @unchecked Sendable
    extension Xmtp_MessageApi_V1_PublishRequest: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding

  • Empty message as a response for Publish

    See more

    Declaration

    Swift

    public struct Xmtp_MessageApi_V1_PublishResponse
    extension Xmtp_MessageApi_V1_PublishResponse: @unchecked Sendable
    extension Xmtp_MessageApi_V1_PublishResponse: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding

  • Subscribe

    See more

    Declaration

    Swift

    public struct Xmtp_MessageApi_V1_SubscribeRequest
    extension Xmtp_MessageApi_V1_SubscribeRequest: @unchecked Sendable
    extension Xmtp_MessageApi_V1_SubscribeRequest: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding

  • SubscribeAll

    See more

    Declaration

    Swift

    public struct Xmtp_MessageApi_V1_SubscribeAllRequest
    extension Xmtp_MessageApi_V1_SubscribeAllRequest: @unchecked Sendable
    extension Xmtp_MessageApi_V1_SubscribeAllRequest: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding

  • Query

    See more

    Declaration

    Swift

    public struct Xmtp_MessageApi_V1_QueryRequest
    extension Xmtp_MessageApi_V1_QueryRequest: @unchecked Sendable
    extension Xmtp_MessageApi_V1_QueryRequest: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding

  • The response, containing envelopes, for a query

    See more

    Declaration

    Swift

    public struct Xmtp_MessageApi_V1_QueryResponse
    extension Xmtp_MessageApi_V1_QueryResponse: @unchecked Sendable
    extension Xmtp_MessageApi_V1_QueryResponse: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding

  • BatchQuery

    See more

    Declaration

    Swift

    public struct Xmtp_MessageApi_V1_BatchQueryRequest
    extension Xmtp_MessageApi_V1_BatchQueryRequest: @unchecked Sendable
    extension Xmtp_MessageApi_V1_BatchQueryRequest: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding

  • Response containing a list of QueryResponse messages

    See more

    Declaration

    Swift

    public struct Xmtp_MessageApi_V1_BatchQueryResponse
    extension Xmtp_MessageApi_V1_BatchQueryResponse: @unchecked Sendable
    extension Xmtp_MessageApi_V1_BatchQueryResponse: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding

  • Ciphertext represents encrypted payload. It is definited as a union to support cryptographic algorithm agility. The payload is accompanied by the cryptographic parameters required by the chosen encryption scheme.

    See more

    Declaration

    Swift

    public struct Xmtp_MessageContents_Ciphertext
    extension Xmtp_MessageContents_Ciphertext: @unchecked Sendable
    extension Xmtp_MessageContents_Ciphertext: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding

  • SignedEciesCiphertext represents an ECIES encrypted payload and a signature

    See more

    Declaration

    Swift

    public struct Xmtp_MessageContents_SignedEciesCiphertext
    extension Xmtp_MessageContents_SignedEciesCiphertext: @unchecked Sendable
    extension Xmtp_MessageContents_SignedEciesCiphertext: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding

  • Composite is used to implement xmtp.org/composite content type

    See more

    Declaration

    Swift

    public struct Xmtp_MessageContents_Composite
    extension Xmtp_MessageContents_Composite: @unchecked Sendable
    extension Xmtp_MessageContents_Composite: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding

  • LEGACY: User key bundle V1 using PublicKeys. The PublicKeys MUST be signed.

    See more

    Declaration

    Swift

    public struct Xmtp_MessageContents_ContactBundleV1
    extension Xmtp_MessageContents_ContactBundleV1: @unchecked Sendable
    extension Xmtp_MessageContents_ContactBundleV1: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding

  • User key bundle V2 using SignedPublicKeys.

    See more

    Declaration

    Swift

    public struct Xmtp_MessageContents_ContactBundleV2
    extension Xmtp_MessageContents_ContactBundleV2: @unchecked Sendable
    extension Xmtp_MessageContents_ContactBundleV2: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding

  • Versioned ContactBundle

    See more

    Declaration

    Swift

    public struct Xmtp_MessageContents_ContactBundle
    extension Xmtp_MessageContents_ContactBundle: @unchecked Sendable
    extension Xmtp_MessageContents_ContactBundle: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding

  • ContentTypeId is used to identify the type of content stored in a Message.

    See more

    Declaration

    Swift

    public struct Xmtp_MessageContents_ContentTypeId
    extension Xmtp_MessageContents_ContentTypeId: @unchecked Sendable
    extension Xmtp_MessageContents_ContentTypeId: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding

  • EncodedContent bundles the content with metadata identifying its type and parameters required for correct decoding and presentation of the content.

    See more

    Declaration

    Swift

    public struct Xmtp_MessageContents_EncodedContent
    extension Xmtp_MessageContents_EncodedContent: @unchecked Sendable
    extension Xmtp_MessageContents_EncodedContent: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding

  • SignedContent attaches a signature to EncodedContent.

    See more

    Declaration

    Swift

    public struct Xmtp_MessageContents_SignedContent
    extension Xmtp_MessageContents_SignedContent: @unchecked Sendable
    extension Xmtp_MessageContents_SignedContent: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding

  • A light pointer for a conversation that contains no decryption keys

    See more

    Declaration

    Swift

    public struct Xmtp_MessageContents_ConversationReference
    extension Xmtp_MessageContents_ConversationReference: @unchecked Sendable
    extension Xmtp_MessageContents_ConversationReference: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding

  • EciesMessage is a wrapper for ECIES encrypted payloads

    See more

    Declaration

    Swift

    public struct Xmtp_MessageContents_EciesMessage
    extension Xmtp_MessageContents_EciesMessage: @unchecked Sendable
    extension Xmtp_MessageContents_EciesMessage: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding

  • Unsealed invitation V1

    See more

    Declaration

    Swift

    public struct Xmtp_MessageContents_InvitationV1
    extension Xmtp_MessageContents_InvitationV1: @unchecked Sendable
    extension Xmtp_MessageContents_InvitationV1: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding

  • Sealed Invitation V1 Header Header carries information that is unencrypted, thus readable by the network it is however authenticated as associated data with the AEAD scheme used to encrypt the invitation body, thus providing tamper evidence.

    See more

    Declaration

    Swift

    public struct Xmtp_MessageContents_SealedInvitationHeaderV1
    extension Xmtp_MessageContents_SealedInvitationHeaderV1: @unchecked Sendable
    extension Xmtp_MessageContents_SealedInvitationHeaderV1: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding

  • Sealed Invitation V1 Invitation encrypted with key material derived from the sender’s and recipient’s public key bundles using simplified X3DH where the sender’s ephemeral key is replaced with sender’s pre-key.

    See more

    Declaration

    Swift

    public struct Xmtp_MessageContents_SealedInvitationV1
    extension Xmtp_MessageContents_SealedInvitationV1: @unchecked Sendable
    extension Xmtp_MessageContents_SealedInvitationV1: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding

  • Versioned Sealed Invitation

    See more

    Declaration

    Swift

    public struct Xmtp_MessageContents_SealedInvitation
    extension Xmtp_MessageContents_SealedInvitation: @unchecked Sendable
    extension Xmtp_MessageContents_SealedInvitation: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding

  • Message header is encoded separately as the bytes are also used as associated data for authenticated encryption

    See more

    Declaration

    Swift

    public struct Xmtp_MessageContents_MessageHeaderV1
    extension Xmtp_MessageContents_MessageHeaderV1: @unchecked Sendable
    extension Xmtp_MessageContents_MessageHeaderV1: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding

  • Message is the top level protocol element

    See more

    Declaration

    Swift

    public struct Xmtp_MessageContents_MessageV1
    extension Xmtp_MessageContents_MessageV1: @unchecked Sendable
    extension Xmtp_MessageContents_MessageV1: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding

  • Message header carries information that is not encrypted, and is therefore observable by the network. It is however authenticated as associated data of the AEAD encryption used to protect the message, thus providing tamper evidence.

    See more

    Declaration

    Swift

    public struct Xmtp_MessageContents_MessageHeaderV2
    extension Xmtp_MessageContents_MessageHeaderV2: @unchecked Sendable
    extension Xmtp_MessageContents_MessageHeaderV2: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding

  • Message combines the encoded header with the encrypted payload.

    See more

    Declaration

    Swift

    public struct Xmtp_MessageContents_MessageV2
    extension Xmtp_MessageContents_MessageV2: @unchecked Sendable
    extension Xmtp_MessageContents_MessageV2: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding

  • Versioned Message

    See more

    Declaration

    Swift

    public struct Xmtp_MessageContents_Message
    extension Xmtp_MessageContents_Message: @unchecked Sendable
    extension Xmtp_MessageContents_Message: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding

  • DecodedMessage represents the decrypted message contents. DecodedMessage instances are not stored on the network, but may be serialized and stored by clients

    See more

    Declaration

    Swift

    public struct Xmtp_MessageContents_DecodedMessage
    extension Xmtp_MessageContents_DecodedMessage: @unchecked Sendable
    extension Xmtp_MessageContents_DecodedMessage: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding

  • PrivateKey generalized to support different key types

    See more

    Declaration

    Swift

    public struct Xmtp_MessageContents_SignedPrivateKey
    extension Xmtp_MessageContents_SignedPrivateKey: @unchecked Sendable
    extension Xmtp_MessageContents_SignedPrivateKey: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding

  • PrivateKeyBundle wraps the identityKey and the preKeys, enforces usage of signed keys.

    See more

    Declaration

    Swift

    public struct Xmtp_MessageContents_PrivateKeyBundleV2
    extension Xmtp_MessageContents_PrivateKeyBundleV2: @unchecked Sendable
    extension Xmtp_MessageContents_PrivateKeyBundleV2: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding

  • LEGACY: PrivateKey generalized to support different key types

    See more

    Declaration

    Swift

    public struct Xmtp_MessageContents_PrivateKey
    extension Xmtp_MessageContents_PrivateKey: @unchecked Sendable
    extension Xmtp_MessageContents_PrivateKey: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding

  • LEGACY: PrivateKeyBundleV1 wraps the identityKey and the preKeys

    See more

    Declaration

    Swift

    public struct Xmtp_MessageContents_PrivateKeyBundleV1
    extension Xmtp_MessageContents_PrivateKeyBundleV1: @unchecked Sendable
    extension Xmtp_MessageContents_PrivateKeyBundleV1: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding

  • Versioned PrivateKeyBundle

    See more

    Declaration

    Swift

    public struct Xmtp_MessageContents_PrivateKeyBundle
    extension Xmtp_MessageContents_PrivateKeyBundle: @unchecked Sendable
    extension Xmtp_MessageContents_PrivateKeyBundle: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding

  • PrivateKeyBundle encrypted with key material generated by signing a randomly generated “pre-key” with the user’s wallet, i.e. EIP-191 signature of a “storage signature” message with the pre-key embedded in it. (see xmtp-js::PrivateKeyBundle.toEncryptedBytes for details)

    See more

    Declaration

    Swift

    public struct Xmtp_MessageContents_EncryptedPrivateKeyBundleV1
    extension Xmtp_MessageContents_EncryptedPrivateKeyBundleV1: @unchecked Sendable
    extension Xmtp_MessageContents_EncryptedPrivateKeyBundleV1: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding

  • Versioned encrypted PrivateKeyBundle

    See more

    Declaration

    Swift

    public struct Xmtp_MessageContents_EncryptedPrivateKeyBundle
    extension Xmtp_MessageContents_EncryptedPrivateKeyBundle: @unchecked Sendable
    extension Xmtp_MessageContents_EncryptedPrivateKeyBundle: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding

  • PrivatePreferencesAction is a message used to update the client’s preference store. The only current actions are allow and block. Other actions may be added later

    See more

    Declaration

    Swift

    public struct Xmtp_MessageContents_PrivatePreferencesAction
    extension Xmtp_MessageContents_PrivatePreferencesAction: @unchecked Sendable
    extension Xmtp_MessageContents_PrivatePreferencesAction: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding

  • UnsignedPublicKey represents a generalized public key, defined as a union to support cryptographic algorithm agility.

    See more

    Declaration

    Swift

    public struct Xmtp_MessageContents_UnsignedPublicKey
    extension Xmtp_MessageContents_UnsignedPublicKey: @unchecked Sendable
    extension Xmtp_MessageContents_UnsignedPublicKey: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding

  • SignedPublicKey

    See more

    Declaration

    Swift

    public struct Xmtp_MessageContents_SignedPublicKey
    extension Xmtp_MessageContents_SignedPublicKey: @unchecked Sendable
    extension Xmtp_MessageContents_SignedPublicKey: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding

  • PublicKeyBundle packages the cryptographic keys associated with a wallet.

    See more

    Declaration

    Swift

    public struct Xmtp_MessageContents_SignedPublicKeyBundle
    extension Xmtp_MessageContents_SignedPublicKeyBundle: @unchecked Sendable
    extension Xmtp_MessageContents_SignedPublicKeyBundle: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding

  • PublicKey represents a generalized public key, defined as a union to support cryptographic algorithm agility.

    See more

    Declaration

    Swift

    public struct Xmtp_MessageContents_PublicKey
    extension Xmtp_MessageContents_PublicKey: @unchecked Sendable
    extension Xmtp_MessageContents_PublicKey: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding

  • PublicKeyBundle packages the cryptographic keys associated with a wallet, both senders and recipients are identified by their key bundles.

    See more

    Declaration

    Swift

    public struct Xmtp_MessageContents_PublicKeyBundle
    extension Xmtp_MessageContents_PublicKeyBundle: @unchecked Sendable
    extension Xmtp_MessageContents_PublicKeyBundle: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding

  • Signature represents a generalized public key signature, defined as a union to support cryptographic algorithm agility.

    See more

    Declaration

    Swift

    public struct Xmtp_MessageContents_Signature
    extension Xmtp_MessageContents_Signature: @unchecked Sendable
    extension Xmtp_MessageContents_Signature: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding

  • SignedPayload is a wrapper for a signature and a payload

    See more

    Declaration

    Swift

    public struct Xmtp_MessageContents_SignedPayload
    extension Xmtp_MessageContents_SignedPayload: @unchecked Sendable
    extension Xmtp_MessageContents_SignedPayload: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding
  • See more

  • Undocumented

    See more

    Declaration

    Swift

    public struct XMTPPush

  • Undocumented

    See more

    Declaration

    Swift

    public struct Notifications_V1_DeliveryMechanism
    extension Notifications_V1_DeliveryMechanism: @unchecked Sendable
    extension Notifications_V1_DeliveryMechanism: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding

  • Undocumented

    See more

    Declaration

    Swift

    public struct Notifications_V1_RegisterInstallationRequest
    extension Notifications_V1_RegisterInstallationRequest: @unchecked Sendable
    extension Notifications_V1_RegisterInstallationRequest: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding

  • Undocumented

    See more

    Declaration

    Swift

    public struct Notifications_V1_RegisterInstallationResponse
    extension Notifications_V1_RegisterInstallationResponse: @unchecked Sendable
    extension Notifications_V1_RegisterInstallationResponse: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding

  • Undocumented

    See more

    Declaration

    Swift

    public struct Notifications_V1_DeleteInstallationRequest
    extension Notifications_V1_DeleteInstallationRequest: @unchecked Sendable
    extension Notifications_V1_DeleteInstallationRequest: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding

  • Undocumented

    See more

    Declaration

    Swift

    public struct Notifications_V1_SubscribeRequest
    extension Notifications_V1_SubscribeRequest: @unchecked Sendable
    extension Notifications_V1_SubscribeRequest: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding

  • Undocumented

    See more

    Declaration

    Swift

    public struct Notifications_V1_UnsubscribeRequest
    extension Notifications_V1_UnsubscribeRequest: @unchecked Sendable
    extension Notifications_V1_UnsubscribeRequest: SwiftProtobuf.Message, SwiftProtobuf._MessageImplementationBase, SwiftProtobuf._ProtoNameProviding

  • Undocumented

    See more

    Declaration

    Swift

    public struct SendOptions