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

Review model module naming conventions #16

Closed
BenSchZA opened this issue Mar 22, 2021 · 2 comments
Closed

Review model module naming conventions #16

BenSchZA opened this issue Mar 22, 2021 · 2 comments

Comments

@BenSchZA
Copy link
Collaborator

Currently, the model modules are as follows:

  • accounting.py
  • ethereum.py
  • proof_of_stake.py
  • eip1559.py
  • etc.

Consider refactoring if necessary to make these classifications more clear. Barnabe suggested finalization and justification as concepts worth considering: https://our.status.im/two-point-oh-justification-and-finalization/ . @rogervs suggested looking at the Eth2 spec. test suite to see what the architecture is.

Accessibility and value for learning should be prioritized, and sticking to the existing Eth2 spec and standard terminology.

@rogervs
Copy link
Contributor

rogervs commented Mar 22, 2021

Suggestion for eip1559.py to become :

  • gas_fee_management.py
  • gas_management.py
  • load_management.py
  • transaction_load_feedback.py
  • fee_management.py

@BenSchZA BenSchZA added this to To do in Collab Workstreams Mar 23, 2021
@BenSchZA BenSchZA moved this from To do to In Review in Collab Workstreams Mar 30, 2021
@BenSchZA
Copy link
Collaborator Author

BenSchZA commented Apr 2, 2021

Thanks for the suggestions! @rogervs I've subsequently moved the EIP1559 logic into ethereum.py, and renamed it as policy_eip1559_transaction_pricing(...) so that it's familiar with people having read the economic report, and generally it's a topical upgrade at the moment. If people Google EIP1559 they will be able to see the specification of the mechanism. We could always give it a more generic name in a future update. In the spec they call it a "transaction pricing mechanism" which translates nicely to cadCAD logic naming.

@BenSchZA BenSchZA closed this as completed Apr 2, 2021
Collab Workstreams automation moved this from In Review to Done Apr 2, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Development

No branches or pull requests

2 participants