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

feat(zetaclient): add support for EIP-1559 outbound transactions #2387

Closed
wants to merge 17 commits into from

Conversation

swift1337
Copy link
Contributor

@swift1337 swift1337 commented Jun 26, 2024

Description

This PR introduces support for EIP-1559 gas fees for outbound transactions in zetaclientd.

Closes: #1952, #1085

The main changes are located in:

  • zetaclient/chains/evm/observer/observer.go
  • zetaclient/chains/evm/signer/gas.go
  • zetaclient/chains/evm/signer/outbound_data.go
  • zetaclient/chains/evm/signer/signer.go

Changes

  • Minor refactor of Orchestrator
  • Logging improvements. Moving dynamic values into log event
  • Refactoring of signer.NewOutboundData(...)
  • Support for DynamicFeeTx
  • Fetch GasTipCap (evm.SuggestGasTipCap)
  • Minor refactoring

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Include instructions and any relevant details so others can reproduce.

  • Tested CCTX in localnet
  • Tested in development environment
  • Go unit tests
  • Go integration tests
  • Tested via GitHub Actions

Checklist:

  • I have added unit tests that prove my fix feature works

@swift1337 swift1337 self-assigned this Jun 26, 2024
Copy link
Contributor

coderabbitai bot commented Jun 26, 2024

Important

Review skipped

Review was skipped due to path filters

Files ignored due to path filters (23)
  • changelog.md is excluded by none and included by none
  • cmd/zetaclientd/start.go is excluded by none and included by none
  • cmd/zetaclientd/utils.go is excluded by none and included by none
  • docs/development/LOCAL_TESTING.md is excluded by none and included by none
  • zetaclient/chains/base/logger.go is excluded by none and included by none
  • zetaclient/chains/base/logger_test.go is excluded by none and included by none
  • zetaclient/chains/base/observer.go is excluded by none and included by none
  • zetaclient/chains/base/observer_test.go is excluded by none and included by none
  • zetaclient/chains/base/signer.go is excluded by none and included by none
  • zetaclient/chains/base/signer_test.go is excluded by none and included by none
  • zetaclient/chains/bitcoin/observer/observer_test.go is excluded by none and included by none
  • zetaclient/chains/bitcoin/signer/signer.go is excluded by none and included by none
  • zetaclient/chains/evm/observer/observer.go is excluded by none and included by none
  • zetaclient/chains/evm/observer/observer_test.go is excluded by none and included by none
  • zetaclient/chains/evm/signer/gas.go is excluded by none and included by none
  • zetaclient/chains/evm/signer/gas_test.go is excluded by none and included by none
  • zetaclient/chains/evm/signer/outbound_data.go is excluded by none and included by none
  • zetaclient/chains/evm/signer/outbound_data_test.go is excluded by none and included by none
  • zetaclient/chains/evm/signer/signer.go is excluded by none and included by none
  • zetaclient/chains/evm/signer/signer_test.go is excluded by none and included by none
  • zetaclient/orchestrator/orchestrator.go is excluded by none and included by none
  • zetaclient/outboundprocessor/outbound_processor.go is excluded by none and included by none
  • zetaclient/testutils/mocks/evm_rpc.go is excluded by none and included by none

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


Tip

Early access features: enabled

We are currently testing the following features in early access:

  • OpenAI gpt-4o model for code reviews and chat: OpenAI claims that this model is better at understanding and generating code than the previous models. We seek your feedback over the next few weeks before making it generally available.

Note:

  • You can enable or disable early access features from the CodeRabbit UI or by updating the CodeRabbit configuration file.
  • Please join our Discord Community to provide feedback and report issues.
  • OSS projects are currently opted into early access features by default.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

codecov bot commented Jun 26, 2024

Codecov Report

Attention: Patch coverage is 65.34392% with 131 lines in your changes missing coverage. Please review.

Project coverage is 69.13%. Comparing base (0bcb422) to head (07999ec).
Report is 6 commits behind head on develop.

Additional details and impacted files

Impacted file tree graph

@@             Coverage Diff             @@
##           develop    #2387      +/-   ##
===========================================
+ Coverage    69.10%   69.13%   +0.02%     
===========================================
  Files          308      309       +1     
  Lines        19221    19307      +86     
