eth-educators / ethstaker-deposit-cli

Secure key generation for deposits
https://eth-educators.github.io/ethstaker-deposit-cli/
Creative Commons Zero v1.0 Universal
3 stars 5 forks source link

Removing all eth1 references #75

Closed valefar-on-discord closed 3 months ago

valefar-on-discord commented 3 months ago

Removing all eth1 references

At this point we have three important distinctions:

Specifically, I chose WITHDRAWAL_ADDRESS over EXECUTION_ADDRESS as I feel that is the most user friendly name.

In a separate commit, I also changed the address parameter to --withdrawal_address to align with the above changes.

The only disconnect this causes is the to_execution_address is a very specific parameter required for the signed output and that absolutely can not be changed.

Happy to hear thoughts on the best naming convention to utilize.

Fixes #29

remyroy commented 3 months ago

I'm ambivalent about keeping the --execution_address and the --eth1_withdrawal_address options as hidden aliases for the new or renamed --withdrawal_address option. On one side, it could help keep the interface with the staking-deposit-cli project similar and easier to go from one to the other. On the other side, it's somewhat cleaner to use the renamed option only. I don't think there is a good or definitive answer here. I think if it's not too complicated and it doesn't keep too much legacy stuff around, it would be nice to have these options work as aliases without documentating them anywhere.

valefar-on-discord commented 3 months ago

You bring up a good point of interoperability between this and staking-deposit-cli.

I added the original params back in with a unit test for each to make sure they keep working in the future but, as suggested, will be ignored in documentation