feat(cmd/gnoland): cli implement --home #2355

albttx · 2024-06-13T18:11:36Z

This implement the point 2️⃣ and 4️⃣ in my wishlist (#2102)

This PR implement a new flag --home and remove multiple flags like: --output-path or --data-dir, --config-path which could be confusing while using gnoland binary.

All config is under the directory specified by --home

⚠️ genesis is by default under {{ --home }}/genesis.json 🎉

Examples:

gnoland genesis generate --output-path $GENESIS_FILE

$ gnoland genesis generate
Genesis successfully generated at ./gnoland-data/genesis.json

$ gnoland genesis generate --genesis /tmp/genesis.json                                                                                               ✔
Genesis successfully generated at /tmp/genesis.json

gnoland config set --config-path ./gnoland-data/config/config.toml rpc.laddr "tcp://0.0.0.0:26657"

$ gnoland config set rpc.laddr "tcp://0.0.0.0:26657"

$ gnoland config set  --home ~/gnoland-data rpc.laddr "tcp://0.0.0.0:26657"

codecov · 2024-06-13T18:15:43Z

Codecov Report

Attention: Patch coverage is 84.92063% with 19 lines in your changes missing coverage. Please review.

Project coverage is 54.96%. Comparing base (0e3c050) to head (0458677).
Report is 186 commits behind head on master.

Files with missing lines	Patch %	Lines
gno.land/cmd/gnoland/start.go	66.66%	2 Missing and 3 partials ⚠️
gno.land/cmd/gnoland/genesis_generate.go	40.00%	1 Missing and 2 partials ⚠️
gno.land/cmd/gnoland/config_init.go	60.00%	0 Missing and 2 partials ⚠️
gno.land/cmd/gnoland/config_set.go	66.66%	0 Missing and 1 partial ⚠️
gno.land/cmd/gnoland/genesis_balances_add.go	50.00%	0 Missing and 1 partial ⚠️
gno.land/cmd/gnoland/genesis_balances_remove.go	50.00%	0 Missing and 1 partial ⚠️
gno.land/cmd/gnoland/genesis_txs_add_packages.go	50.00%	0 Missing and 1 partial ⚠️
gno.land/cmd/gnoland/genesis_txs_add_sheet.go	50.00%	0 Missing and 1 partial ⚠️
gno.land/cmd/gnoland/genesis_txs_remove.go	50.00%	0 Missing and 1 partial ⚠️
gno.land/cmd/gnoland/genesis_validator_add.go	50.00%	0 Missing and 1 partial ⚠️
... and 2 more

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #2355      +/-   ##
==========================================
- Coverage   54.99%   54.96%   -0.04%     
==========================================
  Files         595      595              
  Lines       79775    79718      -57     
==========================================
- Hits        43872    43815      -57     
  Misses      32581    32581              
  Partials     3322     3322

Flag	Coverage Δ
contribs/gnodev	`25.65% <ø> (-0.35%)`	⬇️
contribs/gnofaucet	`14.46% <ø> (ø)`
contribs/gnokeykc	`0.00% <ø> (ø)`
contribs/gnomd	`0.00% <ø> (ø)`
gno.land	`63.77% <84.92%> (-0.39%)`	⬇️
gnovm	`60.20% <ø> (ø)`
misc/autocounterd	`0.00% <ø> (ø)`
misc/genproto	`0.00% <ø> (ø)`
misc/genstd	`80.54% <ø> (ø)`
misc/goscan	`0.00% <ø> (ø)`
misc/logos	`17.38% <ø> (ø)`
misc/loop	`0.00% <ø> (ø)`
tm2	`54.46% <ø> (-0.04%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

thehowl

After doing a node deployment myself, I agree this is a good way to go, as for using genesis.json I've had to do quite a bit of a sing and dance to get it working.

cc @sw360cab for his first review :)

thehowl · 2024-06-19T14:20:30Z

gno.land/cmd/gnoland/root.go

+type rootCfg struct {
+	homeDir homeDirectory
+}


please, for flag structs, don't nest them. They can have a helper type like the one you created, but there shouldn't be 3 levels of nesting

I'm not sure to understand how you want it not nested ?

Yeah, I don't know, I had a bit of a think and discussion with Milos and I'm not sure how this should work. cc @zivkovicmilos

I don't like rootCfg 🤷

gno.land/cmd/gnoland/home.go

gno.land/cmd/gnoland/home_test.go

albttx · 2024-07-18T08:22:15Z

@thehowl @zivkovicmilos it's rebased and i fixed your reviews

gno.land/cmd/gnoland/root.go

moul · 2024-07-18T22:47:13Z

gno.land/cmd/gnoland/secrets_verify_test.go

@@ -184,24 +126,24 @@ func TestSecrets_Verify_All_Missing(t *testing.T) {
 			initArgs := []string{
 				"secrets",
 				"init",
-				"--data-dir",
-				tempDir,
+				"--home",


If we use a single flag, I think we should use —data

I believe it could lead to confusions, because the folder contains datas, configurations, secrets...

moul · 2024-07-18T22:50:13Z

tm2/pkg/crypto/keys/client/root.go

@@ -28,7 +28,6 @@ func NewRootCmdWithBaseConfig(io commands.IO, base BaseOptions) *commands.Comman
 			ShortUsage: "<subcommand> [flags] [<arg>...]",
 			LongHelp:   "Manages private keys for the node",
 			Options: []ff.Option{
-				ff.WithConfigFileFlag("config"),


because --config is replaced with --home, which is not a file

moul · 2024-07-18T23:02:58Z

Adding genesis, config, and secret commands to the gnoland command was not the best move. They belong in a separate tool like contribs/gnolandtools, with fewer files involved. Or maybe they should just not exist.

The gnoland binary is meant to be a stable, finished product, not an SDK for running multiple blockchains. We're not going to be tweaking genesis files daily. Gno.land will have its mainnet, testnets, and a local setup that's either lazy or uses the latest snapshot. Other projects might create their own lands, but they won't be using the gnoland binary for that. Most of the configuration will be managed by the chain too.

In other words, 99.9% of people will use lazy or download a ready-to-start state.

Here's what we really need:

A solid --lazy option for easy setup.
A snapshot feature for gnodev. (100x better than gnoland genesis xxx commands)
A reliable editor to patch the genesis file.
Clear documentation and basic tool for managing secret keys.
Keeping gnoland light.

albttx · 2024-07-26T09:17:21Z

@moul I understand what you means, but i really think those commands are required from an ops perspective.

Creating a genesis file for a multi node cluster with gnoland start --lazy -> ctrl+c is just impossible.

You already told me this commands will come in a gno-sdk which i believe could be the right place, maybe for the moment let's keep it inside of the gnoland binary, but once ready, we could move it into this gno-sdk ?

about the rename from --home into --data, i believe it could lead to confusions, because the folder contains datas, configurations, secrets...

github-actions · 2024-11-12T01:58:10Z

This PR is stale because it has been open 3 months with no activity. Remove stale label or comment or this will be closed in 3 months.

albttx self-assigned this Jun 13, 2024

albttx requested review from jaekwon, moul, gfanton, zivkovicmilos and a team as code owners June 13, 2024 18:11

github-actions bot added 📦 🌐 tendermint v2 Issues or PRs tm2 related 📦 ⛰️ gno.land Issues or PRs gno.land package related labels Jun 13, 2024

thehowl reviewed Jun 19, 2024

View reviewed changes

thehowl requested a review from sw360cab June 19, 2024 14:23

thehowl reviewed Jun 20, 2024

View reviewed changes

gno.land/cmd/gnoland/home_test.go Outdated Show resolved Hide resolved

Kouteki mentioned this pull request Jun 26, 2024

Minutes: Core Staff Weekly Syncs [every Monday] gnolang/meetings#36

Open

albttx force-pushed the dash-dash-home branch from 3b30d90 to bd22852 Compare July 17, 2024 13:39

moul reviewed Jul 18, 2024

View reviewed changes

gno.land/cmd/gnoland/root.go Outdated Show resolved Hide resolved

moul reviewed Jul 18, 2024

View reviewed changes

albttx added 9 commits July 26, 2024 10:19

feat(cmd/gnoland): cli implement --home

8b7af36

chore: make fmt

c4658af

fix: lint

45aea8f

chore: move homeDirectory into root.go

36ae274

fix: test

b566e15

fix: gno secrets tests

56e13ac

chore: make lint

4174199

chore: home_test -> root_test

1a974aa

chore: use filepath.Join

0458677

albttx force-pushed the dash-dash-home branch from debb738 to 0458677 Compare July 26, 2024 09:24

github-actions bot added Stale and removed Stale labels Nov 12, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(cmd/gnoland): cli implement --home #2355

feat(cmd/gnoland): cli implement --home #2355

albttx commented Jun 13, 2024 •

edited

Loading

codecov bot commented Jun 13, 2024 •

edited

Loading

thehowl left a comment

thehowl Jun 19, 2024

albttx Jun 20, 2024

thehowl Jun 20, 2024

albttx commented Jul 18, 2024

moul Jul 18, 2024

albttx Jul 26, 2024

moul Jul 18, 2024

albttx Jul 26, 2024

moul commented Jul 18, 2024

albttx commented Jul 26, 2024

github-actions bot commented Nov 12, 2024

feat(cmd/gnoland): cli implement --home #2355

Are you sure you want to change the base?

feat(cmd/gnoland): cli implement --home #2355

Conversation

albttx commented Jun 13, 2024 • edited Loading

Examples:

codecov bot commented Jun 13, 2024 • edited Loading

Codecov Report

thehowl left a comment

Choose a reason for hiding this comment

thehowl Jun 19, 2024

Choose a reason for hiding this comment

albttx Jun 20, 2024

Choose a reason for hiding this comment

thehowl Jun 20, 2024

Choose a reason for hiding this comment

albttx commented Jul 18, 2024

moul Jul 18, 2024

Choose a reason for hiding this comment

albttx Jul 26, 2024

Choose a reason for hiding this comment

moul Jul 18, 2024

Choose a reason for hiding this comment

albttx Jul 26, 2024

Choose a reason for hiding this comment

moul commented Jul 18, 2024

albttx commented Jul 26, 2024

github-actions bot commented Nov 12, 2024

albttx commented Jun 13, 2024 •

edited

Loading

codecov bot commented Jun 13, 2024 •

edited

Loading