Starknet Alexandria Library Documents

About

Alexandria is a community maintained standard library for Cairo. It is a collection of useful algorithms and data structures implemented in Cairo.

Version

Actual version is 0.5.1 compatible with starknet 2.11.2

Features

This repository is composed of multiple crates:

Getting Started

Prerequisites

Installation from Scarb registries

  • ASCII : scarb add alexandria_ascii@0.5.1
  • Bytes : scarb add alexandria_bytes@0.5.1
  • Data Structures : scarb add alexandria_data_structures@0.5.1
  • Encoding : scarb add alexandria_encoding@0.5.1
  • Evm : scarb add alexandria_evm@0.5.1
  • Linalg : scarb add alexandria_linalg@0.5.1
  • Math : scarb add alexandria_math@0.5.1
  • MerkleTree: scarb add alexandria_merkle_tree@0.5.1
  • Numeric : scarb add alexandria_numeric@0.5.1
  • Searching : scarb add alexandria_searching@0.5.1
  • Sorting : scarb add alexandria_sorting@0.5.1
  • Storage : scarb add alexandria_storage@0.5.1
  • Utils : scarb add alexandria_utils@0.5.1

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).

Support

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

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!