Skip to content
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.

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

Move Configuration Prompts to the Config Command #566

Open
0xSpuddy opened this issue Jan 13, 2023 · 1 comment
Open

Move Configuration Prompts to the Config Command #566

0xSpuddy opened this issue Jan 13, 2023 · 1 comment
Labels
enhancement New feature or request

Comments

@0xSpuddy
Copy link
Contributor

0xSpuddy commented Jan 13, 2023

This issue aims to help avoid confusion for new telliot users who are first learning how to setup their reporting accounts and RPC endpoints.

Part 1:
Currently a new telliot user is asked whether or not they want to change their reporting settings only after they enter the report command. Here is an example log for the command `telliot report -a accountName'

...
Your current settings...
Your chain id: 80001

Your mumbai endpoint: 
 - provider: Matic
 - RPC url: https://polygon-mumbai.infura.io/v3/53ba4f713bf940fb87a58280912231ab
 - explorer url: https://mumbai.polygonscan.com/
Your account: mumbai4 at address 0x0eb136f2e29655230714afae2e8e6613dcc6076c
Proceed with current settings (y) or update (n)? [Y/n]: n

I think that at thins point in the process there is a good chance that the user:

  1. has already configured their accounts and endpoints for reporting before they use the report command, making the command line settings dialog seem out of place or confusing.
  2. may be unaware that telliot is going to start reporting when the dialog is done. They might not be ready to do this, resulting in a report that they didn't mean to initiate. (they just wanted to edit their configuation).

Suggested change: I think we should move this config dialog out of the report command and into the config command. This way users can edit their configuration with the cli before they use the report command.

Another reason for this:
Later in the config dialogs the user is asked about the accounts that they have setup for the chosen chainId:

You have these accounts on chain_id 80001                                                                                                                    
> mumbai2 0xwereebe0dfgh65d65118cce2942f99392                                                                                                         
  mumbai7 0xdfeweee8sdfga87acc52782a                                                                                                         
  add account...                                        

The user has already given the account that they want to use when they initiated the report command, so this step may be confusing also.

Thanks for reading! I'll be ready to help with this as needed.

@0xSpuddy 0xSpuddy added the enhancement New feature or request label Jan 13, 2023
@LP-Crypto-Scholar
Copy link

Completely agree on this one. I was confused when this initially prompted me

@oraclown oraclown mentioned this issue Feb 2, 2023
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants