README.md

cairo-lib: Comprehensive Library for Cairo 🐺

Welcome to cairo-lib – a comprehensive library for the Cairo language. This library provides a suite of tools to supercharge your Cairo development experience. Inspired by Alexandria.

⚠️ Disclaimer: This library is in its early stages and has not been audited yet. It may contain bugs or vulnerabilities. Use at your own risk and ensure proper review and testing when integrating into your projects.

Features

• Data Structures
• Encoding
• Hashers
• Utilities

Getting Started

Building

To compile the library:

scarb build

Formatting:

To format your code:

scarb fmt

Testing

Run the tests using:

scarb test

Installation

Add to your Scarb.toml dependencies:

[dependencies]
cairo_lib = { git = "https://github.com/HerodotusDev/cairo-lib.git" }

Usage

For example, to utilize a specific tool from the library:

use cairo_lib::utils::types::words64::{Words64, Words64Trait};

License

cairo-lib is licensed under the GNU General Public License v3.0.