Skip to content

Commit fdcfd9a

Browse files
committed
Smartnode -> Smart Node
1 parent ef84c83 commit fdcfd9a

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

51 files changed

+92
-97
lines changed

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@
107107

108108
### Added
109109

110-
- Smartnode notification functionality for bounty BA022308 (https://github.com/rocket-pool/smartnode/pull/449)
110+
-Smart Node notification functionality for bounty BA022308 (https://github.com/rocket-pool/smartnode/pull/449)
111111

112112
### Fixed
113113

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,16 +11,16 @@ You can earn a higher return than you would outside the network by capturing an
1111

1212
This repository contains the source code for:
1313

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
1616

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.
1818
See the [Rocket Pool dockerhub](https://hub.docker.com/u/rocketpool) page for a complete list of Docker images.
1919

2020

2121
## Installation
2222

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.
2424

2525
## Development
2626

@@ -48,7 +48,7 @@ A [Makefile](./Makefile) is included for building, testing, and linting.
4848

4949
## CLI Commands
5050

51-
The following commands are available via the Smartnode client:
51+
The following commands are available via the Smart Node client:
5252

5353

5454
### COMMANDS:
@@ -66,7 +66,7 @@ The following commands are available via the Smartnode client:
6666
- `rocketpool minipool status, s` - Get a list of the node's minipools
6767
- `rocketpool minipool stake, t` - Stake a minipool after the scrub check, moving it from prelaunch to staking.
6868
- `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.
7070
- `rocketpool minipool promote, p` - Promote a vacant minipool after the scrub check, completing a solo validator migration.
7171
- `rocketpool minipool refund, r` - Refund ETH belonging to the node from minipools
7272
- `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:
144144
- `rocketpool service start, s` - Start the Rocket Pool service
145145
- `rocketpool service pause, p` - Pause the Rocket Pool service
146146
- `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.
148148
- `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.
149149
- `rocketpool service logs, l` - View the Rocket Pool service logs
150150
- `rocketpool service stats, a` - View the Rocket Pool service stats
@@ -156,7 +156,7 @@ The following commands are available via the Smartnode client:
156156
- `rocketpool service get-config-yaml` - Generate YAML that shows the current configuration schema, including all of the parameters and their descriptions
157157
- `rocketpool service resync-eth1` - Deletes the main ETH1 client's chain data and resyncs it from scratch. Only use this as a last resort!
158158
- `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!
160160
- **wallet**, w - Manage the node wallet
161161
- `rocketpool wallet status, s` - Get the node wallet status
162162
- `rocketpool wallet init, i` - Initialize the node wallet

rocketpool-cli/network/generate-tree.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ func generateRewardsTree(c *cli.Context) error {
3535
// Print archive node info
3636
archiveEcUrl := cfg.Smartnode.ArchiveECUrl.Value.(string)
3737
if archiveEcUrl == "" {
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 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)
3939
} else {
4040
fmt.Printf("%sYou have an archive EC specified at [%s]. This will be used for tree generation.%s\n\n", colorGreen, archiveEcUrl, colorReset)
4141
}

rocketpool-cli/node/commands.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -617,7 +617,7 @@ func RegisterCommands(app *cli.App, name string, aliases []string) {
617617
},
618618
cli.StringFlag{
619619
Name: "mnemonic, m",
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 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.",
621621
},
622622
cli.BoolFlag{
623623
Name: "no-restart",

rocketpool-cli/node/create-vacant-minipool.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -241,7 +241,7 @@ func createVacantMinipool(c *cli.Context, pubkey types.ValidatorPubkey) error {
241241
if c.IsSet("mnemonic") {
242242
mnemonic = c.String("mnemonic")
243243
} else if !c.Bool("yes") {
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, 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.")
245245
fmt.Println()
246246
if prompt.Confirm("Would you like to import your key and automatically migrate your withdrawal credentials?") {
247247
mnemonic = wallet.PromptMnemonic()
@@ -266,7 +266,7 @@ func createVacantMinipool(c *cli.Context, pubkey types.ValidatorPubkey) error {
266266

267267
}
268268

269-
// Import a validator's private key into the Smartnode and set the validator's withdrawal creds
269+
// Import a validator's private key into theSmart Node and set the validator's withdrawal creds
270270
func handleImport(c *cli.Context, rp *rocketpool.Client, minipoolAddress common.Address, mnemonic string) {
271271
// Check if the withdrawal creds can be changed
272272
success := migration.ChangeWithdrawalCreds(rp, minipoolAddress, mnemonic)

rocketpool-cli/node/utils.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -358,7 +358,7 @@ func promptForSoloKeyPassword(rp *rocketpool.Client, cfg *config.RocketPoolConfi
358358
}
359359

360360
if len(pubkeyPasswords) == 0 {
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 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())
362362
}
363363

364364
// Store it in the file

rocketpool-cli/service/commands.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -278,7 +278,7 @@ func RegisterCommands(app *cli.App, name string, aliases []string) {
278278
},
279279
cli.BoolFlag{
280280
Name: "all, a",
281-
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.",
282282
},
283283
},
284284
Action: func(c *cli.Context) error {
@@ -300,7 +300,7 @@ func RegisterCommands(app *cli.App, name string, aliases []string) {
300300
Flags: []cli.Flag{
301301
cli.BoolFlag{
302302
Name: "all, a",
303-
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.",
304304
},
305305
},
306306
Action: func(c *cli.Context) error {
@@ -492,7 +492,7 @@ func RegisterCommands(app *cli.App, name string, aliases []string) {
492492
{
493493
Name: "terminate",
494494
Aliases: []string{"t"},
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 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),
496496
UsageText: "rocketpool service terminate [options]",
497497
Flags: []cli.Flag{
498498
cli.BoolFlag{

rocketpool-cli/service/config/main-display.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ func NewMainDisplay(app *tview.Application, previousConfig *config.RocketPoolCon
5353
grid.SetBackgroundColor(NonInteractiveBackgroundColor)
5454

5555
grid.SetBorder(true).
56-
SetTitle(fmt.Sprintf(" Rocket Pool Smartnode %s Configuration ", shared.RocketPoolVersion())).
56+
SetTitle(fmt.Sprintf(" Rocket PoolSmart Node %s Configuration ", shared.RocketPoolVersion())).
5757
SetBorderColor(tcell.ColorOrange).
5858
SetTitleColor(tcell.ColorOrange).
5959
SetBackgroundColor(NonInteractiveBackgroundColor)

rocketpool-cli/service/config/review-page.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ func NewReviewPage(md *mainDisplay, oldConfig *config.RocketPoolConfig, newConfi
5656
if newConfig.ExecutionClientMode.Value.(cfgtypes.Mode) == cfgtypes.Mode_Local && newConfig.ExecutionClient.Value.(cfgtypes.ExecutionClient) != cfgtypes.ExecutionClient_Geth {
5757
totalAffectedContainers[cfgtypes.ContainerID_Eth1] = true
5858
}
59-
builder.WriteString(fmt.Sprintf("Updated to Smartnode v%s (will affect several containers)\n\n", shared.RocketPoolVersion()))
59+
builder.WriteString(fmt.Sprintf("Updated toSmart Node v%s (will affect several containers)\n\n", shared.RocketPoolVersion()))
6060
}
6161

6262
for categoryName, changedSettingsList := range changedSettings {

rocketpool-cli/service/config/settings-fallback.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ func NewFallbackConfigPage(home *settingsHome) *FallbackConfigPage {
3131
home.homePage,
3232
"settings-fallback",
3333
"Fallback Clients",
34-
"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.",
3535
configPage.layout.grid,
3636
)
3737

0 commit comments

Comments
 (0)