⚡ Madara: Starknet Sequencer on Substrate 🦀
Welcome to Madara, a blazing fast ⚡ Starknet sequencer designed to make your projects soar!
Built on the robust Substrate framework and fast, thanks to Rust 🦀, Madara delivers unmatched performance and scalability to power your Starknet-based Validity Rollup chain.
Dive into the world of Madara and join our passionate community of contributors! Together, we're pushing the boundaries of what's possible within the Starknet ecosystem.
🚀 Discover the unparalleled flexibility and might of Madara, your gateway to launching your very own Starknet appchain or L3. Harness the prowess of Cairo, while maintaining complete control over your custom appchain, tailored to your specific requirements. Madara is designed to empower a multitude of projects, fueling growth within the Starknet ecosystem.
🌟 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 🤝
📚 Documentation
Get started with our comprehensive documentation, which covers everything from project structure and architecture to benchmarking and running Madara:
🏗️ Build & Run
Want to dive straight in? Check out our Getting Started Guide 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.
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 :
flamegraph --root --open -- ./target/release/madara --dev --pool-limit=100000 --pool-kbytes=500000 --rpc-methods=unsafe --rpc-cors=all --in-peers=0 --out-peers=1 --no-telemetry
In parallel to that, run npm run test
within the benchmarking
folder.
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 the Polkadot-JS Apps front-end to interact with your chain. Connect here!
You can also connect to our customized fork of the Polkadot-JS Apps front-end, deployed on Madara dev webapp.
🤝 Contribute
We're always looking for passionate developers to join our community and contribute to Madara. Check out our contributing guide for more information on how to get started.
📖 License
This project is licensed under the MIT license.
See LICENSE for more information.
Happy coding! 🎉
Contributors ✨
Thanks goes to these wonderful people (emoji key):
This project follows the all-contributors specification. Contributions of any kind welcome!