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

General coding practices improvement in ZetaClient #2026

Closed
Tracked by #1611
lumtis opened this issue Apr 15, 2024 · 0 comments · Fixed by #2032
Closed
Tracked by #1611

General coding practices improvement in ZetaClient #2026

lumtis opened this issue Apr 15, 2024 · 0 comments · Fixed by #2032
Assignees
Labels
zetaclient Issues related to ZetaClient

Comments

@lumtis
Copy link
Member

lumtis commented Apr 15, 2024

Describe the Issue

Contains some tasks that can be addresses in the same PR for general code practices improvement in ZetaClient

  • Remove all commented code if not used without context
    • Example Bitcoin PostGasPrice: commented logger code
  • Leave empty line between components of a functions
    • Example Bitcoin PostGasPrice: empty lines after error handling
  • There are public and private methods in random orders, we should put public first and private methods after
    • Example in bitcoin_client
    • tss/tss_signer
  • All function/variable comments should start with the name
    • Example: BtcOutTxBytesDeposit and other vars in bitcoin/fee
    • The constant definitions in evm
  • Remove unused variables, unless for a specific reason specific in comment
    • Example: different variable in config_chain.go
  • Use empty lines between every functions
    • Example in evm_client
  • Find and remove all unused functions
    • BuildReceiptsMap in evm_client
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
zetaclient Issues related to ZetaClient
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant