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

Command / option / flag name brainstorming #7

Open
d5000 opened this issue Jan 31, 2024 · 13 comments
Open

Command / option / flag name brainstorming #7

d5000 opened this issue Jan 31, 2024 · 13 comments
Labels
question Further information is requested

Comments

@d5000
Copy link

d5000 commented Jan 31, 2024

I'm going through the options and flags to try to find some with unique characters at the start to allow for most (at least for the most popular ones) an unique one-letter variant. (AFAIK, as we have already discussed, the one-character variant has always to use the first letter of the complete flag/option/variable name).

In this thread I'll present some commands where I still didn't find an appropiate one-letter flag. Those starting with the letter h should be avoided as h always should be available for --help.


The first "group" of flags which I perhaps need some ideas/brainstorming is the following: Most transaction commands for dPoD tokens (e.g. donation signal or donation lock, those that create signalling,locking, donation transactions etc.) use the --confirm flag to wait for a single confirmation (with a "spinner" animation). This however conflicts with the --change flag for a change address which is also present in almost all transaction-creating commands. I think "change address" is too established to change it.

An alternative would be --wait-for-confirmation or so, but --wait is another existing flag: it can be used to "pre-plan" to submit a signalling/locking/donation transaction in the next round it would fit (I guess you remember there's signalling/locking and donation rounds) instead of instantly.

I've thought about changing --wait to --presubmit or so, but the letter "p" is also used many times, especially for --proposal. Both are imo important enough that they should have an one-letter variant. Unfortunately, --hold which would be an option too, conflicts with --help. --await-confirmation for --confirm would be also possible, but -a often is used for --amount, for example the amount to signal or release in signalling/donation transactions.

Any ideas? If --wait can be replaced then this group would be basically solved, but of course there could also be other forms of organizing this.

(In few words: I need an alternative either for "confirm" or "wait", which doesn't start with "h", "a", "w", "p", or "c".)

@d5000 d5000 added the question Further information is requested label Jan 31, 2024
@buhtignew
Copy link
Collaborator

Here are some ideas:
--validate
--ratify
--defer
--delay
--stay
--retain
--temporize
--tarry
If nothing of these works for you I can think of more.

@d5000
Copy link
Author

d5000 commented Feb 1, 2024

Thanks! --retain looks good but unfortunately I found that it conflicts with --reserve which is also an important option for many donation commands ... :( The same for --defer. I forgot to mention it but it conflicts with --debug.

--temporize could be ok, while there are some options/flags with "t" they are few and they could be replaced. I've not heard the word many times, but if it's used in a way similar to "wait" or "hold" then it could work :)

Another idea: --wait could become --match_round (in the sense of "match the next round where you can signal/donate/lock/vote"). -m would be ideal as it's not used in these commands at all.

I'll continue to brainstorm a bit, you can of course continue to post ideas ...

@buhtignew
Copy link
Collaborator

Is it possible I haven't understood your question?
I thought we were looking for the flag to let people waiting for the 1 confirmation when they make the transaction to know that the transaction went through.
If so I'm not sure how is it related to "matching the round". Do you mean that after one confirmation one can do other transactions of the same kind?

I think the first meaning of temporize is "delay" so it's basically the same as "wait".

@d5000
Copy link
Author

d5000 commented Feb 2, 2024

These are two different flags, --confirm and --wait (I would like to replace one of both). --confirm indeed waits for a confirmation and does not wait for a specific round to "arrive" (i.e. wait for a specific block height). However --wait does exactly this: it waits for the next round where a specific kind of transaction (signalling/locking/release/voting) transaction can be submitted, according to the token rules. The reason why I included "wait" here in this discussion is that something based on the word "wait" / "wait for confirmation" would be a good replacement for "confirm" in my opinion.

So basically this idea would be:

  • replace --confirm with --wait or --wait-for-confirmation (this would be -w then).
  • replace --wait with --match-round or so (-m).

The other idea is leaving --wait as it is now, and instead replacing --confirm by --temporize.

The question is which version is clearer for the user, but I think one of both could work.

Sorry to have caused confusion :)

@buhtignew
Copy link
Collaborator

buhtignew commented Feb 3, 2024

I think --wait-for-confirmation and --match-round are much clearer then --temporize in each case (maybe we can replace --match-round with --match-the-round).

As alternative we can replace both with --temporize but we'll have to put an effort to make its usage clear for both situations which is of course not the ideal.

If we need to replace --wait-for-confirmation I think --temporize can work, though.

@buhtignew
Copy link
Collaborator

Should we close this one?

@d5000
Copy link
Author

d5000 commented Feb 12, 2024

I think this one can stay open. I have still to think about some of the flags, above all on big commands like transaction list I would like to have more short one-letter forms. Then I still haven't changed the flags in the dPoD token commands I listed before.

Also, this thread can be used any time you, or me, find a flag or option name which could be improved or made more intiuitive.

@d5000
Copy link
Author

d5000 commented Feb 29, 2024

Flag names are almost done, so this topic can be soon closed, with one exception:

donation lock and donation release have the options --reserve and --reserveamount. These are the amounts/outputs which can be reserved for the next round in the case the slot was filled. --reserve is the destination address which will become the donor address for the new donation state.

This is quite challenging. I'm searching for two flag names which both don't start neither with letter "R", nor with the letters:

H, D, W, T, C, N, M, S, L, Q, V (important)
A, F (less important)

Possible letters are thus B, E, G, I, J, K, O, P, U, X, Y, Z (and A and/or F if nothing different is possible)

I'll of course also brainstorm here, but have still nothing really convincing.

One start could be --output-to-reserve and --assign-reserveaddress. But this has one with the A, which I want to avoid. --address should be avoided because in the locking transaction there is another address as option.

Edit: Perhaps --pick-reserveaddress could work. (It is not important that the flag name is short, because the idea is anyway to find a short one-letter flag).
Edit2: Instead of --output_to_reserve also --include-reserveamount would be possible.

So I have already an idea ... but I leave open for if one of us finds something better.

(By the way: I didn't confirm it above but I finally went for wait_for_confirmation and match_round in the earlier question.)

@buhtignew
Copy link
Collaborator

I think --pick-reserveaddress and --include-reserveamount are fine.

I haven't begun testing that part yet, maybe when I'm more familiar with donation lock and donation release commands I will be able to contribute better, but as now those flags sound good to me.

@d5000
Copy link
Author

d5000 commented May 31, 2024

This entry is not about flags, but about whole commands: I shortened two commands.

podtoken deck_spawn is now podtoken spawn

podtoken deck_state is now podtoken state

Both don't need the "deck" in it, and this way the "deck" keyword is also a bit less present for users who prefer "token". Commit 5cd2378.

@buhtignew
Copy link
Collaborator

buhtignew commented May 31, 2024

This entry is not about flags, but about whole commands: I shortened two commands.

Maybe we could edit the name of this topic into "Flag's and command's names brainstorming". How does it sound to you?

I shortened two commands.

Taken note.

@d5000 d5000 changed the title Option / flag name brainstorming Command / option / flag name brainstorming Jun 1, 2024
@buhtignew
Copy link
Collaborator

buhtignew commented Aug 1, 2024

Would it make sense to change the -e flag for the pobtoken spawn and podtoken spawn commands into -t, i.e. --to_block or --till_block? Then it would be more in line with the meaning of the corresponding --from_block flag. Or maybe we can rename the --from_block flag into --first_block.

@d5000
Copy link
Author

d5000 commented Aug 2, 2024

-t will conflict with the token_name variable. While this could be changed, the reason I used -e is to use the same scheme than the transaction list command.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question Further information is requested
Projects
None yet
Development

No branches or pull requests

2 participants