-
Notifications
You must be signed in to change notification settings - Fork 35
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
Apply feedback to Run a Full Node page #253
Changes from 8 commits
2c3327f
8b4320c
b87783a
2ed1c73
a5cef28
57b9d46
331e70f
6fb6279
f3c51ac
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
@@ -0,0 +1,78 @@ | ||||||
# Optimize Your Full Node | ||||||
Optimizing your full node helps keep it online, up to date, and operating quickly. Faster nodes have an advantage over slower nodes because they tend to receive new data first and they minimize the time between placing and resolving orders. Optimize your full node by connecting to trusted nodes, taking precautions against falling out of sync with the network, and configuring storage settings. | ||||||
|
||||||
> Code snippets on this page use example values. Replace them with your own. See the [Network Configuration](../infrastructure_providers-network/network_constants.mdx) section of the documentation for network constants and other resources you need to configure a full node. | ||||||
|
||||||
## Prerequisites | ||||||
You need a running, non-validating full node that is connected to a network. | ||||||
|
||||||
- If you created a system service for your node by following the instructions on the previous page, [Set Up a Full Node](../infrastructure_providers-validators/set_up_full_node.md), start your node with the following command: | ||||||
```bash | ||||||
stystemctl start dydxprotocold | ||||||
``` | ||||||
|
||||||
- To start your node with Cosmovisor or with the `dydxprotocold` binary, you must include the flag `--non-validating-full-node=true`. The flag disables the functionality intended for validator nodes and enables additional logic for reading data. Your CLI may prompt you to configure additional variables in your environment or include them in your command. | ||||||
|
||||||
To start your node with Cosmovisor, run the following command: | ||||||
```bash | ||||||
cosmovisor run start --non-validating-full-node=true | ||||||
``` | ||||||
|
||||||
To start your node with `dydxprotocold`, run the following command: | ||||||
```bash | ||||||
dydxprotocold run start --non-validating-full-node=true | ||||||
``` | ||||||
|
||||||
## Save a List of Trusted Nodes | ||||||
Specify a list of healthy, stable nodes that you trust. Your node prioritizes connecting to those nodes, speeding up the process of connecting or re-connecting to the network. Connecting directly with a peer node is faster than connecting to a seed node and then finding new peers. | ||||||
|
||||||
### Save a List of Persistent Peers | ||||||
You can save a list of healthy, stable nodes in the `persistent_peers` field of your `config.toml` file. | ||||||
|
||||||
Request a list of healthy peers for your deployment from a [Live Peer Node](../infrastructure_providers-network/resources.mdx#live-peer-node-providers) provider. | ||||||
|
||||||
From the list of healthy peers that you retrieve from peer node provider, choose any 5 for your node to query for the latest state. Add a comma-separated list of those peer addresses to the `persistent_peers` field in your `config.toml`, like in the following example: | ||||||
|
||||||
```yaml | ||||||
# config.toml | ||||||
# Example values from Polkachu for dydx-mainnet-1 | ||||||
persistent_peers=83c299de2052db247f08422b6592e1383dd7a104@136.243.36.60:23856,[email protected]:26656,[email protected]:26656,[email protected]:23856,[email protected]:26656 | ||||||
``` | ||||||
|
||||||
### Replace Your Address Book File | ||||||
As an alternative to persistent peers, you can replace your node's local address book with the latest address book from a trusted provider. The address book file contains the latest connection information for peers from that provider. | ||||||
|
||||||
Download an up-to-date `addrbook.json` file for your deployment from an [Address Book](../infrastructure_providers-network/resources.mdx#address-book-providers) provider. | ||||||
|
||||||
Save it in your `/.dydxprotocol/config` directory, replacing the existing `addrbook.json` file. | ||||||
|
||||||
## Prepare to Restore Your Node | ||||||
Prepare to restore your node quickly in case it falls out of sync, minimizing downtime. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. nit / personal preference: will defer to you
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Updating to: To minimize downtime in case your node falls out of sync, make preparations to restore your node quickly. Thought process: starting with "To minimize downtime, ..." is fine, but also ending with "in case it falls out of sync" requires the reader to hold context in mind til the end of the sentence to understand that we're minimizing "out of sync" downtime. Until the end of the sentence, a reader doesn't know what downtime we're talking about |
||||||
|
||||||
Your full node can fall out of sync with the rest of the network for a variety of reasons, including a bad software upgrade, unexpected node crashes, or human operational error. To re-sync with the network, your full node needs to replay the history of the network, which can take a long time. | ||||||
|
||||||
You can speed up the re-syncing process significantly by providing your node with a snapshot. A snapshot contains a compressed copy of the application state at the time the snapshot was taken. If your node falls out of sync, a snapshot allows it to recover to that saved state before replaying the rest of the history of the network, saving you time. | ||||||
|
||||||
### Configure Your Node's State Sync Setting | ||||||
You can use state sync, a configuration setting that allows your node to retrieve a snapshot from the network, to ensure that your node can be restored quickly if it falls out of sync. | ||||||
|
||||||
To use state sync for quick recovery in case your node falls out of sync, follow the instructions for your deployment from a [State Sync](../infrastructure_providers-network/resources.mdx#state-sync-service) service. | ||||||
|
||||||
<!-- | ||||||
Cosmos SDK 0.40 release will include automatic support for state sync, and developers only need to enable it in their applications to make use of it. Replace above with a procedure. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. nit: is this for our note? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This is for me/us -- note to self to revisit this and add a procedure to set this option |
||||||
--> | ||||||
|
||||||
### Save a Snapshot on Your System | ||||||
As an alternative to state sync, you can use a snapshot that you have saved on your node's system to restore your node if it falls out of sync. | ||||||
|
||||||
To save a snapshot on your system for quick recovery in case your node falls out of sync, install a snapshot for your deployment from a [Snapshot Service](../infrastructure_providers-network/resources.mdx#snapshot-service). | ||||||
|
||||||
## Configure a Pruning Strategy | ||||||
In general, dYdX recommends the following pruning setting, configured in your `app.toml` file: | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
||||||
```bash | ||||||
# app.toml | ||||||
pruning = "everything" # 2 latest states will be kept; pruning at 10 block intervals | ||||||
``` | ||||||
|
||||||
However, if you want to use your node to query historical data, configure a custom pruning strategy to retain more states. Retaining more states increases storage requirements. |
|
This file was deleted.
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,3 @@ | ||
Starting in `v5.0.0`, all validating full nodes should be running the [Sidecar](../running_full_node.md#slinky-sidecar). Non validating full nodes do not need to run the sidecar. | ||
Starting in `v5.0.0`, all validating full nodes should be running the [Sidecar](../optimize_full_node.md#slinky-sidecar). Non validating full nodes do not need to run the sidecar. | ||
|
||
Follow instructions [here](https://docs.skip.build/connect/validators/faq#how-do-i-upgrade-the-connect-binary) to upgrade the sidecar. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
for my understanding, does this command not need the
--non-validating-full-node=true
flag?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It does require the flag, but the Set Up a Full Node procedure has you set up a system service that includes the flag already. So this just calls out that if you're coming here from the Next Steps of that procedure, this is how its set up