evm sdk

[webpiratt]

Closes: #102

Summary by CodeRabbit

• Refactor

  • Streamlined Ethereum transaction handling in the payroll plugin by consolidating client and nonce management into a unified SDK interface.
  • Simplified transaction creation and broadcasting by delegating to the SDK, removing custom encoding and signing logic.
  • Removed transaction monitoring and error handling logic to reduce internal complexity.

• Chores

  • Updated dependencies to the latest versions.
  • Updated configuration field types across multiple services to simplify and standardize block storage and related settings.

[coderabbitai]

Walkthrough

This change refactors the payroll plugin's Ethereum transaction handling by removing all custom transaction encoding, signing, and monitoring logic, and replacing it with calls to an external EVM SDK. The plugin now uses the SDK for transaction creation, signing, sending, and nonce management, consolidating related logic and interfaces.

Changes

File(s)	Change Summary
plugin/payroll/monitoring.go	Deleted file that handled Ethereum transaction monitoring and error classification.
plugin/payroll/payroll.go	Refactored PayrollPlugin struct: replaced rpcClient and nonceManager with eth *evm.SDK; updated constructor; removed GetNextNonce.
plugin/payroll/transaction.go	Removed all custom Ethereum transaction encoding, signing, and gas estimation logic; switched to using p.eth SDK interface for all EVM transaction operations.
go.mod	Updated github.com/vultisig/recipes and github.com/vultisig/verifier dependencies to newer versions.
cmd/dca/server/config.go	Changed BlockStorage field type from vault_config.BlockStorageConfig to vault_config.BlockStorage.
cmd/dca/worker/config.go	Changed BlockStorage field type from vault_config.BlockStorageConfig to vault_config.BlockStorage; formatting changes for Redis and VaultServiceConfig.
cmd/fees/server/config.go	Changed BlockStorage field type from vault_config.BlockStorageConfig to vault_config.BlockStorage; formatting changes for Redis and BaseConfigPath.
cmd/fees/worker/config.go	Changed BlockStorage field type from vault_config.BlockStorageConfig to vault_config.BlockStorage; formatting changes for other fields.
cmd/payroll/server/config.go	Changed BlockStorage field type from vault_config.BlockStorageConfig to vault_config.BlockStorage; formatting changes for Redis and BaseConfigPath.
cmd/payroll/worker/config.go	Changed BlockStorage field type from vault_config.BlockStorageConfig to vault_config.BlockStorage; formatting changes for Redis and VaultServiceConfig.
plugin/fees/fees.go	Changed BlockStorage field type from vault_config.BlockStorageConfig to vault_config.BlockStorage.
scripts/dev/create_fee_policy/dummy_server.go	Changed BlockStorage field type from vault_config.BlockStorageConfig to vault_config.BlockStorage; formatting changes for Redis and BaseConfigPath.

Sequence Diagram(s)

sequenceDiagram
    participant Plugin as PayrollPlugin
    participant SDK as EVM SDK
    participant Chain as Ethereum Chain

    Plugin->>SDK: MakeAnyTransfer(sender, recipient, amount, tokenID)
    SDK->>Chain: Build unsigned transaction
    SDK-->>Plugin: Return unsigned tx bytes

    Plugin->>SDK: Send(tx bytes, signature)
    SDK->>Chain: Broadcast signed transaction
    SDK-->>Plugin: Return send result

Loading

Assessment against linked issues

