gas-cost-estimator

KO | EN

gitlite — search

#python #javascript #css #flutter #html #dart #android #raspberry-pi #arduino #api #minecraft #kotlin

gas-cost-estimator

★ 63 Open GitHub ↗

No description available.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Gas Cost Estimator

The project aims to provide a tool for measuring, analysing and comparing gas costs of EVM operations across different implementations. The reproducibility is the key to the research. We have provided a complete setup guide and tooling to make the execution of the benchmarks as easy as possible.

The result of the analysis is a proposal for the new gas cost schedule.

## Overview

The [Gas Cost Schedule Proposal](docs/gas-schedule-proposal.md) document is ready!

You can learn more about how we have conducted the research and put forward the proposal from this [document](docs/report_stage_iv.md). For the detailed analysis, head to the [reports](docs/reports/) directory, where you can find the results reports for each EVM implementation.

The reproducibility is the key! See our [guide](docs/diy.md) to learn how to run the benchmarks on your own and generate the reports.

[License](LICENSE), [Terms of Use](TOU), [Disclaimer](DISCLAIMER)

## Research progress

The project is divided into stages. The progress of each stage is described in the corresponding document:

- [Stage I](docs/report_stage_i.md) - Initial research and methodology proposal
- [Stage II](docs/report_stage_ii.md) - Benchmarking and data collection
- [Stage III](docs/report_stage_iii.md) - Data analysis and report generation
- [Stage IV](docs/report_stage_iv.md) - Comprehensive analysis of the gas cost and reproducibility
- Stage V - [BLS12-381 analysis](docs/report_stage_v_bls.md) and [Impact report](docs/report_stage_v_impact.md)

## Introduction and project scope

### EVM Implementations

We have included the following EVM implementations in the research:

- EvmOne
- Go Ethereum
- Erigon
- EthereumJS
- Nethermind
- Revm
- Besu

More implementations can be added in the future, depending on the community feedback, implementation maturity and availability of the resources.

### Measured OPCODEs and precompiles

We measure all OPCODEs together with the precompiles as of hard fork Cancun.

### Tooling and automation

The release contains precompiled binaries for easy execution. The binaries are available for Linux x64, MacOS x64 and Windows.

Additionally, we provide a complete setup guide to compile the EVM implementations and run the benchmarks.

## Quick start

If you plan to compile and run benchmarks on your own, you need the following tools installed:

- Python 3.8+
- Go 1.24+
- Rust 1.87+
- Node.js 18.0.0+
- .NET 9.0.2+
- Java 21.0.0+

You can use [setup_tools.sh](scripts/setup_tools.sh) script to install the required tools on Linux. The best is to edit the script according to your needs and run it.

To download and compile the EVM implementations, run the following commands:

```bash
./scripts/setup_clients.sh
```

If your configuration is different, follow the steps in the script. The end results should be the same - you should have all the EVM implementations compiled and copied to the `../gas-cost-estimator-clients/build` directory.

To run the benchmarks, use the provided Python script:

```bash
python3 ./src/instrumentation_measurement/measurements.py measure --input_file ./src/stage4/pg_marginal_full5_c50_step5_shuffle.csv --evm evm_name --sample_size 10
```

Where `evm_name` is the name of the EVM implementation you want to measure.

## Docker - reports

In order to build locally the docker image execute in the repository root

```shell
docker build ./src/analysis -f Dockerfile.reports -t imapp-pl/gas-cost-estimator/reports:4.1
```

Note that the context is `./src/analysis` in order to decrease the data size.
The image includes the report notebooks -- files.
But the bytecode programs and measurement resutls need to be provided.
For now, use `/data` volume to pass input files and retrieve an output report.

To render `measure_marginal` report provide your params and an output file and execute the command:

```shell
docker run -it -v /your/path/to/data:/data --rm imapp-pl/gas-cost-estimator/reports:4.1 Rscript -e "rmarkdown::render('/reports/measure_marginal_single.Rmd', params = list(env = 'erigon', programs='pg_marginal_full5_c50_step1_shuffle.csv', results='erigon_pg_marginal_full5_c50_step1_shuffle_size_10.csv', output_estimated_cost='erigon_marginal_estimated_cost.csv'), output_file = '/data/erigon_measure_marginal_single.html')"
```

To render `measure_arguments` report provide your params and an output file and execute the command:

```shell
docker run -it -v /your/path/to/data:/data --rm imapp-pl/gas-cost-estimator/reports:4.1 Rscript -e "rmarkdown::render('/reports/measure_arguments_single.Rmd', params = list(env = 'erigon', programs='pg_arguments_full5_c200_opc15x2.csv', results='erigon_pg_arguments_full5_c200_opc15x2_.csv', marginal_estimated_cost='erigon_marginal_estimated_cost.csv', output_estimated_cost='erigon_arguments_estimated_cost.csv'), output_file = '/data/erigon_measure_arguments_single.html')"
```

To render `final_estimate` report provide your params and an output file and execute the command:

```shell
docker run -it -v /your/path/to/data:/data --rm imapp-pl/gas-cost-estimator/reports:4.1 Rscript -e "rmarkdown::render('/reports/final_estimation.Rmd', params = list(estimate_files='besu_marginal_estimated_cost.csv, erigon_marginal_estimated_cost.csv, ethereumjs_marginal_estimated_cost.csv, geth_marginal_estimated_cost.csv, nethermind_marginal_estimated_cost.csv, revm_marginal_estimated_cost.csv', current_gas_cost='current_gas_cost.csv'), output_file = '/data/final_estimation.html')"
```

## Docker - REST API

You can run REST API within the same report Docker image.
The service interactively generates reports.

In order to build locally the docker image execute in the repository root

```shell
docker build ./src/analysis -f Dockerfile.reports -t imapp-pl/gas-cost-estimator/reports:4.1
```

Then run the service

```shell
docker run -d --name gas-cost-estimator-rest-api -p 5000:5000 -v /your/path/to/data:/data --rm imapp-pl/gas-cost-estimator/reports:4.1 /rest-api/gas-cost-estimator-rest-api.sh
```

The logs are in locations:

- `/your/path/to/data/uwsgi.log`
- `/your/path/to/data/uwsgi.stdout`
- `/your/path/to/data/uwsgi.stderr`

The welcome page is available at [http://localhost:5000/](http://localhost:5000/).

To stop the service run

```shell
docker stop gas-cost-estimator-rest-api
```

gas-cost-estimator

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README