Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/keep-starknet-strange/madara
Building the Integrity Web. The most modular ZK Rollup framework.
https://github.com/keep-starknet-strange/madara
cairo ethereum starknet starknet-appchain starknet-stack substrate
Last synced: 1 day ago
JSON representation
Building the Integrity Web. The most modular ZK Rollup framework.
- Host: GitHub
- URL: https://github.com/keep-starknet-strange/madara
- Owner: keep-starknet-strange
- License: mit
- Created: 2023-02-10T10:04:22.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-13T15:20:12.000Z (8 months ago)
- Last Synced: 2024-04-13T19:14:25.981Z (8 months ago)
- Topics: cairo, ethereum, starknet, starknet-appchain, starknet-stack, substrate
- Language: Rust
- Homepage: https://madara.build
- Size: 201 MB
- Stars: 473
- Watchers: 9
- Forks: 264
- Open Issues: 88
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: docs/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: docs/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: docs/SECURITY.md
Awesome Lists containing this project
- awesome-rust - madara - Kaioshin is a ⚡ blazing fast ⚡ Starknet sequencer, based on substrate. [![GitHub Workflow Status](https://github.com/keep-starknet-strange/madara/actions/workflows/test.yml/badge.svg)](https://github.com/keep-starknet-strange/madara/actions/workflows/test.yml) (Applications / Blockchain)
- awesome-starknet - Madara - Sequencer based on substrate. (Additional developer resources)
- fucking-awesome-rust - madara - Kaioshin is a ⚡ blazing fast ⚡ Starknet sequencer, based on substrate. [![GitHub Workflow Status](https://github.com/keep-starknet-strange/madara/actions/workflows/test.yml/badge.svg)](https://github.com/keep-starknet-strange/madara/actions/workflows/test.yml) (Applications / Blockchain)
- awesome-rust - madara - Kaioshin is a ⚡ blazing fast ⚡ Starknet sequencer, based on substrate. [![GitHub Workflow Status](https://github.com/keep-starknet-strange/madara/actions/workflows/test.yml/badge.svg)](https://github.com/keep-starknet-strange/madara/actions/workflows/test.yml) (Applications / Blockchain)
README
# DEPRECATED
This repository is no longer supported, please consider using [madara](https://github.com/madara-alliance/madara) instead.
This is due to our choice to shift to a non-substrate-based implementation.
A huge thanks to everyone who contributed to this repository!
[![Project license](https://img.shields.io/github/license/keep-starknet-strange/madara.svg?style=flat-square)](LICENSE)
[![Pull Requests welcome](https://img.shields.io/badge/PRs-welcome-ff69b4.svg?style=flat-square)](https://github.com/keep-starknet-strange/madara/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22)
[![Exploration_Team](https://img.shields.io/badge/Exploration_Team-29296E.svg?&style=for-the-badge&logo=data:image/svg%2bxml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz48c3ZnIGlkPSJhIiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAxODEgMTgxIj48ZGVmcz48c3R5bGU+LmJ7ZmlsbDojZmZmO308L3N0eWxlPjwvZGVmcz48cGF0aCBjbGFzcz0iYiIgZD0iTTE3Ni43Niw4OC4xOGwtMzYtMzcuNDNjLTEuMzMtMS40OC0zLjQxLTIuMDQtNS4zMS0xLjQybC0xMC42MiwyLjk4LTEyLjk1LDMuNjNoLjc4YzUuMTQtNC41Nyw5LjktOS41NSwxNC4yNS0xNC44OSwxLjY4LTEuNjgsMS44MS0yLjcyLDAtNC4yN0w5Mi40NSwuNzZxLTEuOTQtMS4wNC00LjAxLC4xM2MtMTIuMDQsMTIuNDMtMjMuODMsMjQuNzQtMzYsMzcuNjktMS4yLDEuNDUtMS41LDMuNDQtLjc4LDUuMThsNC4yNywxNi41OGMwLDIuNzIsMS40Miw1LjU3LDIuMDcsOC4yOS00LjczLTUuNjEtOS43NC0xMC45Ny0xNS4wMi0xNi4wNi0xLjY4LTEuODEtMi41OS0xLjgxLTQuNCwwTDQuMzksODguMDVjLTEuNjgsMi4zMy0xLjgxLDIuMzMsMCw0LjUzbDM1Ljg3LDM3LjNjMS4zNiwxLjUzLDMuNSwyLjEsNS40NCwxLjQybDExLjQtMy4xMSwxMi45NS0zLjYzdi45MWMtNS4yOSw0LjE3LTEwLjIyLDguNzYtMTQuNzYsMTMuNzNxLTMuNjMsMi45OC0uNzgsNS4zMWwzMy40MSwzNC44NGMyLjIsMi4yLDIuOTgsMi4yLDUuMTgsMGwzNS40OC0zNy4xN2MxLjU5LTEuMzgsMi4xNi0zLjYsMS40Mi01LjU3LTEuNjgtNi4wOS0zLjI0LTEyLjMtNC43OS0xOC4zOS0uNzQtMi4yNy0xLjIyLTQuNjItMS40Mi02Ljk5LDQuMyw1LjkzLDkuMDcsMTEuNTIsMTQuMjUsMTYuNzEsMS42OCwxLjY4LDIuNzIsMS42OCw0LjQsMGwzNC4zMi0zNS43NHExLjU1LTEuODEsMC00LjAxWm0tNzIuMjYsMTUuMTVjLTMuMTEtLjc4LTYuMDktMS41NS05LjE5LTIuNTktMS43OC0uMzQtMy42MSwuMy00Ljc5LDEuNjhsLTEyLjk1LDEzLjg2Yy0uNzYsLjg1LTEuNDUsMS43Ni0yLjA3LDIuNzJoLS42NWMxLjMtNS4zMSwyLjcyLTEwLjYyLDQuMDEtMTUuOGwxLjY4LTYuNzNjLjg0LTIuMTgsLjE1LTQuNjUtMS42OC02LjA5bC0xMi45NS0xNC4xMmMtLjY0LS40NS0xLjE0LTEuMDgtMS40Mi0xLjgxbDE5LjA0LDUuMTgsMi41OSwuNzhjMi4wNCwuNzYsNC4zMywuMTQsNS43LTEuNTVsMTIuOTUtMTQuMzhzLjc4LTEuMDQsMS42OC0xLjE3Yy0xLjgxLDYuNi0yLjk4LDE0LjEyLTUuNDQsMjAuNDYtMS4wOCwyLjk2LS4wOCw2LjI4LDIuNDYsOC4xNiw0LjI3LDQuMTQsOC4yOSw4LjU1LDEyLjk1LDEyLjk1LDAsMCwxLjMsLjkxLDEuNDIsMi4wN2wtMTMuMzQtMy42M1oiLz48L3N2Zz4=)](https://github.com/keep-starknet-strange)
# ⚡ Madara App Chain Stack
Welcome to **Madara**, the modular stack to build chains using
[Cairo](https://book.cairo-lang.org/title-page.html) and the
[Starknet](https://www.starknet.io/) technology. Apps like dYdX V3, Immutable
and Sorare have been using StarkEx for scaling for a while and now with Madara,
it's open source for everyone to use.Madara is built on the [Substrate](https://substrate.io/) framework which not
only makes it modular but also gives it access to years of dev tooling,
libraries and a strong developer community. It is specifically helpful if you
want to own more of the stack and get more control over your chain.## 📚 Documentation
Get started with our comprehensive documentation, which covers everything from
project structure and architecture to benchmarking and running Madara:- [Getting Started Guide](./docs/getting-started.md)
- [Architecture Overview](./docs/architecture.md)
- [Chain Genesis Information](./docs/genesis.md)
- [Project Structure](./docs/project-structure.md)
- [Run benchmark yourself](./benchmarking/README.md)## 📣 Building App Chains
For many use cases, you do not need to fork this repo to build your app chain.
By adding changes using forking, you will have to periodically rebase (and solve
conflicts) to remain updated with the latest version of Madara. Madara by
default provides- `pallet_starknet`: Adds the CairoVM to Substrate which allows you to deploy
and execute Cairo contracts.
- `Starknet RPC`: Adds all the Starknet RPC calls to your chain so that it's
compatible with all RPC tools like starknet-js, wallets, etc.
- `DA Interface`: A general interface which allows you to use any DA layer like
`Avail`, `Celestia`, `Ethereum` etc.
- `Proving`: Running the Starknet OS which is the runtime logic in Cairo so that
it can be proven on the L1.So for many use cases where you want to change common things like
- Configuration
[parameters](https://github.com/keep-starknet-strange/madara/blob/d90cb1a3ce5389f5f530ee5eaf3c3d4c96561b12/crates/runtime/src/pallets.rs#L33)
for example block time, maximum steps etc.
- DA layer
- Genesis state
- Add new off chain workers
- Add new palletsyou don't need to fork the Madara repo. Instead, you can import the relevant
code as crates/pallets. We have created an
[app-chain-template](https://github.com/keep-starknet-strange/madara-app-chain-template)
which imports Madara as a library to show an example and would recommend you
start from here. For other more detailed use cases like- Adding a new syscall to the cairo VM
- Changing the runtime logic to deviate from Starknet's logicYou should consider forking parts of Madara.
## 📣 Peripheral repositories
- [Madara Docsite](https://github.com/keep-starknet-strange/madara-docs): The
source code of the Madara documentation website. Deployed on
`https://docs.madara.zone`.
- [Stark Compass Explorer](https://github.com/lambdaclass/madara_explorer) by
the [LambdaClass](https://lambdaclass.com/) team : An open source block
explorer for Starknet based chains.
- [Madara Infra](https://github.com/keep-starknet-strange/madara-infra): A
collection of scripts and tools to deploy and manage Madara on different
environments (e.g. AWS, docker, ansible, etc.). It also contains the
[Starknet Stack](https://github.com/keep-starknet-strange/madara-infra/blob/main/starknet-stack/docker-compose.yml)
demo `docker-compose` file.
- [Madara Tsukuyomi](https://github.com/keep-starknet-strange/madara-tsukuyomi):
The source code of the Madara Desktop App. A friendly GUI to start a Madara
node and interact with it.
- [App Chain Template](<(https://github.com/keep-starknet-strange/madara-app-chain-template)>):
A ready to use template that allows you to easily start an app chain.## 🌟 Features
- Starknet sequencer 🐺
- Built on Substrate 🌐
- Rust-based for safety and performance 🏎️
- Custom FRAME pallets for Starknet functionality 🔧
- Comprehensive documentation 📚
- Active development and community support 🤝## 🏗️ Build & Run
Want to dive straight in? Check out our
[Getting Started Guide](./docs/getting-started.md) for instructions on how to
build and run Madara on your local machine.## Benchmarking
Benchmarking is an essential process in our project development lifecycle, as it
helps us to track the performance evolution of Madara over time. It provides us
with valuable insights into how well Madara handles transaction throughput, and
whether any recent changes have impacted performance.You can follow the evolution of Madara's performance by visiting our
[Benchmark Page](https://keep-starknet-strange.github.io/madara/dev/bench/).However, it's important to understand that the absolute numbers presented on
this page should not be taken as the reference or target numbers for a
production environment. The benchmarks are run on a self-hosted GitHub runner,
which may not represent the most powerful machine configurations in real-world
production scenarios.Therefore, these numbers primarily serve as a tool to track the _relative_
performance changes over time. They allow us to quickly identify and address any
performance regressions, and continuously optimize the system's performance.In other words, while the absolute throughput numbers may not be reflective of a
production environment, the relative changes and trends over time are what we
focus on. This way, we can ensure that Madara is always improving, and that we
maintain a high standard of performance as the project evolves.One can use flamegraph-rs to generate flamegraphs and look for the performance
bottlenecks of the system by running the following :```bash
./target/release/madara setup
flamegraph --root --open -- ./target/release/madara --dev
```In parallel to that, run some transactions against your node (you can use
[Gomu Gomu no Gatling](https://github.com/keep-starknet-strange/gomu-gomu-no-gatling)
benchmarker). Once you stop the node, the flamegraph will open in your browser.## 🌐 Connect to the dev webapp
Once your Madara node is up and running, you can connect to our Dev Frontend App
to interact with your chain. [Connect here!](https://explorer.madara.zone/)## 🤝 Contribute
We're always looking for passionate developers to join our community and
contribute to Madara. Check out our [contributing guide](./docs/CONTRIBUTING.md)
for more information on how to get started.## 📖 License
This project is licensed under the **MIT license**.
See [LICENSE](LICENSE) for more information.
Happy coding! 🎉
## Contributors ✨
Thanks goes to these wonderful people
([emoji key](https://allcontributors.org/docs/en/emoji-key)):
Abdel @ StarkWare
💻
Timothée Delabrouille
💻
0xevolve
💻
Lucas @ StarkWare
💻
Davide Silva
💻
Finiam
💻
Resende
💻
drspacemn
💻
Tarrence van As
💻
Siyuan Han
📖
Zé Diogo
💻
Matthias Monnier
💻
glihm
💻
Antoine
💻
Clément Walter
💻
Elias Tazartes
💻
Jonathan LEI
💻
greged93
💻
Santiago Galván (Dub)
💻
ftupas
💻
Paul-Henry Kajfasz
💻
chirag-bgh
💻
danilowhk
💻
Harsh Bajpai
💻
amanusk
💻
Damián Piñones
💻
marioiordanov
💻
Daniel Bejarano
💻
sparqet
💻
Robin Straub
💻
tedison
💻
lanaivina
💻
Oak
💻
Pia
💻
apoorvsadana
💻
Francesco Ceccon
💻
ptisserand
💻
Zizou
💻
V.O.T
💻
Abishek Bashyal
💻
Ammar Arif
💻
lambda-0x
💻
exp_table
💻
Pilou
💻
hithem
💻
Chris Lexmond
💻
Tidus91
💻
Veronika S
💻
Asten
💻
ben2077
💻
Michael Zaikin
💻
João Pereira
📖
kasteph
💻
Ayush Tomar
💻
tchataigner
💻
Alexander Kalankhodzhaev
💻
antiyro
💻
azurwastaken
💻
Mrisho Lukamba
💻
Tbelleng
💻
Hamza Hamud
💻
Eliel Mathe
💻
This project follows the
[all-contributors](https://github.com/all-contributors/all-contributors)
specification. Contributions of any kind welcome!