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.

Sign up for GitHub

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

Jump to bottom

Docs: Update README for public repo #285

Merged
merged 1 commit into from
Aug 15, 2023
Merged

Docs: Update README for public repo #285

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 11 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,20 @@
# xmtp-node-go

This repo provides the node software that currently forms the XMTP network.
This repo provides software for the nodes that currently form the XMTP network. **No new development is planned for this node software.**

This repo is private because this node software is not meant for public use. All nodes that currently form the XMTP network are run by XMTP Labs.
At this time, all nodes in the XMTP network are run by XMTP Labs, whose mission is to promote and support the development and global adoption of XMTP.
Copy link
Contributor

Choose a reason for hiding this comment

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

Should we stop using XMTP Labs? Maybe we can avoid using the direct reference here?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thank you @mkobetic - I think we need to disclose who is operating the nodes - WDYT? What did you have in mind? =) I will be sure to keep this reference up to date.

Copy link
Contributor

Choose a reason for hiding this comment

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

I just thought we wanted to stop propagating that name. Otherwise no objection to the sentence as is.


If you're interested in an **experimental** version of XMTP node software that might be used to form the XMTP network in the future, see [xmtpd](https://github.com/xmtp/xmtpd).
All new development is focused on [xmtpd](https://github.com/xmtp/xmtpd), an **experimental** version of XMTP node software.

After `xmtpd` meets specific functional requirements, the plan is for it to become the node software that powers the XMTP network. In the future, anyone will be able to run an `xmtpd` node that participates in the XMTP network.

## Instructions

### Install prerequisites
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Added prereqs below - correct?


- [Go](https://go.dev/doc/install)
- [Docker](https://www.docker.com/get-started/)

Copy link
Contributor Author

@jhaaaa jhaaaa Aug 14, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

When I run dev/test and dev/start, I get this error:

# github.com/lucas-clemente/quic-go/internal/qtls../../go/pkg/mod/github.com/lucas-clemente/
[email protected]/internal/qtls/go119.go:6:13: cannot use "The version of quic-go you're using 
can't be built on Go 1.19 yet. For more details, please see https://github.com/lucas-clemente/
quic-go/wiki/quic-go-and-Go-versions." (untyped string constant "The version of quic-go 
you're using can't be built on Go 1.19 yet. F...) as int value in variable declaration

Copy link
Contributor

Choose a reason for hiding this comment

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

This looks familiar, will need to dig in to figure out what to do. I think we used go 1.18 so far (at least that's what go.mod says).

### Install dependencies and start the DB

1. `dev/up`
Expand Down Expand Up @@ -35,7 +42,7 @@ If you're interested in an **experimental** version of XMTP node software that m

## Deployments

Merging a PR to the `main` branch will trigger a new deployment via Github Actions and Terraform.
Merging a PR to the `main` branch will trigger a new deployment via GitHub Actions and Terraform.

The default behavior is to deploy `main` to both the `dev` and `production` environments. If you'd like to deploy a different branch to `dev`, open a PR with an update to [.github/workflows/deploy.yml](https://github.com/xmtp/xmtp-node-go/blob/main/.github/workflows/deploy.yml#L29) switching from `main` to your branch. Remember to PR it back to `main` when you're done.

Expand Down