Table of Contents
- What is Rollux?
- Documentation
- Specification
- Community
- Contributing
- Security Policy and Vulnerability Reporting
- Directory Structure
- Development and Release Process
- License
Rollux, built by SYS Labs, is a project dedicated to scaling blockchain technology and expanding its ability to coordinate people from across the world to build effective decentralized economies and governance systems. More specifically, Rollux is the EVM-equivalent Layer 2 optimistic rollup that introduces some key scaling technologies and security characteristics to Optimism's OP Stack. Built on Syscoin's holistically modular Layer 1, Rollux inherits the security of Bitcoin’s mining network through merged-mining, combined with decentralized multi-quorum finality. Rollux fully factors Syscoin's efficient data availability (Proof of Data Availability - PoDA) and data fee market rather than relying on EVM calldata or danksharding. Rollux is secure, scalable, and offers very low fees. Additionally, Rollux provides native Layer 2 data availability which makes it ideal for supporting Layer 3 and fractal scaling.
In all, Rollux is a unique and powerful alternative to other rollup-based stacks and blockchain scaling technologies in general.
In this repository, you'll find numerous core components of Rollux, the decentralized software stack maintained by SYS Labs, and much of the upstream OP Stack which is maintained by the Optimism Collective. We encourage you to explore, modify, extend, and test the code as needed. By collaborating on free, open software and shared standards, SYS Labs, Syscoin Foundation and the Optimism Collective aim to prevent siloed software development and rapidly accelerate the development of blockchain ecosystems. Come contribute, build the future, and redefine power, together.
NOTE: It is important to understand that this repository became public relatively recently. As such, some READMEs might be incomplete. We appreciate your patience while we work quickly to expand technical information about Rollux and refactor existing content! Should you have questions about this repo, feel free to chat with the Rollux community at the links below!
- If you want to build on top of Rollux Mainnet, refer to the Rollux Developers Docs
- If you want to contribute to Rollux, check out the Protocol Specs
- If you want to build your own OP Stack based blockchain, refer to the OP Stack docs
- If you want to build on top of OP Mainnet, refer to the Optimism Documentation
- If you want to build your own OP Stack based blockchain, refer to the OP Stack Guide, and make sure to understand this repository's Development and Release Process
If you're interested in the technical details of how Optimism works, refer to the Optimism Protocol Specification.
General dev discussion happens most frequently on the Rollux discord in the #🔨│builder-general channel.
Read through CONTRIBUTING.md for a general overview of the contributing process for this repository. Use the Developer Quick Start to get your development environment set up to start working on the Rollux Monorepo. Then check out the list of Good First Issues to find something fun to work on! Use the Developer Quick Start to get your development environment set up to start working on the Optimism Monorepo. Then check out the list of Good First Issues to find something fun to work on! Typo fixes are welcome; however, please create a single commit with all of the typo fixes & batch as many fixes together in a PR as possible. Spammy PRs will be closed.
If you are reporting any vulnerabilites exclusive to the Rollux codebase, you should follow the common sense "How to" guidelines echoed in Optimism's canonical Security Policy. Bounty hunters are encouraged to check out the Optimism Immunefi bug bounty program. While this does not apply to any Rollux-specific discoveries, the Optimism Immunefi program offers up to $2,000,042 for in-scope critical vulnerabilities in the Optimism codebase. For vulnerabilities in any Rollux or SYS Labs websites, email servers or other non-critical infrastructure, please email SYS Labs at [email protected]. We appreciate detailed instructions for confirming the vulnerability.
Rollux is based upon Optimism Bedrock! You can find detailed specifications for the Bedrock upgrade within the specs folder in this repository.
~~ Production ~~ ├── packages │ ├── common-ts: Common tools for building apps in TypeScript │ ├── contracts-bedrock: Rollux Bedrock smart contracts. │ ├── core-utils: Low-level utilities that make building Rollux easier │ ├── chain-mon: Chain monitoring services │ └── sdk: provides a set of tools for interacting with Rollux ├── docs: A collection of documents including audits and post-mortems ├── op-batcher: L2-Batch Submitter, submits bundles of batches to L1 ├── op-bindings: Go bindings for Bedrock smart contracts. ├── op-bootnode: Standalone op-node discovery bootnode ├── op-chain-ops: State surgery utilities ├── op-challenger: Dispute game challenge agent ├── op-e2e: End-to-End testing of all bedrock components in Go ├── op-heartbeat: Heartbeat monitor service ├── op-node: rollup consensus-layer client ├── op-preimage: Go bindings for Preimage Oracle ├── op-program: Fault proof program ├── op-proposer: L2-Output Submitter, submits proposals to L1 ├── op-service: Common codebase utilities ├── op-ufm: Simulations for monitoring end-to-end transaction latency ├── op-wheel: Database utilities ├── ops: Various operational packages ├── ops-bedrock: Bedrock devnet work ├── packages │ ├── chain-mon: Chain monitoring services │ ├── common-ts: Common tools for building apps in TypeScript │ ├── contracts-bedrock: Bedrock smart contracts │ ├── contracts-ts: ABI and Address constants │ ├── core-utils: Low-level utilities that make building Optimism easier │ ├── fee-estimation: Tools for estimating gas on OP chains │ ├── sdk: provides a set of tools for interacting with Optimism │ └── web3js-plugin: Adds functions to estimate L1 and L2 gas ├── proxyd: Configurable RPC request router and proxy ├── specs: Specs of the rollup starting at the Bedrock upgrade └── ufm-test-services: Runs a set of tasks to generate metrics
Please read this section if you're planning to fork this repository, or make frequent PRs into this repository.
Production releases are always tags, versioned as <component-name>/v<semver>.
For example, an op-node release might be versioned as op-node/v1.1.2, and smart contract releases might be versioned as op-contracts/v1.0.0.
Release candidates are versioned in the format op-node/v1.1.2-rc.1.
We always start with rc.1 rather than rc.
For contract releases, refer to the GitHub release notes for a given release, which will list the specific contracts being released—not all contracts are considered production ready within a release, and many are under active development.
Tags of the form v<semver>, such as v1.1.4, indicate releases of all Go code only, and DO NOT include smart contracts.
This naming scheme is required by Golang.
In the above list, this means these v<semver releases contain all op-* components, and exclude all contracts-* components.
op-geth embeds upstream geth’s version inside it’s own version as follows: vMAJOR.GETH_MAJOR GETH_MINOR GETH_PATCH.PATCH.
Basically, geth’s version is our minor version.
For example if geth is at v1.12.0, the corresponding op-geth version would be v1.101200.0.
Note that we pad out to three characters for the geth minor version and two characters for the geth patch version.
Since we cannot left-pad with zeroes, the geth major version is not padded.
See the Node Software Releases page of the documentation for more information about releases for the latest node components. The full set of components that have releases are:
chain-monci-builderci-builderindexerop-batcherop-contractsop-challengerop-heartbeatop-nodeop-proposerop-ufmproxydufm-metamask
All other components and packages should be considered development components only and do not have releases.
The primary development branch is develop.
develop contains the most up-to-date software that remains backwards compatible with the latest testnet network deployments.
If you're making a backwards compatible change, please direct your pull request towards develop.
Changes to contracts within packages/contracts-bedrock/src are usually NOT considered backwards compatible.
Some exceptions to this rule exist for cases in which we absolutely must deploy some new contract after a tag has already been fully deployed.
If you're changing or adding a contract and you're unsure about which branch to make a PR into, default to using a feature branch.
Feature branches are typically used when there are conflicts between 2 projects touching the same code, to avoid conflicts from merging both into develop.
All other files within this repository are licensed under the MIT License unless stated otherwise.