perf(solidity): remove redundant activeToken condition checks

[zakir-code]

Summary by CodeRabbit

• New Features

  • Enhanced event handling for contract interactions
  • Improved internal function visibility and naming conventions

• Refactor

  • Updated contract bytecode and ABI
  • Renamed internal functions to improve code clarity
  • Streamlined quote retrieval and verification processes

• Bug Fixes

  • Restricted access to internal helper functions
  • Improved contract function encapsulation

[coderabbitai]

Walkthrough

The pull request introduces modifications to the BridgeFeeQuote contract in both Solidity and Go implementation files. The changes primarily focus on refactoring internal function visibility by renaming public functions to have an underscore prefix, indicating they are now internal functions. This includes renaming verifyInput to _verifyInput and quoteIndexKey to _quoteIndexKey. The contract's bytecode and ABI have been updated accordingly, reflecting these structural changes in the contract's implementation.

Changes

File	Change Summary
solidity/contracts/bridge/BridgeFeeQuote.sol	- Renamed verifyInput() to _verifyInput() (internal) - Renamed quoteIndexKey() to _quoteIndexKey() (internal) - Updated function calls to use new internal method names
contract/bridge_fee_quote.sol.go	- Updated BridgeFeeQuoteMetaData with new bytecode and ABI - Added new event structures and iterators - Deprecated standalone ABI and Bin variables

Sequence Diagram

sequenceDiagram
    participant Contract as BridgeFeeQuote
    participant Caller as External Caller
    
    Caller->>Contract: quote()
    Contract->>Contract: _verifyInput()
    Contract->>Contract: _quoteIndexKey()
    Contract-->>Caller: Return Quote

Loading

Possibly related PRs

• perf: remove QuoteInput oracle params #897: Modifications to BridgeFeeQuote contract struct and ABI fields
• perf: change parameter types of hasOracle, isOracleOnline, chainName to bytes32 #898: Changes to oracle parameter types in related functions

Poem

🐰 A Rabbit's Ode to Refactoring 🐰

Internal methods, now with grace,
Underscore dancing in their place
Bytecode shifts, ABI refined
Contract's secrets now aligned
Hop, hop, hooray for clean design! 🚀

---

📜 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 c4b423a and 404edfa.

📒 Files selected for processing (2)

• contract/bridge_fee_quote.sol.go (1 hunks)
• solidity/contracts/bridge/BridgeFeeQuote.sol (6 hunks)

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

• GitHub Check: Mergify Merge Protections
• GitHub Check: Summary

🔇 Additional comments (8)

contract/bridge_fee_quote.sol.go (1)

56-56: Confirm the updated bytecode corresponds with Solidity contract changes

The Bin field at line 56 has been updated, reflecting changes in the compiled bytecode of the BridgeFeeQuote contract. Please verify that this bytecode aligns with the latest modifications made in BridgeFeeQuote.sol, ensuring that the Go bindings accurately represent the current state of the Solidity contract.

solidity/contracts/bridge/BridgeFeeQuote.sol (7)

267-268: Consistent use of _quoteIndexKey in getDefaultOracleQuote

The getDefaultOracleQuote function now uses the internal _quoteIndexKey for key generation, ensuring consistency across the contract and improving code maintainability.

---

287-289: Refactored getQuoteByIndex for cleaner data retrieval

By utilizing _quoteIndexKey and _getQuoteByKey, the getQuoteByIndex function now has improved readability and modularity, reducing code duplication.

---

291-293: Introduction of _getQuoteByKey enhances code reuse

The new internal function _getQuoteByKey centralizes the logic for retrieving quotes based on a key. This promotes code reuse and simplifies maintenance.

---

Line range hint 318-325: Visibility change of _verifyInput improves security

Making _verifyInput an internal function restricts access to the input verification logic, enhancing the security of the contract by preventing unauthorized external calls.

---

Line range hint 88-93: Ensure no external dependencies on quoteIndexKey

The function quoteIndexKey has been renamed to _quoteIndexKey and set to internal, which improves encapsulation. Verify that no external contracts rely on quoteIndexKey, as changing its visibility may affect external integrations.

Run the following script to search for external usages of quoteIndexKey:

✅ Verification successful

✓ No external dependencies found for quoteIndexKey

The rename to _quoteIndexKey and visibility change to internal is safe. No external contracts or interfaces depend on this function.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Search for external calls to `quoteIndexKey` in Solidity contracts excluding `BridgeFeeQuote.sol`.

# Expectation: No occurrences of `quoteIndexKey` called from other contracts.

find . -name '*.sol' -not -path './solidity/contracts/bridge/BridgeFeeQuote.sol' -exec grep -Hn 'quoteIndexKey' {} +

