autonity / docs.autonity.org

Documentation for the Autonity Go Client (AGC)
https://docs.autonity.org
2 stars 5 forks source link

No section in the documentation on the removal of awards from the validator's address #185

Closed narko2t closed 5 months ago

narko2t commented 5 months ago

No section in documentation on removing awards from validator address to address tresure

Suppose the validator wants to send accumulated awards $ATN from the validator's address to the tresure address, but this section and command are not provided in the documentation

Accordingly, in order to somehow use these awards, for example, to sell them on CAX they must first be sent from the validator address, and then already take any further action, this should have been stated initially for everyone's understanding

command to be applied: aut tx make --keyfile --to

--value 20 | aut tx sign --keyfile - | aut tx send -

this command can be added to the section: [Staking Recipes] (https://game.autonity.org/recipes/staking_recipes.html)

cmjc commented 5 months ago

Thanks for reporting this @narko2t

Agree this can be clarified and improved.

I've created an issue #186 for clarifying the validator economics section to state which accounts receive validator income.

I've created an issue #187 to clarify specifying keyfile when chaining aut commands.

this command can be added to the section: [Staking Recipes] (https://game.autonity.org/recipes/staking_recipes.html)

That is out of scope of this repo as it is game.autonity.org @rtedwardchen - what are your thoughts ? Another candidate to clarify this could be https://game.autonity.org/recipes/starter_recipes.html#submit-transactions

rtedwardchen commented 5 months ago

Currently, the Python recipes, including starter recipes and staking recipes, are served as mini templates to help participants who are more familiar with Python start the games more easily. So, the Python recipes only demonstrate part of the functions in the docs, and we expect participants to combine the Pyhon recipes with the docs to engineer their functions in Python. However, if the docs are improved, we can add more functions to the Python recipes to clarify specific use cases.

@cmjc I will have a further discussion with the team regarding this issue and potentially modify some of the Python recipes to help.

narko2t commented 5 months ago

Thanks for pointing this out!