Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Compact client-side module for compressing Ethereum JSON-RPC requests.

License

Notifications You must be signed in to change notification settings

tadpole-labs/eth-compress

Repository files navigation

eth-compress

A compact client-side module for compressing Ethereum JSON-RPC requests, targeting lower latency and gas-efficient read-only calls with large calldata.

It combines RFC 9110-compliant negotiation for client-to-server compression, with optional JIT-compiled calldata compression.

Plug 'n' play with viem and a simple API

Scope

  • Read-only eth_calls.
  • Min. input threshold: > 1150 bytes.
  • HTTP: Uses RFC 9110-compliant Content-Encoding negotiation (gzip/deflate).
  • EVM/JIT: Routes eth_calls through a transient decompressor contract.

Installation

npm i eth-compress

HTTP request compression

Transparently compresses request bodies using the CompressionStream API.

import { compressModule } from 'eth-compress';

const response = await compressModule('https://rpc.example.org', {
  method: 'POST',
  body: JSON.stringify({
    jsonrpc: '2.0',
    id: 1,
    method: 'eth_call',
    params: [/* ... */],
  }),
});

Compression modes

Mode Behavior
'passive' Discover support from response Accept-Encoding header
'proactive' Send gzip; discover alternative / lacking support via Accept-Encoding response header, error or success
'gzip' / 'deflate' Use specified encoding directly
(payload) => ... Custom transform; server expected to understand


viem integration

Passive (default):

import { createPublicClient, http } from 'viem';
import { compressModule } from 'eth-compress';

const client = createPublicClient({
  chain: base,
  transport: http(rpcUrl, { fetchFn: compressModule }),
});

Known gzip support:

import { compressModule } from 'eth-compress';

const client = createPublicClient({
  chain: base,
  transport: http(rpcUrl, {
    fetchFn: (url, init) => compressModule(url, init, 'gzip'),
  }),
});

JIT calldata compression:

import { compressModule } from 'eth-compress';
import { compress_call } from 'eth-compress/compressor';

const client = createPublicClient({
  chain: base,
  transport: http(rpcUrl, {
    fetchFn: (url, init) => compressModule(url, init, compress_call),
  }),
});

Compatibility



JIT calldata compression for eth_call

Eligible eth_calls are compiled into a transient decompressor contract (passed via stateDiff).

import { compress_call } from 'eth-compress/compressor';

const payload = {
  method: 'eth_call',
  params: [
    {
      to: '0x…',
      data: '0x…',
    },
    'latest',
  ],
};

const compressedPayload = compress_call(payload);

compress_call can be passed directly to compressModule as a custom transform. For eligible eth_calls, it chooses between:

  • JIT: Compiles just-in-time, a one-off decompressor contract that reconstructs calldata to forward the call.

  • FLZ / CD: Uses LibZip.flzCompress and LibZip.cdCompress from solady for FastLZ / RLE compression.

  • Size gating (JIT / EVM path):

    • < 1150 bytes (effective payload): no EVM-level compression.
    • ≥ 1150 bytes: compression considered.
    • size ≤ ~3000 bytes or > ~8000 bytes: JIT is preferred.
    • ~3000 ≤ size ≤ ~8000 bytes: Best-of-3.
  • Algorithm choice:

    • For mid-sized payloads, FLZ and CD are tried and the smaller output is chosen.
    • For larger ones, JIT is used directly, prioritizing gas efficiency.
    • The thresholds are chosen with request header overhead and latency in mind, aiming to keep the total request size within the Ethernet MTU.

Important considerations

The JIT calldata compressor is experimental and intended for auxiliary/bulk dApp read-only eth_calls. Use two viem clients to separate concerns.

Compression Ratio & Gas

Tx Size Range # Txns Avg. Tx Size JIT Ratio FLZ Ratio CD Ratio JIT Gas FLZ Gas CD Gas
> 8 KB 129 14.90 kb 2.99x 3.62x 3.21x 8.02k 323k 242k
3–8 KB 260 4.82 kb 2.77x 2.59x 2.81x 4.45k 138k 88.9k
1.15–3 KB 599 2.02 kb 2.89x 1.91x 2.58x 3.35k 68.4k 35.8k

Excludes txns not compressible to <70% of original size.

Compression flavors

  • JIT calldata compiler (compress_call JIT mode): Views calldata as a zero‑initialized memory image and synthesizes bytecode that rebuilds it word-by-word in-place.

    In the first pass it walks the data in 32-byte slices, detects non-zero segments per word, and for each word chooses the cheapest of three strategies: store a literal tail, assemble segments using SHL/OR, or reuse an earlier word via MLOAD/MSTORE.

    In the second pass it materializes this plan into concrete PUSH/MSTORE/SHL/OR/DUP opcodes, pre-seeds the stack with frequently used constants, and appends a small CALL/RETURNDATA stub that forwards the reconstructed calldata to the original to address.

    The 4‑byte selector is right‑aligned in the first 32‑byte slot so that the rest of the calldata can be reconstructed on mostly word‑aligned boundaries, with the decompressor stateDiff being placed at 0xe0 to obtain this common offset from ADDRESS with a single opcode instead of PUSH1 + literal.

Both the FastLZ and calldata-RLE forwarders are minimally adapted from Solady's LibZip.sol and inlined as raw bytecode. To avoid Solidity's wrapper overhead the code is compiled from pure yul.

About

Compact client-side module for compressing Ethereum JSON-RPC requests.

Resources

License

Security policy

Stars

Watchers

Forks

Packages