Warning
This repository is DEPRECATED, Check out our new version with Optimism's Approval docs
Avail: Data availability focused blockchain X Low-cost and lightning-fast Ethereum L2 blockchain: Optimism
Avail-OP-Stack Adapter integrates the Avail Data Availability layer in Optimism’s OP Stack to create a more optimised and efficient Optimistic Rollup architecture. It is designed to minimise the cost of posting L2 transactions over the DA layer with a better data availability guarantee
Avail welcomes contributors from every background and skill level. Our mission is to build a community that's not only welcoming and friendly but also aligned with the best development practices. Interested in contributing to this project? Whether you've spotted an issue, have improvement ideas, or want to add new features, we'd love to have your input. Simply open a GitHub issue or submit a pull request to get started.
-
Before asking any questions regarding how the project works, please read through all the documentation and install the project on your own local machine to try it and understand how it works. Please ask your questions in open channels (Github and Telegram).
-
To work on an issue, first, get approval from a maintainer or team member. You can request to be assigned by commenting on the issue in GitHub. This respects the efforts of others who may already be working on the same issue. Unapproved PRs may be declined.
-
When assigned to an issue, it's expected that you're ready to actively work on it. After assignment, please provide a draft PR or update within one week. If you encounter delays, communicate with us to maintain your assignment.
-
Got an idea or found a bug? Open an issue with the tags [New Feature] or [Bug]. Provide detailed information like reproduction steps (for bugs) or a basic feature proposal. The team will review and potentially assign you to it.
-
Start a draft PR early in your development process, even with incomplete changes. This allows us to track progress, provide timely reviews, and assist you. Expect feedback on your drafts periodically.
Avail is a data availability focused blockchain. Its blocks are designed to provide secure, decentralized and low-cost blockspace for the data availability needs of other blockchains. It is built to meet the needs of next-generation, trust-minimized applications and sovereign rollups. Avail's strengths lie in its innovative security approach, which allows light clients to easily verify data availability through sampling over a peer-to-peer network. Avail’s modular approach simplifies blockchain integration for developers, as they no longer need to worry about validator sets or tokenomics. With Avail's unparalleled data availability interface and powerful security capabilities, developers can create zero-knowledge or fraud-proof-based blockchain applications with greater efficiency and ease.
At its core, Avail prioritizes ordering and publishing transactions while enabling users to verify the availability of block data without needing to download entire blocks. Avail's data-agnostic nature is one of its defining features. It supports various execution environments, including EVM, WASM, and custom new runtimes, offering a versatile foundation for diverse blockchain applications.
Optimism is a project dedicated to scaling Ethereum's technology and expanding its ability to coordinate people from across the world to build effective decentralized economies and governance systems. The Optimism Collective builds open-source software for running L2 blockchains and aims to address key governance and economic challenges in the wider cryptocurrency ecosystem. Optimism operates on the principle of impact=profit, the idea that individuals who positively impact the Collective should be proportionally rewarded with profit. Change the incentives and you change the world.
In this repository, you'll find numerous core components of the OP Stack, the decentralized software stack maintained by the Optimism Collective that powers Optimism and forms the backbone of blockchains like OP Mainnet and Base. Designed to be "aggressively open source," the OP Stack encourages you to explore, modify, extend, and test the code as needed. Although not all elements of the OP Stack are contained here, many of its essential components can be found within this repository. By collaborating on free, open software and shared standards, the Optimism Collective aims to prevent siloed software development and rapidly accelerate the development of the Ethereum ecosystem. Come contribute, build the future, and redefine power, together.
OP Stack chain is derived from the Data Availability Layer, the Data Availability module(s) used have a significant impact on the security model of a system. For example, if a certain piece of data can no longer be retrieved from the Data Availability Layer, it may not be possible to sync the chain.
In ORUs, Sequencer has the responsibility to submit L2 transactions to a data availability provider. Ethereum DA is currently the used Data Availability module for the OP Stack.
In Avail-OP-Stack-Adapter, the Data Availability layer is switched from Ethereum to Avail in OP Stack modular blockchain architecture to create the optimistic rollup.
- Sequencer posts L2 transaction data on Avail DA and submits the data commitment to Ethereum as
callData. - Verifier and Rollup nodes can derive the chain using the data commitment from
callDatato read the L2 transaction data from Avail.
There are few changes being made in the workflow compared to op-stack with Ethereum as Data Availability Layer
op-availis the module added to integrate the Avail DA withop-stack.- Here,
op-batchersubmits the batch of transactions on Avail DA using theop-availand gets the data commitment in the return, which is again submitted over Ethereum ascallDataon BatchInbox address. - To derive the chain
op-node, first query the data commitment from EthereumcallDataand then fetch the L2 transaction data throughop-avail.
Here op-node, op-geth, op-batcher and op-proposer are the software components of op-stack to learn more about it, follow op-stack
ORUs faced with growth challenges due to constrained blockspace and prohibitive costs, have now come to recognize that a scalable data availability layer is crucial for effectively scaling blockchains. They have come to realize the need for a cost-effective base layer with expandable block space
Avail is a highly tuned data availability base layer which can provide raw blockspace for next-generation, trust minimized applications and blockchains. it ensures the modular blockchain ecosystem can access secure, affordable and highly available block space for transaction data unlocking significant scaling potential for the industry.
When inspecting L1 transactions for Ethereum Rollups, we can see the major bottleneck which represents up to 90% of their costs is transaction data. In fact, this is the largest cost item for Ethereum Rollups as most of their revenues go towards paying an L1 to publish transaction data.
Ethereum is the most expensive solution in relation to congestion and demand. Even with EIP-4844 Ethereum will still be costly as it provides only a one-time increase in blockspace. DACs are the cheapest, but this comes at the cost of adopting a more centralized approach.
Avail is a Data Availablity Sampling based DA provider with no congestion, Using Avail as DA layer will reduce the cost of posting L2 transactional data over L1 layer.
pre EIP 4844 ethereum has no support of DAS and fraud proof and with low calldata space, where as in Avail
Avail’s light client network ensures high availability of data through Data Availability Sampling. with validity proof mechanism and high space compared to ethereum’s calldata
- If you want to build on top of Avail, refer to the Avail developers
- If you want to build your own avail-optimism blockchain, refer to the Avail Optimism(Optimium)
- If you want to learn more about OP-Stack and Optimsim, check out the OP Stack and Optimism
General discussion happens most frequently on the Optimism discord. Governance discussion can also be found on the Optimism Governance Forum.
General discussion happens most frequently on the Avail discord. Other discussion can also be found on the Avail Forum.
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 avail-op-stack-adapter Monorepo. Then check out the list of Good First Issues to find something fun to work on!
├── packages │ ├── common-ts: Common tools for building apps in TypeScript │ ├── contracts-bedrock: Bedrock smart contracts. │ ├── contracts-periphery: Peripheral contracts for avail-op-stack-adapter │ ├── core-utils: Low-level utilities that make building avail-op-stack-adapter easier │ ├── chain-mon: Chain monitoring services │ ├── fault-detector: Service for detecting Sequencer faults │ ├── replica-healthcheck: Service for monitoring the health of a replica node │ └── sdk: provides a set of tools for interacting with avail-op-stack-adapter ├── op-avail: Avail module to interact with Avail DA ├── op-bindings: Go bindings for Bedrock smart contracts. ├── op-batcher: L2-Batch Submitter, submits bundles of batches to L1 ├── 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-exporter: Prometheus exporter client ├── op-heartbeat: Heartbeat monitor service ├── op-node: rollup consensus-layer client ├── op-program: Fault proof program ├── op-proposer: L2-Output Submitter, submits proposals to L1 ├── op-service: Common codebase utilities ├── op-signer: Client signer ├── op-wheel: Database utilities ├── ops-bedrock: Bedrock devnet work ├── proxyd: Configurable RPC request router and proxy └── specs: Specs of the rollup starting at the Bedrock upgrade
| Branch | Status |
|---|---|
| avail-master | Accepts PRs from avail-develop when intending to deploy to production. |
| avail-develop | Accepts PRs that are successfully running without fails. |
This repository generally follows this Git branching model. Please read the linked post if you're planning to make frequent PRs into this repository.
The production branch is avail-master.
The avail-master branch contains the code for latest "stable" releases.
Updates from avail-master always come from the avail-develop branch.
The primary development branch is avail-develop.
avail-develop contains the most up-to-date software that remains backwards compatible with the latest experimental.
If you're making a backwards compatible change, please direct your pull request towards avail-develop.
All other files within this repository are licensed under the MIT License unless stated otherwise.