Skip to content

chore: correct config name #2636

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

Merged
tac0turtle merged 1 commit into from
Sep 9, 2025
Merged

chore: correct config name #2636

Show file tree
Hide file tree
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
4 changes: 2 additions & 2 deletions apps/evm/single/cmd/init.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import (
rollgenesis "github.com/evstack/ev-node/pkg/genesis"
)

// InitCmd initializes a new evolve.yaml file in the current directory
// InitCmd initializes a new evnode.yml file in the current directory
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot Sep 9, 2025

Choose a reason for hiding this comment

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

high

There's an inconsistency in the configuration file naming. While this comment and other user-facing strings in this PR are updated to evnode.yml, the rollconf.ConfigName constant used programmatically (e.g., in the Long description on line 19) resolves to evnode.yaml. This is because ConfigExtension in pkg/config/defaults.go is still yaml. This discrepancy exists across multiple files and will cause confusion. To resolve this, ConfigExtension in pkg/config/defaults.go should be changed to yml.

func InitCmd() *cobra.Command {
initCmd := &cobra.Command{
Use: "init",
Expand Down Expand Up @@ -47,7 +47,7 @@ func InitCmd() *cobra.Command {
}

if err := cfg.SaveAsYaml(); err != nil {
return fmt.Errorf("error writing evolve.yaml file: %w", err)
return fmt.Errorf("error writing evnode.yml file: %w", err)
}

if err := rollcmd.LoadOrGenNodeKey(homePath); err != nil {
Expand Down
2 changes: 1 addition & 1 deletion apps/grpc/single/cmd/init.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ This will create the necessary configuration structure in the specified root dir
}

if err := cfg.SaveAsYaml(); err != nil {
return fmt.Errorf("error writing evolve.yaml file: %w", err)
return fmt.Errorf("error writing evnode.yml file: %w", err)
}

if err := rollcmd.LoadOrGenNodeKey(homePath); err != nil {
Expand Down
4 changes: 2 additions & 2 deletions apps/testapp/cmd/init.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import (
rollgenesis "github.com/evstack/ev-node/pkg/genesis"
)

// InitCmd initializes a new evolve.yaml file in the current directory
// InitCmd initializes a new evnode.yml file in the current directory
func InitCmd() *cobra.Command {
initCmd := &cobra.Command{
Use: "init",
Expand Down Expand Up @@ -47,7 +47,7 @@ func InitCmd() *cobra.Command {
}

if err := cfg.SaveAsYaml(); err != nil {
return fmt.Errorf("error writing evolve.yaml file: %w", err)
return fmt.Errorf("error writing evnode.yml file: %w", err)
}

if err := rollcmd.LoadOrGenNodeKey(homePath); err != nil {
Expand Down
2 changes: 1 addition & 1 deletion apps/testapp/cmd/init_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ func TestInitCommand(t *testing.T) {
// Change to the temporary directory
require.NoError(t, os.Chdir(dir))

// Remove any existing evolve.yaml files in the test directory
// Remove any existing evnode.yml files in the test directory
configPath := filepath.Join(dir, "config", rollconf.ConfigName)
_ = os.Remove(configPath) // Ignore error if file doesn't exist

Expand Down
4 changes: 2 additions & 2 deletions docs/guides/da/visualizer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ testapp start --rollkit.rpc.enable_da_visualization

### Via Configuration File

Add the following to your `evolve.yaml` configuration file:
Add the following to your `evnode.yml` configuration file:

```yaml
rpc:
Expand Down Expand Up @@ -164,7 +164,7 @@ When enabling the DA Visualizer, you may want to adjust related RPC settings:

```yaml
rpc:
address: "0.0.0.0:7331" # Bind to all interfaces for remote access
address: "0.0.0.0:7331" # Bind to all interfaces for remote access
enable_da_visualization: true
```

Expand Down
10 changes: 5 additions & 5 deletions docs/guides/reset-state.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ By definition, resetting the state is deleting your chain's data. Make sure you

Some reason you might need to reset the state of your chain are:

* During testing and development
* During upgrades with breaking changes
* Hardforks
- During testing and development
- During upgrades with breaking changes
- Hardforks

## Prerequisites

Expand All @@ -28,7 +28,7 @@ tree $HOME/.testapp
├── config
│   ├── genesis.json
│   ├── node_key.json
│   ├── evolve.yaml
│   ├── evnode.yml
│   └── signer.json
└── data
├── cache
Expand Down Expand Up @@ -90,7 +90,7 @@ tree $HOME/.gm
│   │   └── gentx-418077c64f0cf5824c24487c9cce38241de677cd.json
│   ├── node_key.json
│   ├── priv_validator_key.json
│   └── evolve.yaml
│   └── evnode.yml
├── data
│   ├── application.db
│   │   ├── 000001.log
Expand Down
2 changes: 1 addition & 1 deletion docs/learn/config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ When running in DA-only mode, the node will:

## Configs

Evolve configurations can be managed through a YAML file (typically `evolve.yaml` located in `~/.evolve/config/` or `<your_home_dir>/config/`) and command-line flags. The system prioritizes configurations in the following order (highest priority first):
Evolve configurations can be managed through a YAML file (typically `evnode.yml` located in `~/.evolve/config/` or `<your_home_dir>/config/`) and command-line flags. The system prioritizes configurations in the following order (highest priority first):
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot Sep 9, 2025

Choose a reason for hiding this comment

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

medium

Good catch updating the config file name here. However, another instance of an old config name was missed nearby. On line 99, config.yaml should also be updated to evnode.yml for consistency.


1. **Command-line flags:** Override all other settings.
2. **YAML configuration file:** Values specified in the `config.yaml` file.
Expand Down
2 changes: 1 addition & 1 deletion pkg/config/yaml.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ func (d *DurationWrapper) UnmarshalText(text []byte) error {
return err
}

// ErrReadYaml is the error returned when reading the evolve.yaml file fails.
// ErrReadYaml is the error returned when reading the evnode.yml file fails.
var ErrReadYaml = fmt.Errorf("reading %s", ConfigName)

// SaveAsYaml saves the current configuration to a YAML file.
Expand Down
Loading