This repository was archived by the owner on May 9, 2024. It is now read-only.
[Flags] Standardize names across CLI #156
waymobetta
started this conversation in
CLI
Replies: 1 comment
-
I was already pointed that once, that variants are really depend on the context, because, for example, on AddMinter command, argument should be minter, on RegisterHandler it should be handlerAddress, but in both cases those will be erc20Handler addresses. |
Beta Was this translation helpful? Give feedback.
0 replies
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
-
A discussion is started about standardizing flag names (perhaps also descriptions) across CLI commands.
These are some of the variants I’ve found across our CLIs commands:
target
minter
erc20Address
token
bridge
tokenContract
handler
The crux of the issue: Since the ChainBridge CLI utilizes so many different flags with varying formats for its various commands, it is possible that a user could get confused; for example,
target
, versustokenContract
, versustoken
, versuserc20Address
. In other words, why are we using 4 different formats for describing a contract address, whether that be a handler, an erc20 or the bridge contract itself? Additionally, using so many different formats looks unprofessional.If we use one naming convention for a contract address, then that same naming convention should be applied to all flag names that are also contract addresses. Additionally, it is likely that much confusion for users could also be mitigated by better flag descriptions.
Related Issue
Beta Was this translation helpful? Give feedback.
All reactions