Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/HerodotusDev/cairo-lib
A comprehensive library for Cairo 🐺
https://github.com/HerodotusDev/cairo-lib
cairo cairo-lang herodotus
Last synced: 24 days ago
JSON representation
A comprehensive library for Cairo 🐺
- Host: GitHub
- URL: https://github.com/HerodotusDev/cairo-lib
- Owner: HerodotusDev
- License: gpl-3.0
- Created: 2023-06-15T04:17:42.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-06-20T08:08:57.000Z (6 months ago)
- Last Synced: 2024-08-05T01:10:52.325Z (4 months ago)
- Topics: cairo, cairo-lang, herodotus
- Language: Cairo
- Homepage:
- Size: 2.4 MB
- Stars: 37
- Watchers: 2
- Forks: 11
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Audit: audit/ChainSecurity_Herodotus_CairoLib_audit.pdf
Awesome Lists containing this project
- awesome-starknet - Herodotus cairo-lib - Set of Data Structures, Encoding, Hashers and Utilities for Cairo. (Additional developer resources)
README
# `cairo-lib`: Comprehensive Library for Cairo 🐺
[](https://github.com/HerodotusDev/cairo-lib/actions/workflows/ci.yml)
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](https://github.com/keep-starknet-strange/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**](./src/data_structures/)
- [**Encoding**](./src/encoding/)
- [**Hashers**](./src/hashing/)
- [**Utilities**](./src/utils/)
## Getting Started
### Building
To compile the library:
```bash
scarb build
```
### Formatting:
To format your code:
```bash
scarb fmt
```
### Testing
Run the tests using:
```bash
scarb test
```
### Installation
Add to your `Scarb.toml` dependencies:
```toml
[dependencies]
cairo_lib = { git = "https://github.com/HerodotusDev/cairo-lib.git" }
```
### Usage
For example, to utilize a specific tool from the library:
```cairo
use cairo_lib::utils::types::words64::{Words64, Words64Trait};
```
## License
`cairo-lib` is licensed under the [GNU General Public License v3.0](./LICENSE).