README
¶
xmtpd
⚠️ Experimental: This software is in early development. Expect frequent changes and unresolved issues.
xmtpd (XMTP daemon) is an experimental version of XMTP node software. It is not the node software that currently forms the XMTP network.
After xmtpd meets specific functional requirements, the plan is for it to become the node software that powers the XMTP network.
Some of these requirements include reaching functional parity with the current node software and reliably performing data replication without data loss.
To keep up with and provide feedback about xmtpd development, see the Issues tab in this repo.
[!TIP] Looking for info on how to get started as a registered node operator? See the xmtpd-infrastructure repository, which provides infrastructure-as-code examples and tooling to help node operators deploy and manage xmtpd nodes.
Prerequisites
Quickstart
Install and build dependencies
To install dependencies and build background services needed by the node, run:
dev/up
This starts the following background services in Docker:
-
A Postgres database that is used to store data needed to run the node
-
A Prometheus instance that enables you to view metrics and data about the node, such as resource usage and errors
To stop the background services running in Docker, run:
dev/down
Start the node
To start the xmtpd node, run:
dev/run
Test the node
To run tests against the xmtpd node, run:
dev/test
These tests provide a full suite of unit and integration tests for the xmtpd repo to help ensure and maintain correctness of the code over time and to avoid regressions as the code evolves. You can explore the tests by taking a look at any files with the suffix _test.go.
Monitor the node
To enable metrics you need to start the node with --metrics.enable.
By default, we expose Prometheus metrics on port 8008.
curl http://localhost:8008
About the XMTP testnet
The XMTP testnet environment lives in XMTP Sepolia Chain.
The XMTP testnet nodes operated by Ephemera include:
| DNS name | Location | Public key |
|---|---|---|
| https://grpc.testnet.xmtp.network | US-EAST-2 | 0x03e5442c5d1fe2f02b6b9a1a386383a7766860b40a6079a0223994ffa2ce10512c |
| https://grpc2.testnet.xmtp.network | EU-NORTH-1 | 0x02fc261d43a0153539a4c64c29763cb0e7e377c0eac2910c3d4bedb2235ac70371 |
Deploy a local environment for developing with xmtpd
See Deploy a local environment for developing with xmtpd.
Support a new XMTP testnet node operator
See Support a new XMTP testnet node operator.
Migrate to XMTP node registry V2
xmtpd OpenMetrics catalog
See xmptd OpenMetrics catalog.
Contributing
Please follow the style guide.
Modifying the protobuf schema
Submit and land a PR to https://github.com/xmtp/proto. Then run:
dev/gen/all
Or wait for the nightly automation to finish.
Modify the database schema
Create a new migration by running:
dev/gen/migration {migration-name}
Fill in the migrations in the generated files. If you are unfamiliar with migrations, you may follow this guide. The database is PostgreSQL and the driver is PGX.
Modify database queries
We use sqlc to generate the code for our DB queries. Modify the queries.sql file, and then run:
dev/gen/all
If needed, you may use dev/psql to test more complex SQL syntax. To determine the level of support in sqlc, there is a sqlc playground for experimenting with how the query syntax translates into Go code.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
cli
command
|
|
|
gateway
command
|
|
|
prune
command
|
|
|
replication
command
|
|
|
xmtpd-cli
command
|
|
|
pkg
|
|
|
blockchain/noncemanager
Package noncemanager provides interfaces and implementations for managing transaction nonces in a blockchain environment.
|
Package noncemanager provides interfaces and implementations for managing transaction nonces in a blockchain environment. |
|
blockchain/noncemanager/redis
Package redis provides a Redis-backed implementation of the NonceManager interface.
|
Package redis provides a Redis-backed implementation of the NonceManager interface. |
|
blockchain/noncemanager/sql
Package sql provides a SQL database-backed implementation of the NonceManager interface.
|
Package sql provides a SQL database-backed implementation of the NonceManager interface. |
|
gateway/examples/basic
command
|
|
|
gateway/examples/jwt
command
|
|
|
indexer/common
Package common contains interfaces for the indexer.
|
Package common contains interfaces for the indexer. |
|
indexer/rpc_streamer
Package rpcstreamer implements a log streamer that uses the RPC node to backfill history and then switch to a subscription.
|
Package rpcstreamer implements a log streamer that uses the RPC node to backfill history and then switch to a subscription. |
|
metrics/docs
command
|
|
|
migrator
Package migrator implements a service that migrates data from a source database to a destination database.
|
Package migrator implements a service that migrates data from a source database to a destination database. |
|
proto/identity/api/v1
Package apiv1 is a reverse proxy.
|
Package apiv1 is a reverse proxy. |
|
proto/message_api/v1
Package message_apiv1 is a reverse proxy.
|
Package message_apiv1 is a reverse proxy. |
|
proto/mls/api/v1
Package apiv1 is a reverse proxy.
|
Package apiv1 is a reverse proxy. |
|
proto/xmtpv4/message_api
Package message_api is a reverse proxy.
|
Package message_api is a reverse proxy. |
|
proto/xmtpv4/metadata_api
Package metadata_api is a reverse proxy.
|
Package metadata_api is a reverse proxy. |
|
proto/xmtpv4/payer_api
Package payer_api is a reverse proxy.
|
Package payer_api is a reverse proxy. |
|
tracing
Package tracing enables [Datadog APM tracing](https://docs.datadoghq.com/tracing/) capabilities, focusing specifically on [Error Tracking](https://docs.datadoghq.com/tracing/error_tracking/)
|
Package tracing enables [Datadog APM tracing](https://docs.datadoghq.com/tracing/) capabilities, focusing specifically on [Error Tracking](https://docs.datadoghq.com/tracing/error_tracking/) |