LibXMTP is a shared library encapsulating the core functionality of the XMTP messaging protocol, such as cryptography, networking, and language bindings.
Start Docker Desktop.
-
To install other dependencies and start background services:
dev/upSpecifically, this command creates and runs an XMTP node in Docker Desktop.
-
To run tests:
RUST_LOG=off cargo testMany team members also install and use
cargo nextestfor better test isolation and log outpu 95A1 t behavior. -
To run WebAssembly tests headless:
dev/test/wasm -
To run WebAssembly tests interactively for a package, for example,
xmtp_mls:dev/test/wasm-interactive xmtp_mls -
To run browser SDK tests:
dev/test/browser-sdk
- Output test logs in a async-aware context-specific tree format with the
environment variable
CONTEXTUAL
CONTEXTUAL=1 cargo test
- Filter tests logs by Crate
RUST_LOG=xmtp_mls=debug,xmtp_api=off,xmtp_id=info cargo test
- Output test logs as in a structured JSON format for inspection with third-party viewer
STRUCTURED=1 cargo test
- Two ways to replace InboxIds/InstallationIds/EthAddresses with a human-readable string name in logs
NOTE: Only works when using CONTEXTUAL=1 flag. So to get the replacement,
CONTEXTUAL=1 cargo test
1.)
Before the test runs, add an TestLogReplace declaration to the top
replace.add accepts two arguments: the string to replace in logs and the
string to replace it with. Note that on dropping the "TestLogReplace" object,
the replacements will no longer be made.
let mut replace = TestLogReplace::default();
replace.add(alix.installation_id(), "alix_installation_id");2.) Build the TesterBuilder with_name
let tester = Tester::builder().with_name("alix").build().await;This replaces all instances of alix's InboxIds, InstallationIds and Identifiers with "alix", "alix_installation", "alix_identifier" respectively, in test output logs.
This project supports containerized development. From Visual Studio Code Dev Containers extension specify the Dockerfile as the target:
Reopen in Container
or
Command line build using docker
docker build . -t libxmtp:1libxmtp/
├ bindings_ffi: FFI bindings for Android and iOS (in
progress)
├ bindings_wasm: Wasm bindings (in progress)
├ examples/
│ ├ android/xmtpv3_example: Example
Android app (in progress)
│ └ cli: Example XMTP console client. Use the CLI to try out
sending double ratchet messages on the XMTP dev network.
├ xmtp_api_grpc: API client for XMTP's gRPC API, using code
from xmtp_proto
├ xmtp_api_http: API client for XMTP's gRPC Gateway API,
using code from xmtp_proto
├ xmtp_cryptography: Cryptographic operations
├ xmtp_mls: Version 3 of XMTP which implements
Messaging Layer Security.
├ xmtp_proto: Generated code for handling XMTP protocol
buffers
possible benchmarks include:
group_limit: benchmarks surrounding maximum members adding/removed from groupcrypto: benchmarks surrounding cryptographic functions
Example Commands
- Run a specific category of benchmark
cargo bench --features bench -p xmtp_mls --bench group_limit - Run against dev grpc DEV_GRPC=1 cargo bench --features bench -p xmtp_mls --bench group_limit
- Just run all benchmarks ./dev/bench
- Run one specific benchmark ./dev/bench add_1_member_to_group
- Generate flamegraph from one benchmark ./dev/flamegraph add_1_member_to_group
See our contribution guide to learn more about contributing to this project.