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: Add initial support for Blobscan #363

Merged
merged 16 commits into from
Nov 29, 2023
Merged
Show file tree
Hide file tree
Changes from 12 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ Specifically, this [package][package-reference] will:
3. Spin up a [transaction spammer](https://github.com/MariusVanDerWijden/tx-fuzz) to send fake transactions to the network
4. Spin up and connect a [testnet verifier](https://github.com/ethereum/merge-testnet-verifier)
5. Spin up a Grafana and Prometheus instance to observe the network
6. Spin up a Blobscan instance to analyze blob transactions (EIP-4844)

Optional features (enabled via flags or parameter files at runtime):

Expand Down Expand Up @@ -273,6 +274,7 @@ additional_services:
- dora
- full_beaconchain_explorer
- prometheus_grafana
- blobscan

# If set, the package will block until a finalized epoch has occurred.
wait_for_finalization: false
Expand Down
17 changes: 16 additions & 1 deletion main.star
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ beacon_metrics_gazer = import_module(
"./src/beacon_metrics_gazer/beacon_metrics_gazer_launcher.star"
)
dora = import_module("./src/dora/dora_launcher.star")
blobscan = import_module("./src/blobscan/blobscan_launcher.star")
PabloCastellano marked this conversation as resolved.
Show resolved Hide resolved
full_beaconchain_explorer = import_module(
"./src/full_beaconchain/full_beaconchain_launcher.star"
)
Expand Down Expand Up @@ -265,6 +266,7 @@ def run(plan, args={}):
return output

launch_prometheus_grafana = False
SERVICE_URLS = {}
for additional_service in args_with_right_defaults.additional_services:
if additional_service == "tx_spammer":
plan.print("Launching transaction spammer")
Expand Down Expand Up @@ -328,14 +330,27 @@ def run(plan, args={}):
elif additional_service == "dora":
plan.print("Launching dora")
dora_config_template = read_file(static_files.DORA_CONFIG_TEMPLATE_FILEPATH)
dora.launch_dora(
dora_config = dora.launch_dora(
plan,
dora_config_template,
all_cl_client_contexts,
el_cl_data_files_artifact_uuid,
network_params.electra_fork_epoch,
)
plan.print("Successfully launched dora")
SERVICE_URLS["dora"] = "http://{0}:{1}".format(
dora_config.ip_address, dora_config.ports["http"].number
)
PabloCastellano marked this conversation as resolved.
Show resolved Hide resolved
elif additional_service == "blobscan":
plan.print("Launching blobscan")
blobscan.launch_blobscan(
plan,
all_cl_client_contexts,
all_el_client_contexts,
network_params.network_id,
SERVICE_URLS.get("dora", "https://beaconscan.com"),
)
plan.print("Successfully launched blobscan")
elif additional_service == "full_beaconchain_explorer":
plan.print("Launching full-beaconchain-explorer")
full_beaconchain_explorer_config_template = read_file(
Expand Down
124 changes: 124 additions & 0 deletions src/blobscan/blobscan_launcher.star
Original file line number Diff line number Diff line change
@@ -0,0 +1,124 @@
shared_utils = import_module("../shared_utils/shared_utils.star")
postgres = import_module("github.com/kurtosis-tech/postgres-package/main.star")

WEB_SERVICE_NAME = "blobscan-web"
API_SERVICE_NAME = "blobscan-api"
INDEXER_SERVICE_NAME = "blobscan-indexer"

HTTP_PORT_ID = "http"
WEB_HTTP_PORT_NUMBER = 3000
API_HTTP_PORT_NUMBER = 3001

WEB_PORTS = {
HTTP_PORT_ID: shared_utils.new_port_spec(
WEB_HTTP_PORT_NUMBER,
shared_utils.TCP_PROTOCOL,
shared_utils.HTTP_APPLICATION_PROTOCOL,
)
}


API_PORTS = {
HTTP_PORT_ID: shared_utils.new_port_spec(
API_HTTP_PORT_NUMBER,
shared_utils.TCP_PROTOCOL,
shared_utils.HTTP_APPLICATION_PROTOCOL,
)
}

ENTRYPOINT_ARGS = ["/bin/sh", "-c"]


def launch_blobscan(
plan,
cl_client_contexts,
el_client_contexts,
chain_id,
beacon_explorer,
):
beacon_node_rpc_uri = "http://{0}:{1}".format(
cl_client_contexts[0].ip_addr, cl_client_contexts[0].http_port_num
)
execution_node_rpc_uri = "http://{0}:{1}".format(
el_client_contexts[0].ip_addr, el_client_contexts[0].rpc_port_num
)

postgres_output = postgres.run(plan)
barnabasbusa marked this conversation as resolved.
Show resolved Hide resolved
barnabasbusa marked this conversation as resolved.
Show resolved Hide resolved
api_config = get_api_config(postgres_output.url, beacon_node_rpc_uri, chain_id)
blobscan_config = plan.add_service(API_SERVICE_NAME, api_config)

blobscan_api_url = "http://{0}:{1}".format(
blobscan_config.ip_address, blobscan_config.ports[HTTP_PORT_ID].number
)

web_config = get_web_config(
postgres_output.url, beacon_explorer, beacon_node_rpc_uri, chain_id
)
plan.add_service(WEB_SERVICE_NAME, web_config)

indexer_config = get_indexer_config(
beacon_node_rpc_uri, execution_node_rpc_uri, blobscan_api_url
)
plan.add_service(INDEXER_SERVICE_NAME, indexer_config)


def get_api_config(database_url, beacon_node_rpc, chain_id):
IMAGE_NAME = "blossomlabs/blobscan:stable"

return ServiceConfig(
image=IMAGE_NAME,
ports=API_PORTS,
env_vars={
"BEACON_NODE_ENDPOINT": beacon_node_rpc,
"CHAIN_ID": chain_id,
"DATABASE_URL": database_url,
"SECRET_KEY": "supersecret",
},
cmd=["api"],
ready_conditions=ReadyCondition(
recipe=GetHttpRequestRecipe(
port_id="http",
endpoint="/api/healthcheck",
),
field="code",
assertion="==",
target_value=200,
interval="5s",
timeout="5s",
),
)


def get_web_config(database_url, beacon_explorer, beacon_node_rpc, chain_id):
IMAGE_NAME = "blossomlabs/blobscan:stable"

return ServiceConfig(
image=IMAGE_NAME,
ports=WEB_PORTS,
env_vars={
"DATABASE_URL": database_url,
"SECRET_KEY": "supersecret",
"NEXT_PUBLIC_NETWORK_NAME": "kurtosis-devnet",
"NEXT_PUBLIC_BEACON_BASE_URL": beacon_explorer,
"NEXT_PUBLIC_EXPLORER_BASE_URL": beacon_explorer,
"BEACON_NODE_ENDPOINT": beacon_node_rpc,
"CHAIN_ID": chain_id,
},
cmd=["web"],
)


def get_indexer_config(beacon_node_rpc, execution_node_rpc, blobscan_api_url):
IMAGE_NAME = "blossomlabs/blobscan-indexer:master"

return ServiceConfig(
image=IMAGE_NAME,
env_vars={
"SECRET_KEY": "supersecret",
"BLOBSCAN_API_ENDPOINT": blobscan_api_url,
"EXECUTION_NODE_ENDPOINT": execution_node_rpc,
"BEACON_NODE_ENDPOINT": beacon_node_rpc,
},
entrypoint=ENTRYPOINT_ARGS,
cmd=[" && ".join(["sleep 90", "/app/blob-indexer"])],
)
4 changes: 2 additions & 2 deletions src/cl/teku/teku_launcher.star
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,8 @@ METRICS_PORT_NUM = 8008
# The min/max CPU/memory that the beacon node can use
BEACON_MIN_CPU = 50
BEACON_MAX_CPU = 1000
BEACON_MIN_MEMORY = 512
BEACON_MAX_MEMORY = 1024
BEACON_MIN_MEMORY = 1024
barnabasbusa marked this conversation as resolved.
Show resolved Hide resolved
BEACON_MAX_MEMORY = 2048

# 1) The Teku container runs as the "teku" user
# 2) Teku requires write access to the validator secrets directory, so it can write a lockfile into it as it uses the keys
Expand Down
2 changes: 1 addition & 1 deletion src/dora/dora_launcher.star
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ def launch_dora(
electra_fork_epoch,
)

plan.add_service(SERVICE_NAME, config)
return plan.add_service(SERVICE_NAME, config)


def get_config(
Expand Down