espresso-network

Espresso Network

The Espresso Network is the global confirmation layer for rollups in the Ethereum ecosystem. Espresso's global confirmation layer(GCL) provides agreement on inputs to a collection of composable blockchains, providing a high trust, fast, and verifiable way to process inputs on any chain, providing fast confirmations in return.

• Official Documentation
• Rust Documentation
• Smart Contract Documentation

Architecture

The diagram below shows how the Espresso Confirmation Layer fits into the rollup centric Ethereum ecosystem. See Architecture for details.

ZK rollups integration

In order for ZK rollups to rely on blocks produced by Espresso as a source of transactions, it is required to adjust the circuit that encodes the state update logic. See zk-rollups integration for more details.

Development

• Obtain code: git clone [email protected]:EspressoSystems/espresso-network.
• Make sure nix is installed.
• Activate the environment with nix-shell, or nix develop. If using direnv, copy .envrc.example to .envrc.local (or create your own .envrc.local file) and run direnv allow.
• For installation without nix please see ubuntu.md.
• The rust code documentation can be found at espresso-network.docs.espressosys.com. Please note the disclaimer about API stability at the end of the readme.

Development commands

just # see available commands
just doc --open
just build
just test --package espresso-types # gate by package to avoid long runtime

Running a local network

A full local network is run two ways:

just demo         # Docker Compose, images from ghcr (updated on every push to main)
just demo-native  # process-compose, building and running the binaries locally

• just demo-native builds the binaries first, so it picks up uncommitted changes.
• Genesis and process variants are available as additional just recipes.

See process-compose.yaml and docker-compose.yaml for more information.

Contracts

Development

A foundry project for the contracts specific to HotShot can be found in the directory contracts.

To compile

forge build
just contracts-test-forge
just gen-bindings # update rust contract bindings
forge doc # build docs

Deployment

The deploy binary is used for contract deployment.

cargo run --bin deploy -- --help
ghcr.io/espressosystems/espresso-network/deploy:$DOCKER_TAG deploy --help

See process-compose.yaml and docker-compose.yaml for example invocations.

Dry run upgrades via Docker

You can only run a dry run for multisig upgrades but you need to stand up all services via docker compose Example:

just pull
just demo
docker compose run --rm upgrade-prover-contracts-v2 /bin/deploy --upgrade-light-client-v2 --dry-run --use-multisig

If making dev changes locally run, ./scripts/build-docker-images-native instead of just pull.

For AWS ECS, ensure all required environment variables and secrets are set in your task definition.

Logging

You can control the log level using the RUST_LOG environment variable. For example:

RUST_LOG=info cargo run --bin deploy -- [FLAGS]
RUST_LOG=debug cargo run --bin deploy -- [FLAGS]

Benchmarking and profiling

The gas consumption for verifying a plonk proof as well as updating the state of the light client contract can be seen by running:

just gas-benchmarks
cat gas-benchmarks.txt
# [PASS] test_verify_succeeds() (gas: 507774)
# [PASS] testCorrectUpdateBench() (gas: 594533)

In order to profile the gas consumption of the light client contract do the following:

1. Set the environment variables SEPOLIA_RPC_URL, MNEMONIC and ETHERSCAN_API_KEY.
2. just lc-contract-profiling-sepolia
3. Create an account on sentio.xyz.
4. Use the hash of the transaction generated in step two when calling the function newFinalizedState in order to obtain the gas profile.

License

Copyright

(c) 2022 Espresso Systems espresso-network was developed by Espresso Systems. While we plan to adopt an open source license, we have not yet selected one. As such, all rights are reserved for the time being. Please reach out to us if you have thoughts on licensing.

Disclaimer

DISCLAIMER: This software is provided "as is" and its security has not been externally audited. Use at your own risk.

DISCLAIMER: The Rust library crates provided in this repository are intended primarily for use by the binary targets in this repository. We make no guarantees of public API stability. If you are building on these crates, reach out by opening an issue to discuss the APIs you need.