feat: parse home flag earlier (backport #20771)

client/v2/CHANGELOG.md

@@ -36,6 +36,10 @@ Ref: https://keepachangelog.com/en/1.0.0/
 
 ## [Unreleased]
 
+### Features
+
+* [#20771](https://github.com/cosmos/cosmos-sdk/pull/20771) Add `GetNodeHomeDirectory` helper in `client/v2/helpers`.
+
 ## [v2.0.0-beta.2] - 2024-06-19
 
 ### Features
@@ -50,7 +54,7 @@ Ref: https://keepachangelog.com/en/1.0.0/
 * [#20083](https://github.com/cosmos/cosmos-sdk/pull/20083) Integrate latest version of cosmos-proto and improve version filtering.
 * [#19618](https://github.com/cosmos/cosmos-sdk/pull/19618) Marshal enum as string in queries.
 * [#19060](https://github.com/cosmos/cosmos-sdk/pull/19060) Use client context from root (or enhanced) command in autocli commands.
- * Note, the given command must have a `client.Context` in its context.
+  * Note, the given command must have a `client.Context` in its context.
 * [#19216](https://github.com/cosmos/cosmos-sdk/pull/19216) Do not overwrite TxConfig, use directly the one provided in context. TxConfig should always be set in the `client.Context` in `root.go` of an app.
 * [#20266](https://github.com/cosmos/cosmos-sdk/pull/20266) Add ability to override the short description in AutoCLI-generated top-level commands.
 

client/v2/helpers/home.go

@@ -0,0 +1,36 @@
+package helpers
+
+import (
+ "os"
+ "path/filepath"
+ "strings"
+)
+
+// GetNodeHomeDirectory gets the home directory of the node (where the config is located).
+// It parses the home flag if set if the `NODE_HOME` environment variable if set (and ignores name).
+// Otherwise, it returns the default home directory given its name.
+func GetNodeHomeDirectory(name string) (string, error) {
+ // get the home directory from the flag
+ args := os.Args
+ for i := 0; i < len(args); i++ {
+ if args[i] == "--home" && i+1 < len(args) {
+ return filepath.Clean(args[i+1]), nil
+ } else if strings.HasPrefix(args[i], "--home=") {
+ return filepath.Clean(args[i][7:]), nil
+ }
+ }
+
+ // get the home directory from the environment variable
+ homeDir := os.Getenv("NODE_HOME")
+ if homeDir != "" {
+ return filepath.Clean(homeDir), nil
+ }
+
+ // return the default home directory
+ userHomeDir, err := os.UserHomeDir()
+ if err != nil {
+ return "", err
+ }
+
+ return filepath.Join(userHomeDir, name), nil
+}

docs/docs/learn/advanced/07-cli.md

@@ -153,7 +153,7 @@ Flags are added to commands directly (generally in the [module's CLI file](../..
 
 ## Environment variables
 
-Each flag is bound to its respective named environment variable. Then name of the environment variable consist of two parts - capital case `basename` followed by flag name of the flag. `-` must be substituted with `_`. For example flag `--home` for application with basename `GAIA` is bound to `GAIA_HOME`. It allows reducing the amount of flags typed for routine operations. For example instead of:
+Each flag is bound to its respective named environment variable. Then name of the environment variable consist of two parts - capital case `basename` followed by flag name of the flag. `-` must be substituted with `_`. For example flag `--node` for application with basename `GAIA` is bound to `GAIA_NODE`. It allows reducing the amount of flags typed for routine operations. For example instead of:
 
 ```shell
 gaia --home=./ --node=<node address> --chain-id="testchain-1" --keyring-backend=test tx ... --from=<key name>
@@ -163,7 +163,7 @@ this will be more convenient:
 
 ```shell
 # define env variables in .env, .envrc etc
-GAIA_HOME=<path to home>
+NODE_HOME=<path to home>
 GAIA_NODE=<node address>
 GAIA_CHAIN_ID="testchain-1"
 GAIA_KEYRING_BACKEND="test"

scripts/init-simapp.sh

@@ -4,7 +4,7 @@ SIMD_BIN=${SIMD_BIN:=$(which simd 2>/dev/null)}
 
 if [ -z "$SIMD_BIN" ]; then echo "SIMD_BIN is not set. Make sure to run make install before"; exit 1; fi
 echo "using $SIMD_BIN"
-if [ -d "$($SIMD_BIN config home)" ]; then rm -r $($SIMD_BIN config home); fi
+if [ -d "$($SIMD_BIN config home)" ]; then rm -rv $($SIMD_BIN config home); fi
 $SIMD_BIN config set client chain-id demo
 $SIMD_BIN config set client keyring-backend test
 $SIMD_BIN config set app api.enable true

simapp/app.go

@@ -7,11 +7,11 @@ import (
  "fmt"
  "io"
  "os"
- "path/filepath"
 
  autocliv1 "cosmossdk.io/api/cosmos/autocli/v1"
  reflectionv1 "cosmossdk.io/api/cosmos/reflection/v1"
  "cosmossdk.io/client/v2/autocli"
+ clienthelpers "cosmossdk.io/client/v2/helpers"
  "cosmossdk.io/core/appmodule"
  "cosmossdk.io/log"
  storetypes "cosmossdk.io/store/types"
@@ -178,12 +178,11 @@ type SimApp struct {
 }
 
 func init() {
- userHomeDir, err := os.UserHomeDir()
+ var err error
+ DefaultNodeHome, err = clienthelpers.GetNodeHomeDirectory(".simapp")
  if err != nil {
  panic(err)
  }
-
- DefaultNodeHome = filepath.Join(userHomeDir, ".simapp")
 }
 
 // NewSimApp returns a reference to an initialized SimApp.

simapp/app_v2.go

@@ -4,11 +4,10 @@ package simapp
 
 import (
  "io"
- "os"
- "path/filepath"
 
  dbm "github.com/cosmos/cosmos-db"
 
+ clienthelpers "cosmossdk.io/client/v2/helpers"
  "cosmossdk.io/depinject"
  "cosmossdk.io/log"
  storetypes "cosmossdk.io/store/types"
@@ -89,12 +88,11 @@ type SimApp struct {
 }
 
 func init() {
- userHomeDir, err := os.UserHomeDir()
+ var err error
+ DefaultNodeHome, err = clienthelpers.GetNodeHomeDirectory(".simapp")
  if err != nil {
  panic(err)
  }
-
- DefaultNodeHome = filepath.Join(userHomeDir, ".simapp")
 }
 
 // NewSimApp returns a reference to an initialized SimApp.

simapp/go.mod

@@ -4,7 +4,7 @@ go 1.21
 
 require (
  cosmossdk.io/api v0.7.5
- cosmossdk.io/client/v2 v2.0.0-beta.1.0.20240619200301-495e6d11c307
+ cosmossdk.io/client/v2 v2.0.0-beta.2.0.20240625194835-17173894fea9 // TODO(@julienrbrt): tag client/v2
  cosmossdk.io/collections v0.4.0 // indirect
  cosmossdk.io/core v0.11.0
  cosmossdk.io/depinject v1.0.0-alpha.4
@@ -17,7 +17,7 @@ require (
  cosmossdk.io/x/feegrant v0.1.1
  cosmossdk.io/x/nft v0.1.1
  cosmossdk.io/x/tx v0.13.3
- cosmossdk.io/x/upgrade v0.1.2
+ cosmossdk.io/x/upgrade v0.1.4-0.20240625194835-17173894fea9 // TODO(@julienrbrt): tag upgrade
  github.com/cometbft/cometbft v0.38.7
  github.com/cosmos/cosmos-db v1.0.2
  // this version is not used as it is always replaced by the latest Cosmos SDK version
@@ -27,17 +27,17 @@ require (
  github.com/spf13/cast v1.6.0
  github.com/spf13/cobra v1.8.0
  github.com/spf13/pflag v1.0.5
- github.com/spf13/viper v1.18.2
+ github.com/spf13/viper v1.19.0
  github.com/stretchr/testify v1.9.0
  google.golang.org/protobuf v1.33.0
 )
 
 require (
- cloud.google.com/go v0.112.0 // indirect
+ cloud.google.com/go v0.112.1 // indirect
  cloud.google.com/go/compute v1.24.0 // indirect
  cloud.google.com/go/compute/metadata v0.2.3 // indirect
  cloud.google.com/go/iam v1.1.6 // indirect
- cloud.google.com/go/storage v1.36.0 // indirect
+ cloud.google.com/go/storage v1.38.0 // indirect
  cosmossdk.io/errors v1.0.1 // indirect
  filippo.io/edwards25519 v1.0.0 // indirect
  github.com/99designs/go-keychain v0.0.0-20191008050251-8e49817e8af4 // indirect
@@ -102,15 +102,15 @@ require (
  github.com/google/s2a-go v0.1.7 // indirect
  github.com/google/uuid v1.6.0 // indirect
  github.com/googleapis/enterprise-certificate-proxy v0.3.2 // indirect
- github.com/googleapis/gax-go/v2 v2.12.0 // indirect
+ github.com/googleapis/gax-go/v2 v2.12.3 // indirect
  github.com/gorilla/handlers v1.5.1 // indirect
  github.com/gorilla/mux v1.8.0 // indirect
  github.com/gorilla/websocket v1.5.0 // indirect
  github.com/grpc-ecosystem/go-grpc-middleware v1.4.0 // indirect
  github.com/grpc-ecosystem/grpc-gateway v1.16.0 // indirect
  github.com/gsterjov/go-libsecret v0.0.0-20161001094733-a6f4afe4910c // indirect
  github.com/hashicorp/go-cleanhttp v0.5.2 // indirect
- github.com/hashicorp/go-getter v1.7.3 // indirect
+ github.com/hashicorp/go-getter v1.7.4 // indirect
  github.com/hashicorp/go-hclog v1.5.0 // indirect
  github.com/hashicorp/go-immutable-radix v1.3.1 // indirect
  github.com/hashicorp/go-metrics v0.5.3 // indirect
@@ -144,7 +144,7 @@ require (
  github.com/mtibben/percent v0.2.1 // indirect
  github.com/oasisprotocol/curve25519-voi v0.0.0-20230904125328-1f23a7beb09a // indirect
  github.com/oklog/run v1.1.0 // indirect
- github.com/pelletier/go-toml/v2 v2.1.0 // indirect
+ github.com/pelletier/go-toml/v2 v2.2.2 // indirect
  github.com/petermattis/goid v0.0.0-20231207134359-e60b3f734c67 // indirect
  github.com/pkg/errors v0.9.1 // indirect
  github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2 // indirect
@@ -170,11 +170,11 @@ require (
  github.com/zondax/ledger-go v0.14.3 // indirect
  go.etcd.io/bbolt v1.3.8 // indirect
  go.opencensus.io v0.24.0 // indirect
- go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc v0.47.0 // indirect
- go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp v0.47.0 // indirect
- go.opentelemetry.io/otel v1.22.0 // indirect
- go.opentelemetry.io/otel/metric v1.22.0 // indirect
- go.opentelemetry.io/otel/trace v1.22.0 // indirect
+ go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc v0.49.0 // indirect
+ go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp v0.49.0 // indirect
+ go.opentelemetry.io/otel v1.24.0 // indirect
+ go.opentelemetry.io/otel/metric v1.24.0 // indirect
+ go.opentelemetry.io/otel/trace v1.24.0 // indirect
  go.uber.org/multierr v1.10.0 // indirect
  golang.org/x/crypto v0.22.0 // indirect
  golang.org/x/exp v0.0.0-20240404231335-c0f41cb1a7a0 // indirect
@@ -185,10 +185,10 @@ require (
  golang.org/x/term v0.19.0 // indirect
  golang.org/x/text v0.14.0 // indirect
  golang.org/x/time v0.5.0 // indirect
- google.golang.org/api v0.162.0 // indirect
+ google.golang.org/api v0.171.0 // indirect
  google.golang.org/appengine v1.6.8 // indirect
  google.golang.org/genproto v0.0.0-20240227224415-6ceb2ff114de // indirect
- google.golang.org/genproto/googleapis/api v0.0.0-20240227224415-6ceb2ff114de // indirect
+ google.golang.org/genproto/googleapis/api v0.0.0-20240311132316-a219d84964c2 // indirect
  google.golang.org/genproto/googleapis/rpc v0.0.0-20240401170217-c3f982113cda // indirect
  google.golang.org/grpc v1.63.2 // indirect
  gopkg.in/ini.v1 v1.67.0 // indirect