Expand description
Types representing the current representation of the world to libxmtp
Structs§
- ApiIdentifier
- AppVersion
- An Inbox-App specific version
- Canonical
Envelope - Canonical outer encoding and its hash. Inner payload bytes are unchanged.
- Commit
LogEntry - Cursor
- Highest sequence id processed on one topic. Zero starts at the beginning.
- Decrypted
Welcome Pointer - Decrypted
Welcome Pointer Builder - Builder for
DecryptedWelcomePointer. - GroupId
- The canonical group identifier. Exactly 16 bytes, by protocol invariant.
- Group
Message - A GroupMessage from the network
- Group
Message Builder - Builder for
GroupMessage. - Group
Message Metadata - Group
Message Metadata Builder - Builder for
GroupMessageMetadata. - Identity
Update Log - Incoming
Batch Limits - Limits for one complete transport delivery before payload processing.
- Incoming
Subscription - The receipt callback accepts only positions committed to local storage.
- Installation
Id - Ordered
Envelope Batch - One ordered delivery from a topic.
afteris the cursor used for this read. - Topic
- A topic where the first byte is the kind https://github.com/xmtp/XIPs/blob/main/XIPs/xip-49-decentralized-backend.md#332-envelopes
- Welcome
Message - Welcome Message from the network
- Welcome
Message Builder - Builder for
WelcomeMessage. - Welcome
Message V1 - Welcome
Message V1Builder - Builder for
WelcomeMessageV1. - Welcome
Pointer - Welcome
Pointer Builder - Builder for
WelcomePointer.
Enums§
- Conversation
Type - Group
IdParse Error - Error returned by
<GroupId as FromStr>::from_str. - Incoming
Event - Transport events do not mean that an envelope is stored or processed.
- Topic
Kind - Welcome
Message Type
Functions§
- canonical_
envelope - Encode the outer envelope once for storage, retries, and hash matching.
Type Aliases§
- Identifier
ToInbox IdMap - Maps account addresses to inbox IDs. If no inbox ID found, the value will be None
- Sequence
Id - Topic
Cursor - Independent positions for backend topics.