matterbridge/vendor/github.com/status-im/status-go/protocol/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.