xmtp-local-node

Use this repo to easily launch a local XMTP node for app development and testing purposes.

Prerequisites

One of the following installed and running: Docker Desktop, Orbstack, or similar.

Launch a local XMTP node

Run the up bash script:

./up

This will download and start all Docker containers to run an XMTP node.

Connect an XMTP client to a local node

To configure your XMTP client to connect to the local XMTP node, set the env client option to local.

Stop the local XMTP node

Run the down bash script:

./down