Major refactoring on users and batch requests

- added batch request support for Solana
- enabled batch request mode to be enabled and batch size can also be configured via cli argument
- added batch request support for single method tests, all profiles (except Oasis)
- added support for trace_call, trace_callMany and trace_filter in EvmUser

Author: erwin-wee

README.md

@@ -123,6 +123,7 @@ This will run a load test with a general BSC profile.
 - `-E, --exclude-tags`: Exclude tasks tagged with custom tags from the test. You may specify this option multiple times.
 - `--use-latest-blocks`: Use latest blocks for test data generation and runs a background process to update the test data with latest blocks.
 - `--size`: Specifies the test data size. Available values are XS, S, M, L, XL. Default is S.
+- '--batch': Runs the test using batch requests. This will send multiple requests in a single batch request. The number of requests in a batch can be specified using the `--batch-size` flag. Default batch size is 10.
 
 You may also run `chainbench start --help` for the full list of parameters and flags.
 

chainbench/main.py

@@ -10,7 +10,8 @@
 import gevent.pool
 from click import Context, Parameter
 
-from chainbench.user.tasks import all_method_classes, all_methods, get_subclass_tasks
+from chainbench.user import get_subclass_tasks
+from chainbench.user.common import all_method_classes, all_methods
 from chainbench.util.cli import (
     ContextData,
     LocustOptions,
@@ -147,6 +148,17 @@ def validate_profile(ctx: Context, param: Parameter, value: str) -> str:
     type=click.Choice(["head-lag-monitor"], case_sensitive=False),
     multiple=True,
 )
