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

update tutorial to add devnet #701

Merged
merged 4 commits into from
Oct 9, 2019
Merged

update tutorial to add devnet #701

merged 4 commits into from
Oct 9, 2019

Conversation

ryangyoung
Copy link
Contributor

No description provided.

@ryangyoung ryangyoung requested a review from mDuo13 October 7, 2019 17:25
Copy link
Collaborator

@mDuo13 mDuo13 left a comment

Choose a reason for hiding this comment

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

Would like to see one thing changed before merging this. Otherwise looks good.


1. In your `rippled.cfg` file:

a. Uncomment the following section, as follows:
a. Uncomment the following section and add either the [Testnet or Devnet address](xref: xrp-testnet-faucet.md) (this example uses the Testnet address):
Copy link
Collaborator

Choose a reason for hiding this comment

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

I think it would be better to provide separate samples for each here. Easy to miss "this example uses the Testnet address" if you're skimming.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Separated the example commands there as well in the verification section (step 4).


[ips]
r.altnet.rippletest.net 51235
s.altnet.rippletest.net 51233
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Providing the wss port here but to verify the connection, we use an rpc method. Should we use 51234 here as well?

Copy link
Collaborator

Choose a reason for hiding this comment

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

The port should remain 51235 because the [ips] block wants the Peer protocol port. And using the JSON-RPC port later is correct as well.

Actually, now that I see it, we should update Get Started with the rippled API to use the default port for the Testnet public server (it works; I tested it), which would make it consistent with the other servers.

For reference, there are several ports Ripple tends to use for XRPL servers, some of which are configured by default, including:

  • 51233 - WebSocket over TLS, public (WSS)
    Not enabled in the default config, but configured on Ripple's public servers
  • 51234 - JSON-RPC public (HTTP)
  • 51235 - peer protocol (RTXP)
    The Peer Crawler also uses this port. It uses HTTPS with a self-signed certificate.
  • 5005 - JSON-RPC admin; not exposed for public servers. (HTTP)
  • 6006 - unencrypted WebSocket admin; not exposed for public servers. (WS)
  • 2459 - Newly registered with the IANA as an XRPL port for use with the peer protocol, but not yet in use.
  • 443 - Default TLS port used by most applications when you don't specify what port to connect on; on Ripple's public XRPL servers this accepts encrypted WebSocket traffic. (WSS)
    Basically Ripple's public servers forward this to 51233.
    In other contexts, this is the default port for HTTPS traffic.
    Not enabled in the default config (certificates are necessary).
  • 80 - Incidentally, this is the default port for unencrypted HTTP traffic. Ripple's public XRPL servers don't use it.

I believe it is also possible to configure rippled to speak multiple protocols over the same port, although I haven't experimented with that much myself.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Reverted to 51235. I didn't make the change in the other doc wasn't immediately clear to me where to make the change (plus that should probably be its own PR anyway).


[ips]
r.altnet.rippletest.net 51235
s.altnet.rippletest.net 51233
Copy link
Collaborator

Choose a reason for hiding this comment

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

The port should remain 51235 because the [ips] block wants the Peer protocol port. And using the JSON-RPC port later is correct as well.

Actually, now that I see it, we should update Get Started with the rippled API to use the default port for the Testnet public server (it works; I tested it), which would make it consistent with the other servers.

For reference, there are several ports Ripple tends to use for XRPL servers, some of which are configured by default, including:

  • 51233 - WebSocket over TLS, public (WSS)
    Not enabled in the default config, but configured on Ripple's public servers
  • 51234 - JSON-RPC public (HTTP)
  • 51235 - peer protocol (RTXP)
    The Peer Crawler also uses this port. It uses HTTPS with a self-signed certificate.
  • 5005 - JSON-RPC admin; not exposed for public servers. (HTTP)
  • 6006 - unencrypted WebSocket admin; not exposed for public servers. (WS)
  • 2459 - Newly registered with the IANA as an XRPL port for use with the peer protocol, but not yet in use.
  • 443 - Default TLS port used by most applications when you don't specify what port to connect on; on Ripple's public XRPL servers this accepts encrypted WebSocket traffic. (WSS)
    Basically Ripple's public servers forward this to 51233.
    In other contexts, this is the default port for HTTPS traffic.
    Not enabled in the default config (certificates are necessary).
  • 80 - Incidentally, this is the default port for unencrypted HTTP traffic. Ripple's public XRPL servers don't use it.

I believe it is also possible to configure rippled to speak multiple protocols over the same port, although I haven't experimented with that much myself.


1. In your `rippled.cfg` file:

a. Uncomment the following section, as follows:
a. To connect to the [Testnet](xref: xrp-testnet-faucet.md), uncomment the following section and add:
Copy link
Collaborator

Choose a reason for hiding this comment

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

We don't have the xrefs filter enabled on XRPL.org so this needs to link xrp-testnet-faucet.html instead. (That's why Jenkins is unhappy.)

@mDuo13 mDuo13 merged commit 5c9dbde into master Oct 9, 2019
@mDuo13 mDuo13 deleted the ryangyoung-patch-1 branch October 9, 2019 07:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants