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

[Fjord] Add FastLZ compression into L1CostFunc #9053

Closed
wants to merge 8 commits into from

Conversation

mdehoog
Copy link
Contributor

@mdehoog mdehoog commented Jan 17, 2024

Reopening #8635, targeting Fjord rather than Ecotone.

Description
We found that the FastLZ algorithm is a pretty good estimate for the actual results we'd see from zlib compressing the batches we write to L1 (albeit with a different scalar as the compression ratios aren't quite as good). See https://github.com/roberto-bayardo/compression-analysis and this sheet.

This PR introduces a flzCompress call into the GasPriceOracle. Companion op-geth PR is here: ethereum-optimism/op-geth#202

See specs update here: ethereum-optimism/specs#25

Tests

Added tests comparing compression results from solidity + golang.

Additional context

The current naive L1Cost approach:

l1fee = ((0s in calldata) * 4 + (1s in calldata) * 16 + 188) * l1BaseFee * 0.684

works pretty well on average, but penalizes very compressible txs (e.g.), and undercharges incompressible txs (e.g.). This change makes the L1CostFunc much fairer compared to real-world L1 costs.

@mdehoog mdehoog requested review from a team as code owners January 17, 2024 21:35
@mdehoog mdehoog requested a review from tynes January 17, 2024 21:35
Copy link
Contributor

coderabbitai bot commented Jan 17, 2024

Walkthrough

The Ethereum network has seen updates to its gas price oracle and compression utilities to improve efficiency and accommodate network upgrades. A test for the gas price oracle ensures its proper function, while the oracle itself now accounts for new network chains, Fjord and Ecotone. Compression techniques are refined in the Solidity library to optimize gas usage. Lastly, a new cost calculation method using FastLZ compression is introduced for L1 transactions, signifying a shift in fee structures following the Fjord upgrade.

Changes

File Path Change Summary
op-e2e/.../gas_price_oracle_test.go Added TestGasPriceOracle to validate gas price oracle contract.
packages/.../src/L2/GasPriceOracle.sol Updated with isFjord and isEcotone variables; new setFjord function; modified _getCalldataGas logic.
packages/.../src/libraries/Compression.sol Included flzCompressLen function for gas-efficient data length retrieval.
specs/exec-engine.md Added "Fjord L1-Cost fee changes" section detailing new L1 cost calculation via FastLZ compression.

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-tests for this file.
  • 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 tests 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 from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

@mdehoog mdehoog marked this pull request as draft January 17, 2024 21:35
Copy link

codecov bot commented Jan 17, 2024

Codecov Report

Attention: 16 lines in your changes are missing coverage. Please review.

Comparison is base (0ea5e0b) 19.38% compared to head (4bd3fb2) 24.50%.
Report is 173 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #9053      +/-   ##
===========================================
+ Coverage    19.38%   24.50%   +5.12%     
===========================================
  Files          151      104      -47     
  Lines         5912     3750    -2162     
  Branches      1271      541     -730     
===========================================
- Hits          1146      919     -227     
+ Misses        4691     2785    -1906     
+ Partials        75       46      -29     
Flag Coverage Δ
cannon-go-tests 62.56% <ø> (?)
chain-mon-tests ?
common-ts-tests ?
contracts-bedrock-tests 0.65% <0.00%> (-0.01%) ⬇️
contracts-ts-tests ?
core-utils-tests ?
sdk-next-tests ?

Flags with carried forward coverage won't be shown. Click here to find out more.

Files Coverage Δ
packages/contracts-bedrock/src/L2/L1Block.sol 0.00% <0.00%> (ø)
...ckages/contracts-bedrock/src/L2/GasPriceOracle.sol 0.00% <0.00%> (ø)

... and 79 files with indirect coverage changes

@tynes
Copy link
Contributor

tynes commented Jan 17, 2024

Would super appreciate thorough specs with reasoning before any implementation is merged

Copy link
Contributor

github-actions bot commented Feb 2, 2024

This PR is stale because it has been open 14 days with no activity. Remove stale label or comment or this will be closed in 5 days.

@github-actions github-actions bot added the Stale label Feb 2, 2024
Copy link
Contributor

This PR is stale because it has been open 14 days with no activity. Remove stale label or comment or this will be closed in 5 days.

@mdehoog
Copy link
Contributor Author

mdehoog commented Feb 21, 2024

Closing in favor of #9618, which uses a different base branch

@mdehoog mdehoog closed this Feb 21, 2024
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.

4 participants