+@click.option(
+    "--batch",
+    is_flag=True,
+    help="Run tests in batch mode. This will make requests in batches for json-rpc methods. The number of requests in "
+    "a batch can be specified using the `--batch-size` flag",
+)
+@click.option(
+    "--batch-size",
+    default=10,
+    help="The number of requests in " "a batch for json-rpc methods. This flag is only used when `--batch` flag is set",
+)
 @click.option(
     "--debug-trace-methods",
     is_flag=True,
@@ -190,6 +202,8 @@ def start(
     run_id: str | None,
     notify: str | None,
     monitor: list[str],
+    batch: bool,
+    batch_size: int,
     debug_trace_methods: bool,
     exclude_tags: list[str],
     timescale: bool,
@@ -290,7 +304,18 @@ def start(
             custom_exclude_tags.append(tag)
 
     if not debug_trace_methods:
-        custom_exclude_tags = custom_exclude_tags + ["trace", "debug"]
+        custom_exclude_tags.extend(["trace", "debug"])
+
+    custom_tags: list[str] = []
+
+    if batch:
+        custom_tags = ["batch_single" if method else "batch"]
+    else:
+        if method:
+            custom_tags.append("single")
+        else:
+            custom_exclude_tags.append("single")
+        custom_exclude_tags.extend(["batch", "batch_single"])
 
     locust_options = LocustOptions(
         profile_path=profile_path,
@@ -304,6 +329,7 @@ def start(
         workers=workers,
         headless=headless,
         target=target,
+        custom_tags=custom_tags,
         exclude_tags=custom_exclude_tags,
         timescale=timescale,
         pg_host=pg_host,
@@ -315,6 +341,7 @@ def start(
         size=size,
         method=method,
         enable_class_picker=enable_class_picker,
+        batch_size=batch_size,
     )
     # Start the Locust master
     master_command = locust_options.get_master_command()

chainbench/profile/arbitrum/general.py

@@ -4,38 +4,37 @@
 
 from locust import constant_pacing
 
-from chainbench.user.tasks import EvmTasks
-from chainbench.user.tasks.common import expand_tasks
+from chainbench.user.protocol.evm import EvmUser
 
 
-class ArbitrumProfile(EvmTasks):
+class ArbitrumProfile(EvmUser):
     wait_time = constant_pacing(1)
-    tasks = expand_tasks(
-        {
-            EvmTasks.eth_call_task: 1007,
-            EvmTasks.eth_get_block_by_number_task: 592,
-            EvmTasks.eth_get_logs_task: 397,
-            EvmTasks.eth_chain_id_task: 186,
-            EvmTasks.eth_get_transaction_receipt_task: 168,
-            EvmTasks.eth_block_number_task: 165,
-            EvmTasks.eth_get_block_by_hash_task: 61,
-            EvmTasks.eth_get_balance_task: 50,
-            EvmTasks.debug_trace_transaction_task: 48,
-            EvmTasks.eth_estimate_gas_task: 28,
-            EvmTasks.eth_gas_price_task: 22,
-            EvmTasks.eth_get_transaction_count_task: 17,
-            EvmTasks.eth_get_transaction_by_hash_task: 14,
-            EvmTasks.eth_get_block_receipts_task: 12,
-            EvmTasks.debug_trace_block_by_number_task: 12,
-            EvmTasks.eth_get_code_task: 7,
-            EvmTasks.eth_max_priority_fee_per_gas_task: 5,
-            EvmTasks.web3_client_version_task: 3,
-            EvmTasks.debug_trace_block_by_hash_task: 3,
-            EvmTasks.net_listening_task: 2,
-            EvmTasks.net_version_task: 2,
-            EvmTasks.eth_syncing_task: 1,
-            EvmTasks.eth_fee_history_task: 1,
-            EvmTasks.eth_get_transaction_by_block_hash_and_index_task: 1,
-            EvmTasks.debug_trace_call_task: 1,
-        }
-    )
+    rpc_calls = {
+        EvmUser.eth_call: 1007,
+        EvmUser.eth_get_block_by_number: 592,
+        EvmUser.eth_get_logs: 397,
+        EvmUser.eth_chain_id: 186,
+        EvmUser.eth_get_transaction_receipt: 168,
+        EvmUser.eth_block_number: 165,
+        EvmUser.eth_get_block_by_hash: 61,
+        EvmUser.eth_get_balance: 50,
+        EvmUser.debug_trace_transaction: 48,
+        EvmUser.eth_estimate_gas: 28,
+        EvmUser.eth_gas_price: 22,
+        EvmUser.eth_get_transaction_count: 17,
+        EvmUser.eth_get_transaction_by_hash: 14,
+        EvmUser.eth_get_block_receipts: 12,
+        EvmUser.debug_trace_block_by_number: 12,
+        EvmUser.eth_get_code: 7,
+        EvmUser.eth_max_priority_fee_per_gas: 5,
+        EvmUser.web3_client_version: 3,
+        EvmUser.debug_trace_block_by_hash: 3,
+        EvmUser.net_listening: 2,
+        EvmUser.net_version: 2,
+        EvmUser.eth_syncing: 1,
+        EvmUser.eth_fee_history: 1,
+        EvmUser.eth_get_transaction_by_block_hash_and_index: 1,
+        EvmUser.debug_trace_call: 1,
+    }
+
+    tasks = EvmUser.expand_tasks(rpc_calls)

chainbench/profile/avalanche/archive.py

@@ -4,34 +4,33 @@
 
 from locust import constant_pacing
 
-from chainbench.user.tasks import EvmTasks
-from chainbench.user.tasks.common import expand_tasks
+from chainbench.user.protocol.evm import EvmUser
 
 
-class AvalancheArchiveProfile(EvmTasks):
+class AvalancheArchiveProfile(EvmUser):
     wait_time = constant_pacing(1)
-    tasks = expand_tasks(
-        {
-            EvmTasks.eth_call_task: 1474,
-            EvmTasks.eth_get_block_by_number_task: 502,
-            EvmTasks.eth_get_transaction_receipt_task: 281,
-            EvmTasks.eth_get_logs_task: 234,
-            EvmTasks.eth_block_number_task: 218,
-            EvmTasks.eth_chain_id_task: 102,
-            EvmTasks.eth_get_code_task: 81,
-            EvmTasks.debug_trace_block_by_number_task: 70,
-            EvmTasks.debug_trace_block_by_hash_task: 42,
-            EvmTasks.eth_get_block_by_hash_task: 41,
-            EvmTasks.eth_syncing_task: 38,
-            EvmTasks.eth_estimate_gas_task: 33,
-            EvmTasks.debug_trace_call_task: 12,
-            EvmTasks.eth_get_transaction_by_hash_task: 12,
-            EvmTasks.web3_client_version_task: 7,
-            EvmTasks.eth_get_balance_task: 6,
-            EvmTasks.eth_get_block_receipts_task: 3,
-            EvmTasks.net_version_task: 3,
-            EvmTasks.eth_get_transaction_count_task: 1,
-            EvmTasks.debug_trace_transaction_task: 1,
-            EvmTasks.eth_gas_price_task: 1,
-        }
-    )
+    rpc_calls = {
+        EvmUser.eth_call: 1474,
+        EvmUser.eth_get_block_by_number: 502,
+        EvmUser.eth_get_transaction_receipt: 281,
+        EvmUser.eth_get_logs: 234,
+        EvmUser.eth_block_number: 218,
+        EvmUser.eth_chain_id: 102,
+        EvmUser.eth_get_code: 81,
+        EvmUser.debug_trace_block_by_number: 70,
+        EvmUser.debug_trace_block_by_hash: 42,
+        EvmUser.eth_get_block_by_hash: 41,
+        EvmUser.eth_syncing: 38,
+        EvmUser.eth_estimate_gas: 33,
+        EvmUser.debug_trace_call: 12,
+        EvmUser.eth_get_transaction_by_hash: 12,
+        EvmUser.web3_client_version: 7,
+        EvmUser.eth_get_balance: 6,
+        EvmUser.eth_get_block_receipts: 3,
+        EvmUser.net_version: 3,
+        EvmUser.eth_get_transaction_count: 1,
+        EvmUser.debug_trace_transaction: 1,
+        EvmUser.eth_gas_price: 1,
+    }
+
+    tasks = EvmUser.expand_tasks(rpc_calls)

chainbench/profile/avalanche/general.py

@@ -4,36 +4,35 @@
 
 from locust import constant_pacing
 
-from chainbench.user.tasks import EvmTasks
-from chainbench.user.tasks.common import expand_tasks
+from chainbench.user.protocol.evm import EvmUser
 
 
-class AvalancheProfile(EvmTasks):
+class AvalancheProfile(EvmUser):
     wait_time = constant_pacing(1)
-    tasks = expand_tasks(
-        {
-            EvmTasks.eth_call_task: 976,
-            EvmTasks.eth_get_block_by_number_task: 516,
-            EvmTasks.eth_get_logs_task: 404,
-            EvmTasks.eth_get_transaction_receipt_task: 223,
-            EvmTasks.eth_block_number_task: 174,
-            EvmTasks.eth_chain_id_task: 155,
-            EvmTasks.eth_get_balance_task: 134,
-            EvmTasks.eth_get_transaction_by_hash_task: 70,
-            EvmTasks.eth_get_block_by_hash_task: 30,
-            EvmTasks.web3_client_version_task: 23,
-            EvmTasks.eth_gas_price_task: 15,
-            EvmTasks.eth_syncing_task: 14,
-            EvmTasks.net_version_task: 7,
-            EvmTasks.eth_get_transaction_count_task: 6,
-            EvmTasks.eth_get_block_receipts_task: 5,
-            EvmTasks.eth_get_code_task: 3,
-            EvmTasks.eth_max_priority_fee_per_gas_task: 2,
-            EvmTasks.eth_estimate_gas_task: 2,
-            EvmTasks.eth_fee_history_task: 2,
-            EvmTasks.debug_trace_transaction_task: 2,
-            EvmTasks.debug_trace_block_by_number_task: 1,
-            EvmTasks.debug_trace_block_by_hash_task: 1,
-            EvmTasks.net_listening_task: 1,
-        }
-    )
+    rpc_calls = {
+        EvmUser.eth_call: 976,
+        EvmUser.eth_get_block_by_number: 516,
+        EvmUser.eth_get_logs: 404,
+        EvmUser.eth_get_transaction_receipt: 223,
+        EvmUser.eth_block_number: 174,
+        EvmUser.eth_chain_id: 155,
+        EvmUser.eth_get_balance: 134,
+        EvmUser.eth_get_transaction_by_hash: 70,
+        EvmUser.eth_get_block_by_hash: 30,
+        EvmUser.web3_client_version: 23,
+        EvmUser.eth_gas_price: 15,
+        EvmUser.eth_syncing: 14,
+        EvmUser.net_version: 7,
+        EvmUser.eth_get_transaction_count: 6,
+        EvmUser.eth_get_block_receipts: 5,
+        EvmUser.eth_get_code: 3,
+        EvmUser.eth_max_priority_fee_per_gas: 2,
+        EvmUser.eth_estimate_gas: 2,
+        EvmUser.eth_fee_history: 2,
+        EvmUser.debug_trace_transaction: 2,
+        EvmUser.debug_trace_block_by_number: 1,
+        EvmUser.debug_trace_block_by_hash: 1,
+        EvmUser.net_listening: 1,
+    }
+
+    tasks = EvmUser.expand_tasks(rpc_calls)

chainbench/profile/base/archive.py

@@ -4,32 +4,31 @@
 
 from locust import constant_pacing
 
-from chainbench.user.tasks import EvmTasks
-from chainbench.user.tasks.common import expand_tasks
+from chainbench.user.protocol.evm import EvmUser
 
 
-class BaseArchiveProfile(EvmTasks):
+class BaseArchiveProfile(EvmUser):
     wait_time = constant_pacing(1)
-    tasks = expand_tasks(
-        {
-            EvmTasks.eth_get_transaction_receipt_task: 1015,
-            EvmTasks.eth_call_task: 211,
-            EvmTasks.eth_get_block_by_number_task: 73,
-            EvmTasks.debug_trace_transaction_task: 36,
-            EvmTasks.eth_block_number_task: 12,
-            EvmTasks.eth_get_transaction_by_hash_task: 9,
-            EvmTasks.eth_chain_id_task: 8,
-            EvmTasks.eth_get_logs_task: 7,
-            EvmTasks.trace_block_task: 6,
-            EvmTasks.eth_get_block_by_hash_task: 6,
-            EvmTasks.eth_get_balance_task: 4,
-            EvmTasks.eth_get_code_task: 2,
-            EvmTasks.eth_get_block_receipts_task: 2,
-            EvmTasks.debug_trace_block_by_hash_task: 1,
-            EvmTasks.debug_trace_block_by_number_task: 1,
-            EvmTasks.net_version_task: 1,
-            EvmTasks.eth_gas_price_task: 1,
-            EvmTasks.eth_max_priority_fee_per_gas_task: 1,
-            EvmTasks.net_listening_task: 1,
-        }
-    )
+    rpc_calls = {
+        EvmUser.eth_get_transaction_receipt: 1015,
+        EvmUser.eth_call: 211,
+        EvmUser.eth_get_block_by_number: 73,
+        EvmUser.debug_trace_transaction: 36,
+        EvmUser.eth_block_number: 12,
+        EvmUser.eth_get_transaction_by_hash: 9,
+        EvmUser.eth_chain_id: 8,
+        EvmUser.eth_get_logs: 7,
+        EvmUser.trace_block: 6,
+        EvmUser.eth_get_block_by_hash: 6,
+        EvmUser.eth_get_balance: 4,
+        EvmUser.eth_get_code: 2,
+        EvmUser.eth_get_block_receipts: 2,
+        EvmUser.debug_trace_block_by_hash: 1,
+        EvmUser.debug_trace_block_by_number: 1,
+        EvmUser.net_version: 1,
+        EvmUser.eth_gas_price: 1,
+        EvmUser.eth_max_priority_fee_per_gas: 1,
+        EvmUser.net_listening: 1,
+    }
+
+    tasks = EvmUser.expand_tasks(rpc_calls)