===========================================
+ Hits         13283    13347      +64     
- Misses        5267     5288      +21     
- Partials       671      672       +1     
Files Coverage Δ
zetaclient/chains/base/logger.go 94.87% <100.00%> (-0.26%) ⬇️
zetaclient/chains/base/signer.go 88.88% <100.00%> (ø)
zetaclient/outboundprocessor/outbound_processor.go 0.00% <0.00%> (ø)
zetaclient/chains/base/observer.go 90.41% <90.00%> (-0.73%) ⬇️
zetaclient/chains/evm/signer/gas.go 85.00% <85.00%> (ø)
zetaclient/chains/bitcoin/signer/signer.go 18.14% <11.11%> (+0.07%) ⬆️
zetaclient/chains/evm/observer/observer.go 42.80% <0.00%> (-2.62%) ⬇️
zetaclient/chains/evm/signer/outbound_data.go 75.26% <76.13%> (+6.91%) ⬆️
zetaclient/chains/evm/signer/signer.go 53.64% <76.31%> (+1.05%) ⬆️
zetaclient/orchestrator/orchestrator.go 24.69% <9.30%> (-0.72%) ⬇️

@swift1337 swift1337 marked this pull request as ready for review June 27, 2024 17:25
Copy link

gitguardian bot commented Jun 27, 2024

⚠️ GitGuardian has uncovered 12 secrets following the scan of your pull request.

Please consider investigating the findings and remediating the incidents. Failure to do so may lead to compromising the associated services or software components.

🔎 Detected hardcoded secrets in your pull request
GitGuardian id GitGuardian status Secret Commit Filename
11033143 Triggered Generic High Entropy Secret 3bc0394 cmd/zetae2e/local/accounts.go View secret
11033143 Triggered Generic High Entropy Secret 3bc0394 cmd/zetae2e/config/localnet.yml View secret
11033143 Triggered Generic High Entropy Secret 3bc0394 cmd/zetae2e/config/local.yml View secret
11033144 Triggered Generic High Entropy Secret 3bc0394 cmd/zetae2e/config/localnet.yml View secret
11033144 Triggered Generic High Entropy Secret 3bc0394 cmd/zetae2e/local/accounts.go View secret
11033145 Triggered Generic High Entropy Secret 3bc0394 cmd/zetae2e/local/accounts.go View secret
11033145 Triggered Generic High Entropy Secret 3bc0394 cmd/zetae2e/config/localnet.yml View secret
11033146 Triggered Generic High Entropy Secret 3bc0394 cmd/zetae2e/local/accounts.go View secret
11033146 Triggered Generic High Entropy Secret 3bc0394 cmd/zetae2e/config/localnet.yml View secret
11478175 Triggered Generic High Entropy Secret 3bc0394 cmd/zetae2e/config/localnet.yml View secret
11478176 Triggered Generic High Entropy Secret 3bc0394 cmd/zetae2e/config/localnet.yml View secret
11759679 Triggered Generic High Entropy Secret 3bc0394 cmd/zetae2e/local/accounts.go View secret
🛠 Guidelines to remediate hardcoded secrets
  1. Understand the implications of revoking this secret by investigating where it is used in your code.
  2. Replace and store your secret safely. Learn here the best practices.
  3. Revoke and rotate this secret.
  4. If possible, rewrite git history. Rewriting git history is not a trivial act. You might completely break other contributing developers' workflow and you risk accidentally deleting legitimate data.

To avoid such incidents in the future consider


🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request.

@swift1337 swift1337 requested a review from skosito as a code owner June 27, 2024 17:25
@lumtis
Copy link
Member

lumtis commented Jun 28, 2024

@coderabbitai review

Copy link
Contributor

coderabbitai bot commented Jun 28, 2024

Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

Copy link
Member

@lumtis lumtis left a comment

Choose a reason for hiding this comment

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

Looks good, leaving a few comments

func (g Gas) isLegacy() bool {
	return g.PriorityFeePerUnit.Sign() <= 1
}

We might want to see if we can test both cases in the E2E tests. Like disabling EIP 1559 in the local EVM

