Skip to main content

Module backend_v1

Module backend_v1 

Source

Modules§

auth_configuration
Nested message and enum types in AuthConfiguration.
client_envelope
Nested message and enum types in ClientEnvelope.
configuration_service_server
Generated server implementations.
get_inbox_ids_request
Nested message and enum types in GetInboxIdsRequest.
get_inbox_ids_response
Nested message and enum types in GetInboxIdsResponse.
identity_service_server
Generated server implementations.
message_hash
Nested message and enum types in MessageHash.
notification_service_server
Generated server implementations.
publish_error
Nested message and enum types in PublishError.
publish_service_server
Generated server implementations.
query_newest_response
Nested message and enum types in QueryNewestResponse.
query_service_server
Generated server implementations.
register_request
Nested message and enum types in RegisterRequest.
subscribe_request
Nested message and enum types in SubscribeRequest.
subscribe_response
Nested message and enum types in SubscribeResponse.
subscribe_static_response
Nested message and enum types in SubscribeStaticResponse.
subscription_service_server
Generated server implementations.
verify_smart_contract_wallet_signatures_request
Nested message and enum types in VerifySmartContractWalletSignaturesRequest.
verify_smart_contract_wallet_signatures_response
Nested message and enum types in VerifySmartContractWalletSignaturesResponse.
welcome_message
Nested message and enum types in WelcomeMessage.

Structs§

ApnsDelivery
AuthConfiguration
Admission settings a client needs before it holds a credential. Never includes a JWKS URL, key material, leeway, or refresh timing.
CatchupTarget
Fixed catch-up boundary for one newly registered topic.
ClientEnvelope
What a client publishes. The server stores the canonical re-encoding of this message and hashes those bytes for MessageHash.
CommitLogEntry
One entry of a group’s commit log. The server decodes the group_id from the entry to derive the topic. The signature is stored and returned, not verified: it is made with a per-group key the server does not have. The log position is EnvelopeMeta.cursor; the entry carries no sequence id.
Continuation
Paging state. A message so later fields (a page token, a retained floor) can be added without a wire change.
Cursor
Position on one topic. sequence_id 0 means “from the beginning”. Values never exceed INT64_MAX (Postgres bigint); a larger value is INVALID_ARGUMENT.
EnvelopeMeta
Server-assigned metadata for one stored envelope.
FcmDelivery
GetConfigurationRequest
GetConfigurationResponse
GetInboxIdsRequest
GetInboxIdsResponse
Same order as the request. An identifier resolves to the inbox with its latest non-revoked association, or to no inbox. Revocation can reveal an older active association. Lookup uses normalized (identifier, kind), but response entries echo original inputs, including duplicates.
GroupMessage
Serialized MLS protocol message for a group. The server parses it to derive the group_id and to set is_commit_or_proposal. It does not check membership. Trailing bytes remain accepted and are returned verbatim.
HttpDelivery
KeyPackage
Last-resort key package for one installation. The server validates it and derives the topic from its installation key. Every upload is kept; the newest per installation is served by QueryNewest. Query with a cursor on a key-package topic is not supported.
LimitsConfiguration
Request shapes the backend accepts. A client chunks its work to these values.
MessageHash
Idempotency key, unique with the topic. sha256 is the SHA-256 of the stored ClientEnvelope bytes (canonical protobuf encoding, field order).
MlsConfiguration
Advisory group shapes. The backend does not enforce these values.
Ping
Pong
PublishError
Attached as a google.rpc.Status detail on application-generated publish INVALID_ARGUMENT. Transport size rejections do not require this detail.
PublishRequest
Atomic: every envelope is stored or none is. No envelope count limit; the request is at most 25 MiB, each envelope at most 1 MiB, and there are at most 1000 distinct topics. At most one identity update per inbox per request. A repeat of an envelope already stored on its topic (same MessageHash) is not an error: the stored meta is returned as success.
PublishResponse
Same order as the request, including duplicates. An oversized response can fail with a size error after commit. Retry exact envelope bytes; failure to receive a response does not establish rollback.
QueryNewestRequest
QueryNewestResponse
One result per topic that has an envelope. A topic with no envelope is absent from results. An oversized response fails with a transport size error or RESOURCE_EXHAUSTED from an application check; omission never means the byte budget was exhausted.
QueryRequest
QueryResponse
Up to limit matches across the queried topics, ascending within each topic. The order across topics carries no meaning. Client rule: for each topic that returned rows, set its cursor to that topic’s highest returned sequence_id; leave every other cursor unchanged; if has_more, query again. Each stored envelope appears once. An oversized encoded response fails with a transport size error or RESOURCE_EXHAUSTED from an application check; results are not silently omitted to fit.
RecipientState
RegisterRequest
RetentionConfiguration
ServerEnvelope
A stored envelope with its server-assigned metadata.
SubscribeRequest
SubscribeResponse
SubscribeStaticRequest
Fixed topic set for clients that cannot send bidirectional requests. Max 10,000 unique topics; zero topics is INVALID_ARGUMENT.
SubscribeStaticResponse
Subscription
Topic
Topic = 1 kind byte + identifier bytes (XIP-49 layout). The server derives the topic from the payload; a client never sends a topic on publish.
TopicQuery
One topic and the position to read from.
UnregisterRequest
UnregisterResponse
UpdateSubscriptionsRequest
VerifySmartContractWalletSignaturesRequest
VerifySmartContractWalletSignaturesResponse
WelcomeMessage
An MLS Welcome, either inline (v1) or by pointer.

Enums§

Channel