status-go/protocol
Andrea Maria Piana fb6411af24
Use personal topic for push notification registration
One of the issues we noticed is that the partitioned topic
in push notification is heavy in traffic, as any user using a particular
mailserver will use that partitioned topic to register for PNs.

This commit moves from the partitioned topic to the personal topic of
the PN server, so it does not clash with other users that might happen
to have the same partitioned topic as the mailserver, resulting in long
sync times.

Another issue that will need to be addressed separately is that once you
send a message to a topic, because of the way how waku/whisper works,
you will have to register to that topic, meaning that you will receive
that data. Currently waku does not support unsubscribing from a topic
without logging in and out, so that needs also to be addressed.
2021-01-26 09:39:53 +01:00
..
audio Add audio messages 2020-07-27 17:14:50 +02:00
common Use personal topic for push notification registration 2021-01-26 09:39:53 +01:00
communities Remove filters 2020-12-23 17:20:55 +01:00
datasync Don't return an error on datasync Send 2020-11-26 16:25:52 +01:00
encryption Upgrade linter and address issues 2020-12-28 16:55:14 +01:00
identity add transparent background to identicon 2020-03-25 09:02:58 +01:00
images Resolved linting issues 2020-12-17 14:10:00 +01:00
internal/sqlite Move to protobuf for Message type (#1706) 2019-12-05 17:25:34 +01:00
migrations Use personal topic for push notification registration 2021-01-26 09:39:53 +01:00
protobuf Handle organisation membership requests 2020-12-23 17:20:55 +01:00
pushnotificationclient Use personal topic for push notification registration 2021-01-26 09:39:53 +01:00
pushnotificationserver Fix communities migration 2021-01-08 08:43:16 +01:00
sqlite Fix communities migration 2021-01-08 08:43:16 +01:00
subscription Move to monorepo structure (#1684) 2019-11-21 17:19:22 +01:00
transport Use personal topic for push notification registration 2021-01-26 09:39:53 +01:00
tt Move to monorepo structure (#1684) 2019-11-21 17:19:22 +01:00
urls Add GitHub to whitelist for URL unfurling #11426 2021-01-11 11:15:09 +01:00
v1 Send abridged version of history with messages in group chats 2021-01-26 09:39:52 +01:00
zaputil Move to monorepo structure (#1684) 2019-11-21 17:19:22 +01:00
LICENSE Move to monorepo structure (#1684) 2019-11-21 17:19:22 +01:00
README.md Added basic history of the protocol package (#1984) 2020-06-04 11:23:09 +01:00
chat.go Add ClearHistory & DeactivateChat methods 2021-01-11 13:36:05 +01:00
chat_group_proxy.go Clean up protocol package (#1890) 2020-03-09 07:19:23 +01:00
chat_test.go Move message to common namespace 2020-09-09 21:22:12 +02:00
communities_messenger_test.go Remove filters 2020-12-23 17:20:55 +01:00
contact.go Add ClearHistory & DeactivateChat methods 2021-01-11 13:36:05 +01:00
emoji_reaction.go Skip wrapping emojis in private group chats 2021-01-26 09:39:47 +01:00
ens.go Increment retry count when ENS verification fails 2020-04-14 11:16:43 +02:00
ens_test.go Increment retry count when ENS verification fails 2020-04-14 11:16:43 +02:00
errors.go Add ClearHistory & DeactivateChat methods 2021-01-11 13:36:05 +01:00
group_chat_invitation.go group chat invitation 2020-09-07 12:15:58 +02:00
group_chat_system_messages.go Move message to common namespace 2020-09-09 21:22:12 +02:00
local_notifications.go fix protocol.MessageNotificationBody marshalling 2021-01-15 14:00:51 +01:00
message_builder.go Handle organisation membership requests 2020-12-23 17:20:55 +01:00
message_handler.go Expand Local Notifications to support multiple Notification types (#2100) 2021-01-12 14:28:27 +00:00
message_handler_test.go Use goimports instead of gofmt 2020-01-06 10:17:23 +01:00
message_persistence.go Add ClearHistory & DeactivateChat methods 2021-01-11 13:36:05 +01:00
message_validator.go Fix protobuf ImageType change 2020-12-17 14:10:00 +01:00
message_validator_test.go Fix protobuf ImageType change 2020-12-17 14:10:00 +01:00
messenger.go Send abridged version of history with messages in group chats 2021-01-26 09:39:52 +01:00
messenger_config.go Send image on update 2020-12-22 15:43:48 +01:00
messenger_contact_update_test.go Add ClearHistory & DeactivateChat methods 2021-01-11 13:36:05 +01:00
messenger_contacts.go Add ClearHistory & DeactivateChat methods 2021-01-11 13:36:05 +01:00
messenger_emoji_test.go Consolidate test methods 2020-12-22 15:43:48 +01:00
messenger_installations_test.go Add ClearHistory & DeactivateChat methods 2021-01-11 13:36:05 +01:00
messenger_mute_test.go Consolidate test methods 2020-12-22 15:43:48 +01:00
messenger_response.go Expand Local Notifications to support multiple Notification types (#2100) 2021-01-12 14:28:27 +00:00
messenger_response_test.go Add SendChatMessages endpoints 2020-12-03 18:25:53 +01:00
messenger_test.go Consolidate test methods 2020-12-22 15:43:48 +01:00
persistence.go Use personal topic for push notification registration 2021-01-26 09:39:53 +01:00
persistence_test.go Add ClearHistory & DeactivateChat methods 2021-01-11 13:36:05 +01:00
push_notification_test.go Use personal topic for push notification registration 2021-01-26 09:39:53 +01:00
transaction_validator.go Move message to common namespace 2020-09-09 21:22:12 +02:00
transaction_validator_test.go Move message to common namespace 2020-09-09 21:22:12 +02:00

README.md

status-go/protocol

This is an implementation of the secure transport and payloads which are a part of the Status Client specification.

This implementation uses SQLite and SQLCipher for persistent storage.

The payloads are encoded using protocol-buffers.

Content

  • messenger.go is the main file which exports Messenger struct. This is a public API to interact with this implementation of the Status Chat Protocol.
  • protobuf/ contains protobuf files implementing payloads described in the Payloads spec.
  • encryption/ implements the Secure Transport spec.
  • transport/ connects the Status Chat Protocol with a wire-protocol which in our case is either Whisper or Waku.
  • datasync/ is an adapter for MVDS.
  • applicationmetadata/ is an outer layer wrapping a payload with an app-specific metadata like a signature.
  • identity/ implements details related to creating a three-word name and identicon.
  • migrations/ contains implementation specific migrations for the sqlite database which is used by Messenger as a persistent data store.

History

Originally this package was a dedicated repo called status-protocol-go and was migrated into status-go. The new status-go/protocol package maintained its own dependencies until sub modules were removed and the root go.mod file managed all dependencies for the entire status-go repo.