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

Problem: concurrent send_tx shares web3 instance #1562

Closed
wants to merge 3 commits into from

Conversation

yihuang
Copy link
Collaborator

@yihuang yihuang commented Aug 30, 2024

it might limit the concurrent performance

Solution:

  • use independent web3 instance.

it seems improve a bit locally here, can you try to reproduce the improvement? @mmsqe

👮🏻👮🏻👮🏻 !!!! REFERENCE THE PROBLEM YOUR ARE SOLVING IN THE PR TITLE AND DESCRIBE YOUR SOLUTION HERE !!!! DO NOT FORGET !!!! 👮🏻👮🏻👮🏻

PR Checklist:

  • Have you read the CONTRIBUTING.md?
  • Does your PR follow the C4 patch requirements?
  • Have you rebased your work on top of the latest master?
  • Have you checked your code compiles? (make)
  • Have you included tests for any non-trivial functionality?
  • Have you checked your code passes the unit tests? (make test)
  • Have you checked your code formatting is correct? (go fmt)
  • Have you checked your basic code style is fine? (golangci-lint run)
  • If you added any dependencies, have you checked they do not contain any known vulnerabilities? (go list -json -m all | nancy sleuth)
  • If your changes affect the client infrastructure, have you run the integration test?
  • If your changes affect public APIs, does your PR follow the C4 evolution of public contracts?
  • If your code changes public APIs, have you incremented the crate version numbers and documented your changes in the CHANGELOG.md?
  • If you are contributing for the first time, please read the agreement in CONTRIBUTING.md now and add a comment to this pull request stating that your PR is in accordance with the Developer's Certificate of Origin.

Thank you for your code, it's appreciated! :)

Summary by CodeRabbit

  • New Features

    • Enhanced transaction sending functionality by connecting to a local Ethereum node.
    • Incorporated chain ID into transaction parameters for improved accuracy and validation.
  • Bug Fixes

    • Ensured proper association of transactions with the intended blockchain network.
    • Streamlined function logic for improved performance, though error handling has been removed.

it might limit the concurrent performance
@yihuang yihuang requested a review from a team as a code owner August 30, 2024 04:10
@yihuang yihuang requested review from mmsqe and devashishdxt and removed request for a team August 30, 2024 04:10
Copy link
Contributor

coderabbitai bot commented Aug 30, 2024

Walkthrough

The changes modify the sendtx function by removing the w3 parameter and initializing a new instance of web3.Web3 within the function. This establishes a connection to a local Ethereum node at "http://localhost:8545" and retrieves the chain ID for inclusion in the transaction parameters. These adjustments ensure that transactions are correctly associated with the intended blockchain network.

Changes

Files Change Summary
testground/benchmark/benchmark/sendtx.py Modified the sendtx function to remove the w3 parameter, connect to a local Ethereum node, and include the chain ID in transactions.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant sendtx
    participant Web3
    participant EthereumNode

    User->>sendtx: Call sendtx(acct, tx_amount)
    sendtx->>Web3: Initialize connection to http://localhost:8545
    Web3->>EthereumNode: Connect to Ethereum node
    sendtx->>Web3: Retrieve chain_id
    Web3->>sendtx: Return chain_id
    sendtx->>EthereumNode: Send transaction with chainId
    EthereumNode-->>sendtx: Confirm transaction
    sendtx-->>User: Return transaction result
Loading

Poem

🐇
In the meadow where transactions flow,
A rabbit hops, with a cheerful glow.
With a nod to the chain, and a wink to the node,
Sending bytes on a vibrant road.
Hooray for the changes, let’s dance and play,
For Ethereum's magic is here to stay!
🌼


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

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between eb0a15d and ef93404.

Files selected for processing (1)
  • testground/benchmark/benchmark/sendtx.py (2 hunks)
Additional comments not posted (1)
testground/benchmark/benchmark/sendtx.py (1)

55-55: LGTM!

The inclusion of the chainId in the transaction dictionary is correct and necessary for proper transaction validation and execution.

The code changes are approved.

testground/benchmark/benchmark/sendtx.py Show resolved Hide resolved
testground/benchmark/benchmark/sendtx.py Show resolved Hide resolved
Copy link

codecov bot commented Aug 30, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 15.24%. Comparing base (eb0a15d) to head (20b1cb3).
Report is 20 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main    #1562   +/-   ##
=======================================
  Coverage   15.24%   15.24%           
=======================================
  Files          67       67           
  Lines        4874     4874           
=======================================
  Hits          743      743           
  Misses       4037     4037           
  Partials       94       94           

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between ef93404 and 7c10fe9.

Files selected for processing (1)
  • testground/benchmark/benchmark/sendtx.py (3 hunks)
Additional comments not posted (2)
testground/benchmark/benchmark/sendtx.py (2)

34-35: Avoid reinitializing the web3 instance inside the function.

Reinitializing the web3.Web3 instance inside the sendtx function can lead to performance issues and unnecessary overhead. Instead, pass the w3 instance as an argument to the function and use it directly.

Remove the reinitialization of the w3 instance:

-def sendtx(acct: Account, tx_amount: int):
-    w3 = web3.Web3(web3.providers.HTTPProvider("http://localhost:8545"))
+def sendtx(w3: web3.Web3, acct: Account, tx_amount: int):

36-36: Ensure the chain ID is retrieved only once.

Retrieving the chain_id multiple times can lead to inconsistencies. Ensure it is retrieved only once and reused throughout the function.

Move the chain_id retrieval outside the function if it is used in multiple places:

-def sendtx(acct: Account, tx_amount: int):
-    chain_id = w3.eth.chain_id
+def sendtx(w3: web3.Web3, acct: Account, tx_amount: int, chain_id: int):

testground/benchmark/benchmark/sendtx.py Show resolved Hide resolved
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 7c10fe9 and 20b1cb3.

Files selected for processing (1)
  • testground/benchmark/benchmark/sendtx.py (4 hunks)
Files skipped from review as they are similar to previous changes (1)
  • testground/benchmark/benchmark/sendtx.py

@yihuang yihuang marked this pull request as draft August 30, 2024 04:56
@yihuang
Copy link
Collaborator Author

yihuang commented Sep 19, 2024

fixed with asyncio: #1587

@yihuang yihuang closed this Sep 19, 2024
@yihuang yihuang deleted the optim-tx-sending branch September 19, 2024 02:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants