feat: add autocli multi-chain command #14696
Conversation
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
github-prbot
requested review from
a team,
kocubinski and
julienrbrt
and removed request for
a team
Sure tools/cosmcli? What about the rest of client/v2? The only issue is that I don't think we need a separate go.mod's for cosmcli |
I could be wrong, will read the pr more in depth to understand the overlap between the two. |
I agree, all the remote stuff and cosmcli makes more sense to be extracted as specific tool. I don't think it is supposed to be re-used anyway.
lgtm
I think we should still have a go.mod so it is not tied to the SDK. All tools are standalone. Dependabot will bump the lib in the tool anytime needed. This allows to iterate on the tool without needed to bump client/v2 all the time as well. |
|
There is currently no code in cosmcli besides client/v2, it is a thin wrapper. Maybe we can extract the remote code, but to me it feels like that just adds versioning complexity... But I guess there could be benefits in separating the two |
|
Actually maybe it's fine to pull out the remote code. It's not meant to be reusable really |
|
Do people like the name cosmcli? Or maybe just cosmoscli which is longer but doesn't try to be cute? |
|
what about hubl, its a play on spelling for the Hubble telescope (random thought) |
|
I refactored the remote code to |
Hubl is kinda fancy, I like it too personally. |
There was a problem hiding this comment.
tACK with Evmos.
It takes a bit of times to get use to it, as everything is a flag and not an argument (compared to the classic cli). But it is super cool!! 👍🏾
Occasionally, I as well get a not found error but it makes sense as it is not a normal account. It works well with Umee, and the rest.
cosmcli evmos query auth account --address evmos1fooo
Error: proto: google.protobuf.Any: unable to resolve "/ethermint.types.v1.EthAccount": not foundOne improvement I can think for a follow-up of is not to have default value, which is a bit confusing: e.g.
$ cosmcli evmos query auth account-address-by-id
{
"account_address": "evmos1rtj2r4eaz0v68mxjt5jleynm85yjfu2uxm7pxx"
}
cosmcli evmos query auth account-address-by-id --id 0
{
"account_address": "evmos1rtj2r4eaz0v68mxjt5jleynm85yjfu2uxm7pxx"
}
We can customize this in the future by adding autocli options to modules
This is because we're using gRPC reflection which as far as I can tell provides no way to pull the full
Yeah, that's an interesting edge case we should addres. Can you open an issue and add to the autocli epic @julienrbrt ? |
| for _, descriptorProto := range fdMap { | ||
| for _, dep := range descriptorProto.Dependency { | ||
| if fdMap[dep] == nil && !cantFind[dep] /* skip deps we've marked as can't find */ { | ||
| missing = append(missing, dep) | ||
| } | ||
| } | ||
| } |
Check failure
Code scanning / gosec
the value in the range statement should be _ unless copying a map: want: for key := range m
| for _, descriptorProto := range fdMap { | ||
| fdSet.File = append(fdSet.File, descriptorProto) | ||
| } |
Check failure
Code scanning / gosec
the value in the range statement should be _ unless copying a map: want: for key := range m
| for chain, chainConfig := range config.Chains { | ||
| chainInfo := NewChainInfo(configDir, chain, chainConfig) | ||
| err = chainInfo.Load(false) | ||
| if err != nil { | ||
| cmd.AddCommand(&cobra.Command{ | ||
| Use: chain, | ||
| Short: "Unable to load data", | ||
| Long: "Unable to load data, reconfiguration needed.", | ||
| RunE: func(cmd *cobra.Command, args []string) error { | ||
| fmt.Printf("Error loading chain data for %s: %+v\n", chain, err) | ||
| return reconfigure(configDir, chain, config) | ||
| }, | ||
| }) | ||
| continue | ||
| } | ||
|
|
||
| appOpts := autocli.AppOptions{ | ||
| ModuleOptions: chainInfo.ModuleOptions, | ||
| } | ||
|
|
||
| builder := &autocli.Builder{ | ||
| Builder: flag.Builder{ | ||
| TypeResolver: &dynamicTypeResolver{chainInfo}, | ||
| FileResolver: chainInfo.ProtoFiles, | ||
| }, | ||
| GetClientConn: func(command *cobra.Command) (grpc.ClientConnInterface, error) { | ||
| return chainInfo.OpenClient() | ||
| }, | ||
| AddQueryConnFlags: func(command *cobra.Command) {}, | ||
| } | ||
|
|
||
| var update bool | ||
| var reconfig bool | ||
| chainCmd := &cobra.Command{ | ||
| Use: chain, | ||
| Short: fmt.Sprintf("Commands for the %s chain", chain), | ||
| RunE: func(cmd *cobra.Command, args []string) error { | ||
| if reconfig { | ||
| return reconfigure(configDir, chain, config) | ||
| } else if update { | ||
| fmt.Printf("Updating autocli data for %s\n", chain) | ||
| chainInfo := NewChainInfo(configDir, chain, chainConfig) | ||
| err := chainInfo.Load(true) | ||
| return err | ||
| } else { | ||
| return cmd.Help() | ||
| } | ||
| }, | ||
| } | ||
| chainCmd.Flags().BoolVar(&update, "update", false, "update the CLI commands for the selected chain (should be used after every chain upgrade)") | ||
| chainCmd.Flags().BoolVar(&reconfig, "config", false, "re-configure the selected chain (allows choosing a new gRPC endpoint and refreshes data)") | ||
|
|
||
| err = appOpts.EnhanceRootCommandWithBuilder(chainCmd, builder) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| cmd.AddCommand(chainCmd) | ||
| } |
Check failure
Code scanning / gosec
the value in the range statement should be _ unless copying a map: want: for key := range m
| for dep := range cantFind { | ||
| fmt.Printf("Warning: can't find %s.\n", dep) | ||
| } |
Check failure
Code scanning / gosec
the value in the range statement should be _ unless copying a map: want: for key := range m
|
|
||
| func (c *ChainInfo) getCacheDir() (string, error) { | ||
| cacheDir := path.Join(c.ConfigDir, "cache") | ||
| return cacheDir, os.MkdirAll(cacheDir, 0755) |
Check failure
Code scanning / gosec
Expect directory permissions to be 0750 or less
| return err | ||
| } | ||
|
|
||
| err = os.MkdirAll(configDir, 0755) |
Check failure
Code scanning / gosec
Expect directory permissions to be 0750 or less
|
Does this need another ACK? |
|
Creating a PR for adding the tooling (as we added a new go mod) and some docs to show up in docs.cosmos.network. |
Description
Closes: #13285
I suggest testing with some real chains. Not everything will work! But hopefully, this is a good start.
To get started, you'll need to instead
cosmcli:A few commands to try are:
This WILL NOT work with the cosmos hub yet because https://github.com/tendermint/liquidity/tree/develop/third_party/proto/cosmos_proto makes it impossible to correctly build a protobuf
FileDescriptorSet. I think we will need to work with chains to make sure they manager their proto files correctly. So far, it does work in my testing with regen, osmosis, juno, and evmos. Not all gRPC endpoints work (Notional seems to pretty consistently work thanks @faddat).With existing chains this uses some fallback ways to generate the auto CLI config. For chains that upgrade to v0.47, there are gRPC services that will directly be used and provide a better UX (cosmos.reflection.v1 and cosmos.autocli.v1).
I want to get it working with https://github.com/julienrbrt/simapp so that we can test the official support in v0.47 (one would run
cosmcli --init simappand then specify one of these endpoints but there's some networking issue currently).I'm not attached to the
cosmcliname. Open to other suggestions.Author Checklist
All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.
I have...
!to the type prefix if API or client breaking changeCHANGELOG.mdReviewers Checklist
All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.
I have...
!in the type prefix if API or client breaking change