status-go/protocol
Pascal Precht f3af6aa4dc feat: introduce `AddBookmark` and `RemoveBookmark` APIs to messenger
These APIs are being introduced to address #2706 and #2704, provided
that clients will move to using these APIs instead of the currently
provided equivalent APIs in the browser service.

The `bookmarks` table is being extended with a `deleted_at` field which
can later be used for garbage collection, as "removing" a bookmark is
merely soft deletion and doesn't actually remove the data from the
database.

In addition to those APIs adding and soft deleting bookmark entries,
they also automatically perform a sync operation to ensure that
bookmarks are synced in real-time (#2704).

Closes #2706, #2704
2022-06-17 12:29:03 +02:00
..
anonmetrics feat: introduce `AddBookmark` and `RemoveBookmark` APIs to messenger 2022-06-17 12:29:03 +02:00
audio Add audio messages 2020-07-27 17:14:50 +02:00
common Get preferred network IP and refactor server package to increase reusability (#2626) 2022-06-15 15:49:31 +01:00
communities feat: sync `CommunitySettings` across paired devices 2022-06-16 12:45:05 +02:00
datasync Rename MessageProcessor to MessageSender (#2264) 2021-06-23 17:13:48 +03:00
encryption feat: introduce `AddBookmark` and `RemoveBookmark` APIs to messenger 2022-06-17 12:29:03 +02:00
ens Check for verified records when creating a contact 2021-11-15 18:53:35 +00:00
identity Populate colorHash and colorId (#2630) 2022-04-08 13:54:29 -04:00
images load audio from http server 2022-03-01 15:58:32 +01:00
internal/sqlite Sync Settings (#2478) 2022-03-23 18:47:00 +00:00
migrations feat: introduce `AddBookmark` and `RemoveBookmark` APIs to messenger 2022-06-17 12:29:03 +02:00
protobuf feat: introduce `AddBookmark` and `RemoveBookmark` APIs to messenger 2022-06-17 12:29:03 +02:00
pushnotificationclient feat: introduce `AddBookmark` and `RemoveBookmark` APIs to messenger 2022-06-17 12:29:03 +02:00
pushnotificationserver feat: introduce `AddBookmark` and `RemoveBookmark` APIs to messenger 2022-06-17 12:29:03 +02:00
requests feat: add intro/outro message to communities 2022-05-31 11:41:26 +02:00
sqlite Address linter issues 2022-03-28 13:14:12 +01:00
subscription Move to monorepo structure (#1684) 2019-11-21 17:19:22 +01:00
transport feat: introduce `AddBookmark` and `RemoveBookmark` APIs to messenger 2022-06-17 12:29:03 +02:00
tt Tests and linting 2021-09-30 13:02:41 +01:00
urls chore: remove tenor since the api no longer returns a url (#2439) 2021-11-24 10:12:30 -05:00
v1 feat: sync `CommunitySettings` across paired devices 2022-06-16 12:45:05 +02: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
activity_center.go Initial support for mutual contact requests 2022-05-31 09:12:36 +01:00
activity_center_persistence.go Initial support for mutual contact requests 2022-05-31 09:12:36 +01:00
anon_metrics_test.go Turning the tests back on (#2519) 2022-02-03 20:37:41 +00:00
chat.go feat: remove explicit group chat join 2022-06-08 11:48:45 +01:00
chat_group_proxy.go Clean up protocol package (#1890) 2020-03-09 07:19:23 +01:00
chat_test.go Add mentioned field 2021-05-26 08:33:38 +02:00
communities_messenger_test.go feat: sync `CommunitySettings` across paired devices 2022-06-16 12:45:05 +02:00
contact.go Initial support for mutual contact requests 2022-05-31 09:12:36 +01:00
delete_message.go Delete messages (#2279) 2021-07-26 17:06:32 -04:00
edit_message.go address feedback 2021-06-29 13:15:15 +02:00
emoji_reaction.go Skip wrapping emojis in private group chats 2021-01-26 09:39:47 +01: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 feat: remove explicit group chat join 2022-06-08 11:48:45 +01:00
identity_images.go Add HasAddedUs field 2021-10-04 12:19:15 +02:00
local_notifications.go Sync Settings (#2478) 2022-03-23 18:47:00 +00:00
message_builder.go add PinMessage and PinnedMessage (#2180) 2021-05-14 23:22:50 +02:00
message_persistence.go improve MarkAllRead performance (#2698) 2022-05-31 10:18:48 +02:00
message_validator.go feat: display name 2022-03-14 13:48:34 -04:00
message_validator_test.go Fix protobuf ImageType change 2020-12-17 14:10:00 +01:00
messenger.go feat: introduce `AddBookmark` and `RemoveBookmark` APIs to messenger 2022-06-17 12:29:03 +02:00
messenger_activity_center.go Join group on accepting activity center notification 2022-06-08 11:48:45 +01:00
messenger_activity_center_test.go Turning the tests back on (#2519) 2022-02-03 20:37:41 +00:00
messenger_auto_message.go feat: auto message (#2441) 2021-11-29 14:11:55 +01:00
messenger_backup.go feat: sync `CommunitySettings` across paired devices 2022-06-16 12:45:05 +02:00
messenger_backup_test.go Backup communities 2022-03-23 14:45:52 +00:00
messenger_bookmarks.go feat: introduce `AddBookmark` and `RemoveBookmark` APIs to messenger 2022-06-17 12:29:03 +02:00
messenger_chats.go return muted chats in ChatsPreview call (#2617) 2022-04-01 14:20:38 +05:30
messenger_communities.go feat: sync `CommunitySettings` across paired devices 2022-06-16 12:45:05 +02:00
messenger_config.go Get preferred network IP and refactor server package to increase reusability (#2626) 2022-06-15 15:49:31 +01:00
messenger_contact_requests_test.go Enable contact request settings 2022-06-13 13:46:45 +01:00
messenger_contact_update_test.go Sync Settings (#2478) 2022-03-23 18:47:00 +00:00
messenger_contacts.go Initial support for mutual contact requests 2022-05-31 09:12:36 +01:00
messenger_delete_message_test.go Turning the tests back on (#2519) 2022-02-03 20:37:41 +00:00
messenger_discv5.go feat: Add DiscV5 to Waku2 (#2434) 2021-11-22 09:40:14 -04:00
messenger_display_name.go Sync Settings (#2478) 2022-03-23 18:47:00 +00:00
messenger_edit_message_test.go Turning the tests back on (#2519) 2022-02-03 20:37:41 +00:00
messenger_emoji_test.go Turning the tests back on (#2519) 2022-02-03 20:37:41 +00:00
messenger_ens.go Request/Decline access to communities 2021-02-26 15:35:43 +01:00
messenger_handler.go Enable contact request settings 2022-06-13 13:46:45 +01:00
messenger_handler_test.go feat: remove explicit group chat join 2022-06-08 11:48:45 +01:00
messenger_identity_image_test.go Sync profile picture 2022-04-21 19:50:31 +03:00
messenger_images.go Get preferred network IP and refactor server package to increase reusability (#2626) 2022-06-15 15:49:31 +01:00
messenger_installations_test.go Sync bookmarks 2022-02-17 12:40:33 +00:00
messenger_mailserver.go Introduce community history archive routine 2022-04-06 13:00:33 +02:00
messenger_mailserver_cycle.go Initial support for mutual contact requests 2022-05-31 09:12:36 +01:00
messenger_maps.go Tests and linting 2021-09-30 13:02:41 +01:00
messenger_messages.go Add chatID to removed messages 2021-08-25 12:21:40 +03:00
messenger_mute_test.go Fix some tests and restore private/public RPC client 2021-07-20 10:57:38 +02:00
messenger_peers.go feat: functions to add peers and dial (#2345) 2021-09-27 09:04:28 -04:00
messenger_pin_message_test.go Turning the tests back on (#2519) 2022-02-03 20:37:41 +00:00
messenger_pin_messages.go feat: introduce `CommunityAdminSettings` in `CommunityDescription` 2022-05-18 09:58:11 +02:00
messenger_response.go Initial support for mutual contact requests 2022-05-31 09:12:36 +01:00
messenger_response_test.go feat: desktop mailserver cycle (#2481) 2022-01-12 12:02:01 -04:00
messenger_share_image_test.go Fix: recieved shared image message not being displayed 2022-03-14 10:59:26 +03:00
messenger_status_updates.go Sync Settings (#2478) 2022-03-23 18:47:00 +00:00
messenger_sync_bookmark_test.go Sync bookmarks 2022-02-17 12:40:33 +00:00
messenger_sync_chat_test.go Set joined=message.clock on syncing pubchat creation 2021-12-24 16:47:28 +02:00
messenger_sync_clear_history_test.go Sync clear history 2022-02-17 11:15:01 +00:00
messenger_sync_profile_picture_test.go Sync profile picture 2022-04-21 19:50:31 +03:00
messenger_sync_settings.go Enable currency settings and sticker pack synchronization 2022-05-11 16:59:12 +03:00
messenger_sync_settings_test.go Sync Settings (#2478) 2022-03-23 18:47:00 +00:00
messenger_sync_wallets_test.go Wallet sync 2022-05-18 15:25:20 +03:00
messenger_test.go Join group on accepting activity center notification 2022-06-08 11:48:45 +01:00
persistence.go feat: introduce `AddBookmark` and `RemoveBookmark` APIs to messenger 2022-06-17 12:29:03 +02:00
persistence_test.go Address linter issues 2022-03-28 13:14:12 +01:00
push_notification_test.go feat: display name 2022-03-14 13:48:34 -04:00
status_update.go feat: user status (#2276) 2021-07-22 13:41:49 -04: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.