dubzn/quaireaux

A set of opinionated Cairo 1.0 libraries and algorithms.

Alexandria

Report a Bug - Request a Feature - Ask a Question

Table of Contents

• Report a Bug
• Request a Feature
• About
• Features
• Getting Started
  • Prerequisites
  • Installation
• Usage
  • Build
  • Run
  • Test
  • Format
• Roadmap
• Support
• Project assistance
• Contributing
• Authors & contributors
• Security
• License
• Acknowledgements
• Contributors ✨

---

About

Alexandria is a community maintained standard library for Cairo 1.0. It is a collection of useful algorithms and data structures implemented in Cairo. Current version can be found in the toml file

Features

This repository is composed of multiple crates:

• ASCII
• Data Structures
• Encoding
• Linalg
• Math
• Numeric
• Searching
• Sorting
• Storage
• Bytes

Getting Started

Prerequisites

• Cairo
• Scarb
• Rust

Installation

Alexandria is a collection of utility Cairo packages, which have to be added as dependencies separately. For example, the alexandria_math package can be installed by adding the following line to your Scarb.toml:

[dependencies]
alexandria_math = { git = "https://github.com/keep-starknet-strange/alexandria.git" }

then add the following line in your .cairo file

use alexandria_math::sha512::sha512;

Usage

Build

scarb build

Test

scarb test

Running a specific subset of tests

scarb test -f math

Format

scarb fmt

Roadmap

See the open issues for a list of proposed features (and known issues).

• Top Feature Requests (Add your votes using the 👍 reaction)
• Top Bugs (Add your votes using the 👍 reaction)
• Newest Bugs

Support

Reach out to the maintainer at one of the following places:

• GitHub Discussions
• Contact options listed on this GitHub profile

Project assistance

If you want to say thank you or/and support active development of Alexandria:

• Add a GitHub Star to the project.
• Tweet about the Alexandria.
• Write interesting articles about the project on Dev.to, Medium or your personal blog.

Together, we can make Alexandria better!

Contributing

First off, thanks for taking the time to contribute! Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make will benefit everybody else and are greatly appreciated.

Please read our contribution guidelines, and thank you for being involved!

Authors & contributors

For a full list of all authors and contributors, see the contributors page.

Security

Alexandria follows good practices of security, but 100% security cannot be assured. Alexandria is provided "as is" without any warranty. Use at your own risk.

For more information and to report security issues, please refer to our security documentation.

License

This project is licensed under the MIT license.

See LICENSE for more information.

Acknowledgements

• TheAlgorithms/Rust for inspiration regarding the implementation of algorithms.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Abdel @ StarkWare 💻	Santiago Galván (Dub) 💻	Damián Piñones 💻	greged93 💻	Marek Kaput 💻	amanusk 💻	Mathieu 💻
0xevolve 💻	Jordy Romuald 💻	gaetbout 💻	Lucas @ StarkWare 💻	Milan Cermak 💻	Paweł 💻	Ondřej Sojka 💻
tedison 💻	raphaelDkhn 💻	Charles Lanier 💻	omahs 💻	Maciej Kamiński 💻	Bal7hazar @ Carbonable 💻	kahi 💻
0xTitan 💻	Erim 💻	maciektr 💻	lambda-0x 💻	Elias Tazartes 💻	akhercha 💻	azurwastaken 💻
Add your contributions

This project follows the all-contributors specification. Contributions of any kind welcome!