Length of output: 116

---

Script:

#!/bin/bash
# Search for both function names using ripgrep
echo "=== Searching for function names ==="
rg -g '*.sol' 'quoteIndexKey|_quoteIndexKey'

echo -e "\n=== Checking for contracts inheriting from BridgeFeeQuote ==="
ast-grep --pattern 'contract $_ is $$$ BridgeFeeQuote $$$'

echo -e "\n=== Checking for interface definitions ==="
ast-grep --pattern 'interface $_ {
  $$$
  function quoteIndexKey($$$) $$$;
  $$$
}'

Length of output: 914

---

77-77: Ensure no external dependencies on verifyInput

Renaming verifyInput to _verifyInput and changing its visibility to internal enhances encapsulation and adheres to Solidity best practices. However, this might impact external contracts or interfaces that previously depended on verifyInput. Please verify that no external calls to verifyInput exist in the codebase or in dependent projects.

Run the following script to search for external usages of verifyInput:

✅ Verification successful

No external dependencies found for verifyInput

The change from verifyInput to _verifyInput is safe as there are no external contracts or interfaces depending on this function. All references to this function are contained within BridgeFeeQuote.sol.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Search for external calls to `verifyInput` in Solidity contracts excluding `BridgeFeeQuote.sol`.

# Expectation: No occurrences of `verifyInput` called from other contracts.

find . -name '*.sol' -not -path './solidity/contracts/bridge/BridgeFeeQuote.sol' -exec grep -Hn 'verifyInput' {} +

Length of output: 114

---

Script:

#!/bin/bash
# Search for both verifyInput and _verifyInput using ripgrep
echo "=== Searching for function calls and definitions ==="
rg -l "verifyInput|_verifyInput" --type sol

echo -e "\n=== Checking for interface definitions ==="
ast-grep --pattern 'interface $_ {
  $$$
  verifyInput($$$);
  $$$
}'

echo -e "\n=== Checking for contract inheritance ==="
ast-grep --pattern 'contract $_ is BridgeFeeQuote {
  $$$
}'

Length of output: 523

---

Script:

#!/bin/bash
# Search with file extension pattern and show context
echo "=== Searching for function calls with context ==="
rg -C 2 "verifyInput|_verifyInput" "*.sol"

echo -e "\n=== Searching specifically in contracts directory ==="
cd solidity/contracts 2>/dev/null && rg -C 2 "verifyInput|_verifyInput" --glob "*.sol" || echo "No contracts directory found"

Length of output: 909

---

Line range hint 342-346: Ensure no external dependencies on quoteIndexKey

Renaming quoteIndexKey to _quoteIndexKey and changing its visibility to internal reinforces its role as an internal utility function. Verify that there are no external contracts depending on quoteIndexKey.

Run the following script to search for external usages of quoteIndexKey:

✅ Verification successful

No external dependencies found for quoteIndexKey

The function can be safely renamed to _quoteIndexKey and made internal as there are no external contracts depending on it.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Search for external calls to `quoteIndexKey` in Solidity contracts excluding `BridgeFeeQuote.sol`.

# Expectation: No occurrences of `quoteIndexKey` called from other contracts.

find . -name '*.sol' -not -path './solidity/contracts/bridge/BridgeFeeQuote.sol' -exec grep -Hn 'quoteIndexKey' {} +

Length of output: 116

---

Script:

#!/bin/bash
# Search for function calls and interface definitions using ast-grep
ast-grep --pattern 'quoteIndexKey'

# Backup search with ripgrep for any textual occurrences
rg -i 'quoteIndexKey' --type sol -g '!BridgeFeeQuote.sol'

# Search for potential interface definitions
ast-grep --pattern 'interface $_$ {
  $$$
  function quoteIndexKey($$$);
  $$$
}'

Length of output: 204

---

Script:

#!/bin/bash
# Add Solidity file type definition
rg --type-add 'sol:*.sol' -i 'quoteIndexKey' --type sol -g '!*BridgeFeeQuote.sol'

# Search for function calls in contracts
ast-grep --pattern 'contract $_ {
  $$$
  $_.quoteIndexKey($$$)
  $$$
}'

# Search for interface definitions
ast-grep --pattern 'interface $_ {
  $$$
  function quoteIndexKey($$$)
  $$$
}'

# Search for contract inheritance
ast-grep --pattern 'contract $_ is $$$BridgeFeeQuote$$$'

Length of output: 297

✨ Finishing Touches

• 📝 Generate Docstrings (Beta)

---

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

• 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.
  • 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 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 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 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. (Beta)
• @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.

[fx0x55]

@coderabbitai review

[coderabbitai]

✅ 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.