ZetaClient Code Structure Revamp

[lumtis]

This EPIC includes issues or a list of issues for ZetaClient revamp.

This includes:

• Test coverage
• Modularity and better maintainability

Tasks

Beta Give feedback

1. Improve observers codebase #2503
   code-quality enhancement zetaclient +3
2. Simplify tx type selection in EVM TryProcessOutTx #1837
   code-quality refactor zetaclient +3
3. Investigate and improve the function naming in ZetaClient #2021
   zetaclient +1
4. Simplify the ObserverInTx in bitcoin #2023
   zetaclient +1
5. Removing hard coded values in ZetaClient #2025
   zetaclient +1
6. Investigate and remove useless pointers #2084
   code-quality zetaclient +2
7. TSSSigner: check if optionalPubkey used or remove otherwise #2085
   zetaclient +1
8. create a setter method to allow observer to dynamically bind to a database for unit test #2437
   code-quality zetaclient +2
   
9. Address TODO(revamp) comments in ZetaClient #2322
   zetaclient +1
10. The method TryProcessOutbound of evm signer needs to be investigated and improved #2318
    code-quality zetaclient +2
    
11. Make ZetaClient modular enough so new chain integration can be added as "plugin" #1761
    feature:idea zetaclient +2

Completed

Tasks

Beta Give feedback

1. Make UpdateConfigFromCore and ZetaClient config more future-proof #1397
   zetaclient +1
2. feat: Zetaclient should be able to enable newly added chain dynamically at runtime #1904
   zetaclient +1
   
3. Unify chainParams, signer, and observers lifecycle #2519
   code-quality refactor zetaclient +3
   
4. remove the constant maxHeightDiff and let chain client continue scan from where it left off #2086
   bug +1
   
5. zetaclient: chore: rename zetacore to appContext #2526
   refactor zetaclient +2
   
6. Use consistent naming in ZetaClient #2027
   zetaclient +1
   
7. General coding practices improvement in ZetaClient #2026
   zetaclient +1
   
8. Creating a common base for chain clients (BitcoinClient and EVMChainClient currently) #2022
   zetaclient +1
   
9. Removing panic in zetaclient #2024
   zetaclient +1
   
10. refactor: the EVMClient's IsSendOutTxProcessed method contains many duplicate logic and it's also too long (250 lines) to maintain #1534
    code-quality zetaclient +2
    
11. Investigate ZetaClient code factorization and function simplification. #1609
    zetaclient +1
    
12. Remove runtime values from config #1608
    zetaclient +1
    
13. Add more organization in the package structuring of ZetaClient #1607
    code-quality zetaclient +2
    
14. Add ability to set gas price or fees in ZetaClient broadcasts #1246
    zetaclient +1
15. zetaclient should not vote on inTx ballot that it has already voted for #1573
    bug zetaclient +2
    
16. Decouple metrics from outbound scheduler in zeta observer #1769
    zetaclient +1
    
17. evm signer - simplify TryProcessOutTx, long function #1770
    zetaclient +1
    
18. zetaclients should be able to pick up update on Connector/ERC20Custody addresse #1633
    bug zetaclient +2
    
19. consider updating cached block headers and blocks as they may contain incorrect data #1678
    bug zetaclient +2
20. Follow up on config/params separation in zetaclient #1807
    zetaclient +1
    
21. Add crosschain flags to zetaclient context #1832
    refactor zetaclient +2
    
22. evm_signer_test in ZetaClient sometimes fail #1887
    test zetaclient +2
    
23. zetaclient should check 'IsSupported' flag to be able to pause/unpause a specific chain #1883
    zetaclient +1
    
24. ZetaClient should stop trying to process inbound/outbound when these are paused #1888
    bug zetaclient +2
    
25. refactor: create base Observer and Signer struct to group common data of EVM observer/signer and Bitcoin observer/signer #2126
    code-quality zetaclient +2
    
26. Fix ZetaClient gosec #2180
    code-quality zetaclient +2
27. ZetaClient might panic if signer is not found in signer map #1643
    bug zetaclient +2
    
28. Small codebase structure refactoring for ZetaClient #2020
    zetaclient +1

V2 Revamp

Beta Give feedback

1. Move worker/async logic out of zetaclient/zetacore #2589
   code-quality refactor zetaclient +3
   
2. Decouple /zetaclient/chains/interfaces #3107
   code-quality refactor zetaclient +3
3. Make ZetaClient logging and metrics clear, informative, and easy to read for monitoring #2015
   0 of 5
   epic monitoring zetaclient +3
4. zetaclient: fix logging in orchestrator #3096
   bug zetaclient +2
   
5. Graceful shutdown + unified background task behaviour #3108
   code-quality refactor zetaclient +3
6. refactor: minimize the group of setters exposed by base Observer/Signer structs #2381
   code-quality zetaclient +2
   
7. Drop support for Rosetta API #3109
   code-quality refactor zetaclient zetacore +4
   
8. Simplify cmd/zetaclient/start.go #3112
   code-quality refactor zetaclient +3
   
9. mitigate missing inbound observations: stop scanning external chains if zetacored node is halted #3115
   bug +1
10. Revamp zetaclient/tss package #3119
    refactor zetaclient +2
11. Drop support for block header proofs #3110
    refactor zetaclient +2
    
12. Reduce logic in cmd/zetaclientd #2019
    code-quality refactor zetaclient +3
13. Consider removing init() usages in zetaclient #2029
    zetaclient +1
    
14. Drop support for HSM #3111
    refactor zetaclient +2