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

refactor(zetaclient): improve some general structure of the codebase #2032

Merged
merged 16 commits into from
Apr 26, 2024

Conversation

lumtis
Copy link
Member

@lumtis lumtis commented Apr 15, 2024

Description

Add some improvement in the codebase following this issue: #2026

@lumtis lumtis linked an issue Apr 15, 2024 that may be closed by this pull request
Copy link

github-actions bot commented Apr 15, 2024

!!!WARNING!!!
nosec detected in the following files: zetaclient/bitcoin/bitcoin_client.go, zetaclient/bitcoin/fee.go, zetaclient/bitcoin/inbound_tracker.go, zetaclient/config/config_chain.go, zetaclient/evm/evm_client.go, zetaclient/keys/keys_test.go, zetaclient/tss/tss_signer.go

Be very careful about using #nosec in code. It can be a quick way to suppress security warnings and move forward with development, it should be employed with caution. Suppressing warnings with #nosec can hide potentially serious vulnerabilities. Only use #nosec when you're absolutely certain that the security issue is either a false positive or has been mitigated in another way.

Only suppress a single rule (or a specific set of rules) within a section of code, while continuing to scan for other problems. To do this, you can list the rule(s) to be suppressed within the #nosec annotation, e.g: /* #nosec G401 */ or //#nosec G201 G202 G203
Broad #nosec annotations should be avoided, as they can hide other vulnerabilities. The CI will block you from merging this PR until you remove #nosec annotations that do not target specific rules.

Pay extra attention to the way #nosec is being used in the files listed above.

@github-actions github-actions bot added the nosec label Apr 15, 2024
Copy link

codecov bot commented Apr 15, 2024

Codecov Report

Attention: Patch coverage is 15.60380% with 622 lines in your changes are missing coverage. Please review.

Project coverage is 70.17%. Comparing base (55c65e0) to head (b03631a).

Additional details and impacted files

Impacted file tree graph

@@             Coverage Diff             @@
##           develop    #2032      +/-   ##
===========================================
- Coverage    70.70%   70.17%   -0.54%     
===========================================
  Files          252      249       -3     
  Lines        14052    14135      +83     
===========================================
- Hits          9936     9919      -17     
- Misses        3656     3758     +102     
+ Partials       460      458       -2     
Files Coverage Δ
zetaclient/bitcoin/fee.go 89.89% <ø> (ø)
zetaclient/bitcoin/inbound_tracker.go 0.00% <ø> (ø)
zetaclient/bitcoin/tx_script.go 93.10% <ø> (ø)
zetaclient/config/config.go 0.00% <ø> (ø)
zetaclient/config/config_chain.go 0.00% <ø> (ø)
zetaclient/core_context/zeta_core_context.go 90.82% <ø> (ø)
zetaclient/evm/inbounds.go 69.32% <ø> (ø)
zetaclient/interfaces/signer.go 0.00% <ø> (ø)
zetaclient/metrics/burn_rate.go 79.16% <ø> (ø)
zetaclient/supplychecker/validate.go 100.00% <100.00%> (ø)
... and 13 more

... and 4 files with indirect coverage changes

@lumtis lumtis marked this pull request as ready for review April 15, 2024 15:58
Copy link
Contributor

@ws4charlie ws4charlie left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks nice. Left a few minor comments.

@lumtis lumtis requested a review from ws4charlie April 17, 2024 12:36
Copy link
Contributor

@skosito skosito left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

some smaller comments, looks good

@lumtis lumtis merged commit 3e8f2e6 into develop Apr 26, 2024
20 of 21 checks passed
@lumtis lumtis deleted the refactor/zetaclient-code-general branch April 26, 2024 13:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

General coding practices improvement in ZetaClient
3 participants