goat-systems / tzpay

tzpay is a configurable batch payment tool for Bakers in the Tezos ecosystem
MIT License
12 stars 10 forks source link

Modify naming flags #6

Open bneiluj opened 5 years ago

bneiluj commented 5 years ago

Delegate, secret are a bit confusing in the current description:

Screenshot 2019-05-20 at 15 05 35

We should modify delegate to bakerAddress so it's very clear that it's the baker's address and not the payout's wallet. Also, the fact that there is no need to specify the Payout Wallet Public Key because of passing the PK should be made clear to the user by using secretPayoutWallet.

Naming proposal:

i). bakerAddress: Baker's address, the node that is running the Tezos Bakery. ii). delegators: the different addresses that are delegating to the Baker's address. iii). payoutWallet & secretPayoutWallet: the wallet that is sending payouts to delegator addresses. We can use secretPayoutWallet for "encrypted secret key of the wallet paying (e.g. --secret=)"

To look have something like that:

./payman payout \
    --bakerAddress=tz3gN8NTLNLJg5KRsUU47NHNVHbdhcFXjjaB \
    --secretPayoutWallet=edesk1Qx5JbctVnFVHL4A7BXgyExihHfcAHRYXoxkbSBmKqP2Sp92Gg1xcU8mqqu4Qi9TXkXwomMxAfy19sWAgCm \
    --password=abcd1234 \
    --cycle=160 \
    --node=127.0.0.1 \
    --port=8732 \
    --fee=0.05 
DefinitelyNotAGoat commented 5 years ago

@bneiluj I'm going to have to disagree with you on these changes. I want to keep the flags uniform with the official Tezos Documentation. Tezos refers to bakers as Delegates..

I also believe the descriptions are good, but if there's something you believe is missing in them, I could update those.

-d, --delegate string        public key hash of the delegate that's paying out (e.g. --delegate=<phk>)
-s, --secret string          encrypted secret key of the wallet paying (e.g. --secret=<sk>)

Thanks for your feedback!

DefinitelyNotAGoat commented 5 years ago

Also @bneiluj by the looks of it you may be using an old version on payman. I would recommend you update to v1.0.3!

bneiluj commented 5 years ago

@DefinitelyNotAGoat Ok perfect. Let's just update the description. It makes sense to me.