op-rosetta •

Warning WIP; Not bedrock-compatible yet.

Provides Rosetta API compatibility for Optimism Bedrock, a low-cost and lightning-fast Ethereum L2 blockchain.

Overview

op-rosetta is an executable client extending the rosetta-geth-sdk.

To learn more about the Rosetta API, you can find more online at rosetta-api.org.

Usage

Run the op-rosetta client for goerli like so: make run-optimism-goerli.

A mainnet client can be run with make run-optimism-mainnet.

Note Mainnet will only be supported once Optimism mainnet is upgraded to its Bedrock Release.

Testing

NOTE: op-rosetta must be running on the specified host and port provided in the configuration file. For local testing, this can be done as described in the Running section, which will run an instance on localhost, port 8080.

See configs/README.md for more information.

Layout

├── assets
│   └── rosetta.png
├── cmd
│   └── main.go -> The `op-rosetta` executable entrypoint
├── configs
│   ├── optimism/ -> Optimism Mainnet and Goerli config files
│   └── README.md
└── pkg
    ├── client/ -> Optimism Rosetta API client
    ├── config/ -> Configuration options
    ├── handlers/ -> Rosetta API handlers
    ├── logging/ -> Logging utilities
    ├── topics/ -> Events topic functionality
    └── utils/ -> Package utilities

License

All files within this repository, including code adapted from rosetta-geth-sdk, is licensed under the terms of the Apache 2.0 License unless explicitly stated otherwise.