Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: connect to testnet #85

Closed
wants to merge 1 commit into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,26 @@ 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`.

## Connect the node to the experimental XMTP testnet

You can connect the `xmtpd` node to an experimental XMTP testnet.

You can use https://pizza.xmtp.chat/ to try messaging on the XMTP testnet.

**Warning:** The XMTP testnet is unstable and we regularly delete data from it.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@snormore - Created this PR to add info about how to connect the node to the testnet. Added some placeholder content below - not sure if it is in the correct format or location. But when you have time, might you be able to help provide the steps/instructions to make the connection? I can try them out and we'll be on our way! Thank you for all of your support and guidance. Such an exciting time...

Copy link
Contributor

@snormore snormore May 9, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Realizing now that there's some work to do to support external connections. I opened ephemeraHQ/xmtpd-terraform#28 to track it.

To connect an `xmtpd` node to the XMTP testnet:

1. Do this...

2. Then this...

3. Then this...

4. Restart the node: `dev/down`, `dev/up`, and `dev/start`???

5. To confirm that your node is connected, xxxxxx.

## Monitor the node

The `xmtpd` node build provides two options for monitoring your node.
Expand Down