You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,16 +11,16 @@ You can earn a higher return than you would outside the network by capturing an
11
11
12
12
This repository contains the source code for:
13
13
14
-
* The Rocket Pool Smartnode client (CLI), which is used to manage a smart node either locally or remotely (over SSH)
15
-
* The Rocket Pool Smartnode service, which provides an API for client communication and performs background node tasks
14
+
* The Rocket Pool Smart Node client (CLI), which is used to manage a smart node either locally or remotely (over SSH)
15
+
* The Rocket Pool Smart Node service, which provides an API for client communication and performs background node tasks
16
16
17
-
The Smartnode service is designed to be run as part of a Docker stack and generally does not need to be installed manually.
17
+
The Smart Node service is designed to be run as part of a Docker stack and generally does not need to be installed manually.
18
18
See the [Rocket Pool dockerhub](https://hub.docker.com/u/rocketpool) page for a complete list of Docker images.
19
19
20
20
21
21
## Installation
22
22
23
-
See the [Smartnode Installer](https://github.com/rocket-pool/smartnode-install) repository for supported platforms and installation instructions.
23
+
See the [Smart Node Installer](https://github.com/rocket-pool/smartnode-install) repository for supported platforms and installation instructions.
24
24
25
25
## Development
26
26
@@ -48,7 +48,7 @@ A [Makefile](./Makefile) is included for building, testing, and linting.
48
48
49
49
## CLI Commands
50
50
51
-
The following commands are available via the Smartnode client:
51
+
The following commands are available via the Smart Node client:
52
52
53
53
54
54
### COMMANDS:
@@ -66,7 +66,7 @@ The following commands are available via the Smartnode client:
66
66
-`rocketpool minipool status, s` - Get a list of the node's minipools
67
67
-`rocketpool minipool stake, t` - Stake a minipool after the scrub check, moving it from prelaunch to staking.
68
68
-`rocketpool minipool set-withdrawal-creds, swc` - Convert the withdrawal credentials for a migrated solo validator from the old 0x00 value to the minipool address. Required to complete the migration process.
69
-
-`rocketpool minipool import-key, ik` - Import the externally-derived key for a minipool that was previously a solo validator, so the Smartnode's VC manages it instead of your externally-managed VC.
69
+
-`rocketpool minipool import-key, ik` - Import the externally-derived key for a minipool that was previously a solo validator, so the Smart Node's VC manages it instead of your externally-managed VC.
70
70
-`rocketpool minipool promote, p` - Promote a vacant minipool after the scrub check, completing a solo validator migration.
71
71
-`rocketpool minipool refund, r` - Refund ETH belonging to the node from minipools
72
72
-`rocketpool minipool begin-bond-reduction, bbr` - Begins the ETH bond reduction process for a minipool, taking it from 16 ETH down to 8 ETH (begins conversion of a 16 ETH minipool to an LEB8)
@@ -144,7 +144,7 @@ The following commands are available via the Smartnode client:
144
144
-`rocketpool service start, s` - Start the Rocket Pool service
145
145
-`rocketpool service pause, p` - Pause the Rocket Pool service
146
146
-`rocketpool service stop, o` - Pause the Rocket Pool service (alias of 'rocketpool service pause')
147
-
-`rocketpool service reset-docker, rd` - Cleanup Docker resources, including stopped containers, unused images and networks. Stops and restarts Smartnode.
147
+
-`rocketpool service reset-docker, rd` - Cleanup Docker resources, including stopped containers, unused images and networks. Stops and restarts Smart Node.
148
148
-`rocketpool service prune-docker, pd` - Cleanup unused Docker resources, including stopped containers, unused images, networks and volumes. Does not restart smartnode, so the running containers and the images and networks they reference will not be pruned.
149
149
-`rocketpool service logs, l` - View the Rocket Pool service logs
150
150
-`rocketpool service stats, a` - View the Rocket Pool service stats
@@ -156,7 +156,7 @@ The following commands are available via the Smartnode client:
156
156
-`rocketpool service get-config-yaml` - Generate YAML that shows the current configuration schema, including all of the parameters and their descriptions
157
157
-`rocketpool service resync-eth1` - Deletes the main ETH1 client's chain data and resyncs it from scratch. Only use this as a last resort!
158
158
-`rocketpool service resync-eth2` - Deletes the ETH2 client's chain data and resyncs it from scratch. Only use this as a last resort!
159
-
-`rocketpool service terminate, t` - Deletes all of the Rocket Pool Docker containers and volumes, including your ETH1 and ETH2 chain data and your Prometheus database (if metrics are enabled). Only use this if you are cleaning up the Smartnode and want to start over!
159
+
-`rocketpool service terminate, t` - Deletes all of the Rocket Pool Docker containers and volumes, including your ETH1 and ETH2 chain data and your Prometheus database (if metrics are enabled). Only use this if you are cleaning up the Smart Node and want to start over!
160
160
-**wallet**, w - Manage the node wallet
161
161
-`rocketpool wallet status, s` - Get the node wallet status
162
162
-`rocketpool wallet init, i` - Initialize the node wallet
fmt.Printf("%sNOTE: in order to generate a Merkle rewards tree for a past rewards interval, you will likely need to have access to an Execution client with archival state.\nBy default, your Smartnode's Execution client will not provide this.\n\nPlease specify the URL of an archive-capable EC in the Smartnode section of the `rocketpool service config` Terminal UI.\nIf you need one, Alchemy provides a free service which you can use: https://www.alchemy.com/ethereum%s\n\n", colorYellow, colorReset)
38
+
fmt.Printf("%sNOTE: in order to generate a Merkle rewards tree for a past rewards interval, you will likely need to have access to an Execution client with archival state.\nBy default, your Smartnode's Execution client will not provide this.\n\nPlease specify the URL of an archive-capable EC in theSmart Node section of the `rocketpool service config` Terminal UI.\nIf you need one, Alchemy provides a free service which you can use: https://www.alchemy.com/ethereum%s\n\n", colorYellow, colorReset)
39
39
} else {
40
40
fmt.Printf("%sYou have an archive EC specified at [%s]. This will be used for tree generation.%s\n\n", colorGreen, archiveEcUrl, colorReset)
Usage: "Use this flag if you want to recreate your validator's private key within the Smartnode's VC instead of running it via your own VC, and have the Smartnode reassign your validator's withdrawal credentials to the new minipool address automatically.",
620
+
Usage: "Use this flag if you want to recreate your validator's private key within the Smartnode's VC instead of running it via your own VC, and have theSmart Node reassign your validator's withdrawal credentials to the new minipool address automatically.",
fmt.Println("You have the option of importing your validator's private key into the Smartnode's Validator Client instead of running your own Validator Client separately. In doing so, the Smartnode will also automatically migrate your validator's withdrawal credentials from your BLS private key to the minipool you just created.")
244
+
fmt.Println("You have the option of importing your validator's private key into the Smartnode's Validator Client instead of running your own Validator Client separately. In doing so, theSmart Node will also automatically migrate your validator's withdrawal credentials from your BLS private key to the minipool you just created.")
245
245
fmt.Println()
246
246
ifprompt.Confirm("Would you like to import your key and automatically migrate your withdrawal credentials?") {
return"", fmt.Errorf("couldn't find the keystore for validator %s in the custom-keys directory; if you want to import this key into the Smartnode stack, you will need to put its keystore file into custom-keys first", pubkey.String())
361
+
return"", fmt.Errorf("couldn't find the keystore for validator %s in the custom-keys directory; if you want to import this key into theSmart Node stack, you will need to put its keystore file into custom-keys first", pubkey.String())
Usage: "Removes all Docker images, including those currently used by the Smartnode stack. This will force a full re-download of all images when the Smartnode is restarted.",
281
+
Usage: "Removes all Docker images, including those currently used by theSmart Node stack. This will force a full re-download of all images when theSmart Node is restarted.",
Usage: "Removes all Docker images, including those currently used by the Smartnode stack. This will force a full re-download of all images when the Smartnode is restarted.",
303
+
Usage: "Removes all Docker images, including those currently used by theSmart Node stack. This will force a full re-download of all images when theSmart Node is restarted.",
Usage: fmt.Sprintf("%sDeletes all of the Rocket Pool Docker containers and volumes, including your ETH1 and ETH2 chain data and your Prometheus database (if metrics are enabled). Also removes your entire `.rocketpool` configuration folder, including your wallet, password, and validator keys. Only use this if you are cleaning up the Smartnode and want to start over!%s", colorRed, colorReset),
495
+
Usage: fmt.Sprintf("%sDeletes all of the Rocket Pool Docker containers and volumes, including your ETH1 and ETH2 chain data and your Prometheus database (if metrics are enabled). Also removes your entire `.rocketpool` configuration folder, including your wallet, password, and validator keys. Only use this if you are cleaning up theSmart Node and want to start over!%s", colorRed, colorReset),
496
496
UsageText: "rocketpool service terminate [options]",
"Select this to manage a separate pair of externally-managed Execution and Consensus clients that the Smartnode and Validator Client will use if your main Execution or Consensus clients ever go offline.",
34
+
"Select this to manage a separate pair of externally-managed Execution and Consensus clients that theSmart Node and Validator Client will use if your main Execution or Consensus clients ever go offline.",
0 commit comments