README
¶
This is the authoritative source of information about the XMTP protocol itself. It contains
- an overview of the protocol PROTOCOL.md
- the protobuf definitions of all the elements of the protocol /proto
- code generated from the protobuf definitions go/
Note that the generated typescript code is not committed here, instead it is generated dynamically when publishing the proto package to npm
The overview and the protobuf files together form the definition of the protocol. The overview leans heavily on the protobuf files and also serves as a guide for finding the relevant details in them.
Working on this repo
Before committing any changes to this repo, you will want to run npm i at least once. This will install the Husky precommit hooks to your machine.
Go code will be regenerated based on the .proto files on each commit and does not need to be done manually.
Commit messages must be in the Angular Commit Message Convention
Directories
¶
| Path | Synopsis |
|---|---|
|
message_api/v1
Package v1 is a reverse proxy.
|
Package v1 is a reverse proxy. |
|
mls/api/v1
Package v1 is a reverse proxy.
|
Package v1 is a reverse proxy. |
|
mls_validation/v1
Package v1 is a reverse proxy.
|
Package v1 is a reverse proxy. |
|
openapi
|
|
Click to show internal directories.
Click to hide internal directories.