zetaclient/chains/evm/observer/observer.go Outdated Show resolved Hide resolved
zetaclient/chains/evm/signer/gas.go Show resolved Hide resolved
zetaclient/chains/evm/signer/gas.go Show resolved Hide resolved
zetaclient/chains/evm/signer/gas.go Outdated Show resolved Hide resolved
zetaclient/chains/evm/signer/gas.go Outdated Show resolved Hide resolved
zetaclient/chains/evm/signer/outbound_data.go Outdated Show resolved Hide resolved
zetaclient/chains/evm/signer/signer.go Show resolved Hide resolved
if err != nil || len(cctxIndex) != 32 {
return nil, true, fmt.Errorf("decode CCTX %s error", cctx.Index)
// Determine gas fees
gas, err := makeGasFromCCTX(cctx, evmObserver.GetPriorityGasFee(), logger)
Copy link
Contributor

Choose a reason for hiding this comment

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

If the priorityFee being used here comes from zetaclients own fetched value thru RPC SuggestGasTipCap. The values may vary across across the group of TSS signers (the external signers are using their own Ethereum node/endpoint, and these nodes can go slightly out-of-sync). In this case, the tx body being built across TSS signers will also vary and lead to TSS keysign failure (because they're signing different transaction bodies).

The key point to achieve EIP-1559 is to be able to use a deterministic GasTipCap value across all TSS signers to sign the transaction. So the cctx struct itself will need to carry a consensus-based GasTipCap, with zetaclients just use the same value to create the tx and then process TSS keysign.

Copy link
Member

Choose a reason for hiding this comment

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

Good point on this. We will have to post some information on ZetaCore finally.
We can add a new field in the MsgVoteGasPrice and in the GasPrice structure in the crosschain module.
(We could think about renaming the GasPrice structure in the future but right now we could keep the name and just add new fields)

Unlike the actual gas price, here we would not need to interact with the smart contract like fungibleKeeper.SetGasPrice. We would just need to update the structure at the Cosmos module level, it will then be read by all ZetaClient.

I think we can keep this PR open, work on a new one for the gas tip posting, then update this one.

WDYT @swift1337

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Makes total sense for me, thanks for spotting this, @ws4charlie.

@@ -17,14 +17,14 @@ const (

// Logger contains the base loggers
type Logger struct {
Std zerolog.Logger
zerolog.Logger
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: is there any reason we use zerolog instead of the standard library slog? Maybe we could start that conversation on a parallel discussion to eventually migrate and reduce the amount of dependencies on the core node.

// use memory db if specified
if strings.Contains(dbPath, ":memory:") {
path = dbPath
dial = sqlite.Open(fmt.Sprintf("%s/%s", dbPath, dbName))
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: Consider moving this statement to a function that standardizes how we expect the db paths.
That way we make this more reusable and deterministic.

Suggested change
dial = sqlite.Open(fmt.Sprintf("%s/%s", dbPath, dbName))
dial = sqlite.Open(buildDBPath(dbPath, dbName))

@@ -276,7 +276,7 @@ func TestOpenCloseDB(t *testing.T) {
})
t.Run("should return error on invalid db path", func(t *testing.T) {
err := ob.OpenDB("/invalid/123db", "")
require.ErrorContains(t, err, "error creating db path")
require.ErrorContains(t, err, "unable to ensure dbPath")
Copy link
Contributor

Choose a reason for hiding this comment

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

"unable to ensure dbPath" is used a few times across the codebase, consider creating a const for it and reuse whenever needed.

ob.priorityGasFee = fee
}

// GetPriorityGasFee a.k.a. tx.gasTipCap>
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
// GetPriorityGasFee a.k.a. tx.gasTipCap>
// GetPriorityGasFee returns gasTipCap (EIP-1559)


maxFee, ok := new(big.Int).SetString(outboundParams.GasPrice, 10)
if !ok {
return Gas{}, errors.New("unable to parse gasPrice from " + outboundParams.GasPrice)
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: consider using fmt.Errorf instead of concatenating strings.

Copy link
Member

Choose a reason for hiding this comment

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

Yes this is a clear example of where fmt.Errorf is the more correct choice


// makeGasFromCCTX creates Gas struct based from CCTX and priorityFee.
func makeGasFromCCTX(cctx *types.CrossChainTx, priorityFee *big.Int, logger zerolog.Logger) (Gas, error) {
if priorityFee == nil {
Copy link
Contributor

Choose a reason for hiding this comment

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

big.Int in golang can be negative, we should consider it as well and error out.

cctx3.GetOutboundParams()[0].GasLimit = 2_000_000
cctx3.GetOutboundParams()[0].GasPrice = gwei(3).String()

for _, tt := range []struct {
Copy link
Contributor

Choose a reason for hiding this comment

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

Some other cases would be helpful, such as cases where priorityFee is null, negative, etc.

zetaclient/chains/evm/signer/outbound_data.go Show resolved Hide resolved

// determineDestination picks the destination address and Chain ID based on the status of the cross chain tx.
// returns true if transaction should be skipped.
func determineDestination(cctx *types.CrossChainTx, logger zerolog.Logger) (ethcommon.Address, *big.Int, bool) {
Copy link
Contributor

Choose a reason for hiding this comment

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

cctx can be null here, could we introduce a check to have a defensive approach on this func?

}

func getCCTXIndex(cctx *types.CrossChainTx) ([32]byte, error) {
cctxIndexSlice, err := hex.DecodeString(cctx.Index[2:]) // remove the leading 0x
Copy link
Contributor

Choose a reason for hiding this comment

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

This would probably panic (depending how DecodeString is implemented) if cctx is null. Consider adding a null check before this.

@lumtis lumtis marked this pull request as draft July 18, 2024 17:59
@swift1337
Copy link
Contributor Author

This PR is obsolete. I'll create a new one.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Support EIP-1559 transactions with ZetaClient
5 participants