Objective	Addressed	Explanation
Replace local transaction build functions with EVM SDK (#102)	✅

Assessment against linked issues: Out-of-scope changes

No out-of-scope changes found.

Possibly related PRs

• evm transfer native #97: Refactors and renames the manual transaction construction methods that are now deleted and replaced by SDK calls in this PR.
• rework and fix eth tx calldata/fee build #96: Introduces the manual transaction construction helpers and logic that this PR now removes in favor of SDK abstraction.
• tx replay protection #95: Adds tx replay protection and indexing logic that overlaps with the deleted monitoring code in this PR.

Suggested reviewers

• johnnyluo

Poem

A hop, a leap, a jump so spry,
Old code for Ethereum, we say goodbye!
Now SDK leads the way,
Building, signing—no delay.
With every hop, our code grows neat—
Payroll hops on nimble feet!
🐇✨

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 golangci-lint (1.64.8)

level=warning msg="[runner] Can't run linter goanalysis_metalinter: buildir: failed to load package session: could not load export data: no export data for "github.com/vultisig/go-wrappers/go-dkls/sessions""
level=error msg="Running error: can't run linter goanalysis_metalinter\nbuildir: failed to load package session: could not load export data: no export data for "github.com/vultisig/go-wrappers/go-dkls/sessions""

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5baecef and 890cdcb.

📒 Files selected for processing (8)

• cmd/dca/server/config.go (1 hunks)
• cmd/dca/worker/config.go (1 hunks)
• cmd/fees/server/config.go (1 hunks)
• cmd/fees/worker/config.go (1 hunks)
• cmd/payroll/server/config.go (1 hunks)
• cmd/payroll/worker/config.go (1 hunks)
• plugin/fees/fees.go (1 hunks)
• scripts/dev/create_fee_policy/dummy_server.go (1 hunks)

✅ Files skipped from review due to trivial changes (7)

• cmd/fees/server/config.go
• plugin/fees/fees.go
• cmd/dca/server/config.go
• cmd/payroll/server/config.go
• scripts/dev/create_fee_policy/dummy_server.go
• cmd/fees/worker/config.go
• cmd/dca/worker/config.go

🧰 Additional context used

🧠 Learnings (1)

📓 Common learnings

Learnt from: webpiratt
PR: vultisig/plugin#96
File: plugin/payroll/transaction.go:43-44
Timestamp: 2025-06-18T18:22:06.358Z
Learning: In the vultisig/plugin codebase, the hardcoded ethereumEvmChainID = big.NewInt(1) in plugin/payroll/transaction.go is intentional for the current implementation phase. The team is implementing ETH first, with plans to add other EVM chains later. The functions/methods are already designed to work with all EVM chains.

Learnt from: webpiratt
PR: vultisig/plugin#96
File: plugin/payroll/transaction.go:0-0
Timestamp: 2025-06-18T18:23:20.077Z
Learning: In the payroll plugin (plugin/payroll/transaction.go), signRequest.Transaction is stored with the "0x" prefix, making it compatible with gcommon.FromHex which requires 0x-prefixed hex strings.

Learnt from: webpiratt
PR: vultisig/plugin#96
File: plugin/payroll/transaction.go:510-514
Timestamp: 2025-06-18T18:20:59.510Z
Learning: The erc20ABI constant is defined in plugin/payroll/constants.go within the payroll package, making it accessible to other files in the same package like transaction.go.

Learnt from: webpiratt
PR: vultisig/plugin#96
File: plugin/payroll/transaction.go:178-183
Timestamp: 2025-06-18T18:28:19.759Z
Learning: In the payroll plugin, the Hash field in PluginKeysignRequest is intentionally set to the unsigned transaction hex (same as Message field) because computing a hash with empty V,R,S signature fields doesn't make sense, and it's documented as "not on-chain hash without signature". This is a deliberate placeholder approach.

⏰ Context from checks skipped due to timeout of 90000ms (2)

• GitHub Check: build
• GitHub Check: migration-test

🔇 Additional comments (2)

cmd/payroll/worker/config.go (2)

14-14: LGTM: Formatting consistency maintained.

The formatting adjustments for the Redis and VaultServiceConfig fields maintain proper alignment and consistency within the struct definition.

Also applies to: 16-16

---

14-16: Verify type compatibility for BlockStorage field change.

The type change from vault_config.BlockStorageConfig to vault_config.BlockStorage needs verification to ensure compatibility and prevent compilation errors.

#!/bin/bash
# Description: Verify the BlockStorage type exists and check for any compilation errors
# Expected: The new type should be defined and compatible

# Check if the new BlockStorage type exists in vault_config
ast-grep --pattern 'type BlockStorage $_'

# Check for any remaining references to the old BlockStorageConfig type
rg 'BlockStorageConfig' -A 3

# Look for the BlockStorage type definition to understand its structure
ast-grep --pattern 'type BlockStorage struct {
  $$$
}'

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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>, please review it.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 using 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 generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration 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.