From 7c09a3c9ac48ebb1e7173f845068b88fea7d3098 Mon Sep 17 00:00:00 2001 From: 0xTitan Date: Fri, 20 Feb 2026 22:03:10 +0100 Subject: [PATCH] update readme --- README.md | 51 +++++++++++++++++--------------- Scarb.toml | 2 +- packages/ascii/Scarb.toml | 2 +- packages/btc/Scarb.toml | 8 ++--- packages/bytes/Scarb.toml | 4 +-- packages/encoding/Scarb.toml | 8 ++--- packages/evm/Scarb.toml | 4 +-- packages/json/Scarb.toml | 4 +-- packages/linalg/Scarb.toml | 2 +- packages/macros_tests/Scarb.toml | 2 +- packages/merkle_tree/Scarb.toml | 2 +- packages/numeric/Scarb.toml | 4 +-- packages/searching/Scarb.toml | 2 +- packages/sorting/Scarb.toml | 2 +- 14 files changed, 50 insertions(+), 47 deletions(-) diff --git a/README.md b/README.md index 98b1b561..372e8b01 100644 --- a/README.md +++ b/README.md @@ -27,7 +27,7 @@ - [Request a Feature](#request-a-feature) - [About](#about) - [Version](#version) -- [Features](#features) +- [Packages](#packages) - [Getting Started](#getting-started) - [Prerequisites](#prerequisites) - [Installation from Scarb registries](#installation-from-scarb-registries) @@ -35,12 +35,13 @@ - [Build](#build) - [Test](#test) - [Format](#format) +- [Documentation](#documentation) +- [Security](#security) - [Roadmap](#roadmap) - [Support](#support) - [Project assistance](#project-assistance) - [Contributing](#contributing) - [Authors \& contributors](#authors--contributors) -- [Security](#security) - [License](#license) - [Acknowledgements](#acknowledgements) - [Contributors ✨](#contributors-) @@ -57,7 +58,7 @@ Current version can be found in the [toml file](./Scarb.toml) ## Version -Current version is **0.9.0** compatible with Cairo **2.15.0** +Current version is **0.10.0** compatible with Cairo **2.16.0** ## Packages @@ -75,6 +76,10 @@ This repository is composed of multiple crates: - [Storage](./packages/storage/README.md) - [Bytes](./packages/bytes/README.md) - [Evm](./packages/evm/README.md) +- [Json](./packages/json/README.md) +- [Macros](./packages/macros/README.md) +- [Merkle Tree](./packages/merkle_tree/README.md) +- [Utils](./packages/utils/README.md) - [Bitcoin](./packages/btc/README.md) ## Getting Started @@ -88,19 +93,20 @@ This repository is composed of multiple crates: ### Installation from Scarb registries -- ASCII : `scarb add alexandria_ascii@0.9.0` -- Data Structures : `scarb add alexandria_data_structures@0.9.0` -- Encoding : `scarb add alexandria_encoding@0.9.0` -- Linalg : `scarb add alexandria_linalg@0.9.0` -- Math : `scarb add alexandria_math@0.9.0` -- Numeric : `scarb add alexandria_numeric@0.9.0` -- Searching : `scarb add alexandria_searching@0.9.0` -- Sorting : `scarb add alexandria_sorting@0.9.0` -- Storage : `scarb add alexandria_storage@0.9.0` -- Bytes : `scarb add alexandria_bytes@0.9.0` -- Evm : `scarb add alexandria_evm@0.9.0` -- Bitcoin : `scarb add alexandria_btc@0.9.0` -- Json : `scarb add alexandria_json@0.9.0` +- ASCII : `scarb add alexandria_ascii@0.10.0` +- Data Structures : `scarb add alexandria_data_structures@0.10.0` +- Encoding : `scarb add alexandria_encoding@0.10.0` +- Linalg : `scarb add alexandria_linalg@0.10.0` +- Math : `scarb add alexandria_math@0.10.0` +- Merkle Tree : `scarb add alexandria_merkle_tree@0.10.0` +- Numeric : `scarb add alexandria_numeric@0.10.0` +- Searching : `scarb add alexandria_searching@0.10.0` +- Sorting : `scarb add alexandria_sorting@0.10.0` +- Storage : `scarb add alexandria_storage@0.10.0` +- Bytes : `scarb add alexandria_bytes@0.10.0` +- Evm : `scarb add alexandria_evm@0.10.0` +- Bitcoin : `scarb add alexandria_btc@0.10.0` +- Json : `scarb add alexandria_json@0.10.0` ## Usage @@ -133,7 +139,11 @@ scarb fmt ## Security -The codebase is not audited. It is actively developed, but no professional security checks have been performed on it. Use it at your own risk. We highly recommend writing your own tests for your specific use cases. +Alexandria follows good practices of security, but 100% security cannot be assured. The codebase is not audited and is actively developed, with no professional security checks performed on it. Alexandria is provided **"as is"** without any **warranty**. Use at your own risk. + +We highly recommend writing your own tests for your specific use cases. + +_For more information and to report security issues, please refer to our [security documentation](docs/SECURITY.md)._ ## Roadmap @@ -170,13 +180,6 @@ Please read [our contribution guidelines](docs/CONTRIBUTING.md), and thank you f For a full list of all authors and contributors, see [the contributors page](https://github.com/keep-starknet-strange/alexandria/contributors). -## 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](docs/SECURITY.md)._ - ## License This project is licensed under the **MIT license**. diff --git a/Scarb.toml b/Scarb.toml index ac3d0bdc..05c0d6f0 100644 --- a/Scarb.toml +++ b/Scarb.toml @@ -34,7 +34,7 @@ snforge_std = "0.56.0" sort-module-level-items = true [workspace.package] -version = "0.9.0" +version = "0.10.0" [profile.coverage] sierra = true diff --git a/packages/ascii/Scarb.toml b/packages/ascii/Scarb.toml index ade469e6..992c388f 100644 --- a/packages/ascii/Scarb.toml +++ b/packages/ascii/Scarb.toml @@ -10,7 +10,7 @@ cairo-version = "2.16.0" fmt.workspace = true [dependencies] -alexandria_data_structures = { path = "../data_structures", version ="0.9.0" } +alexandria_data_structures = { path = "../data_structures", version ="0.10.0" } [dev-dependencies] snforge_std.workspace = true diff --git a/packages/btc/Scarb.toml b/packages/btc/Scarb.toml index 868a1337..548de83f 100644 --- a/packages/btc/Scarb.toml +++ b/packages/btc/Scarb.toml @@ -10,10 +10,10 @@ cairo-version = "2.16.0" fmt.workspace = true [dependencies] -alexandria_encoding = { path = "../encoding", version = "0.9.0" } -alexandria_data_structures = { path = "../data_structures", version = "0.9.0" } -alexandria_math = { path = "../math", version = "0.9.0" } -alexandria_bytes = { path = "../bytes", version = "0.9.0" } +alexandria_encoding = { path = "../encoding", version = "0.10.0" } +alexandria_data_structures = { path = "../data_structures", version = "0.10.0" } +alexandria_math = { path = "../math", version = "0.10.0" } +alexandria_bytes = { path = "../bytes", version = "0.10.0" } [dev-dependencies] diff --git a/packages/bytes/Scarb.toml b/packages/bytes/Scarb.toml index 14718d48..87d98145 100644 --- a/packages/bytes/Scarb.toml +++ b/packages/bytes/Scarb.toml @@ -10,8 +10,8 @@ cairo-version = "2.16.0" fmt.workspace = true [dependencies] -alexandria_math = { path = "../math", version ="0.9.0" } -alexandria_data_structures = { path = "../data_structures", version ="0.9.0" } +alexandria_math = { path = "../math", version ="0.10.0" } +alexandria_data_structures = { path = "../data_structures", version ="0.10.0" } starknet.workspace = true diff --git a/packages/encoding/Scarb.toml b/packages/encoding/Scarb.toml index a503f3c5..a1c9cb03 100644 --- a/packages/encoding/Scarb.toml +++ b/packages/encoding/Scarb.toml @@ -10,10 +10,10 @@ cairo-version = "2.16.0" fmt.workspace = true [dependencies] -alexandria_math = { path = "../math", version ="0.9.0" } -alexandria_numeric = { path = "../numeric", version ="0.9.0" } -alexandria_bytes = { path = "../bytes", version ="0.9.0" } -alexandria_data_structures = { path = "../data_structures", version ="0.9.0" } +alexandria_math = { path = "../math", version ="0.10.0" } +alexandria_numeric = { path = "../numeric", version ="0.10.0" } +alexandria_bytes = { path = "../bytes", version ="0.10.0" } +alexandria_data_structures = { path = "../data_structures", version ="0.10.0" } [dev-dependencies] diff --git a/packages/evm/Scarb.toml b/packages/evm/Scarb.toml index e190a57e..4ec37ff0 100644 --- a/packages/evm/Scarb.toml +++ b/packages/evm/Scarb.toml @@ -10,8 +10,8 @@ cairo-version = "2.16.0" fmt.workspace = true [dependencies] -alexandria_math = { path = "../math", version ="0.9.0" } -alexandria_bytes = { path = "../bytes", version ="0.9.0" } +alexandria_math = { path = "../math", version ="0.10.0" } +alexandria_bytes = { path = "../bytes", version ="0.10.0" } [dev-dependencies] snforge_std.workspace = true diff --git a/packages/json/Scarb.toml b/packages/json/Scarb.toml index d9d0303f..855650c3 100644 --- a/packages/json/Scarb.toml +++ b/packages/json/Scarb.toml @@ -10,8 +10,8 @@ cairo-version = "2.16.0" fmt.workspace = true [dependencies] -alexandria_math = { path = "../math", version ="0.9.0" } -alexandria_macros = { path = "../macros", version ="0.9.0" } +alexandria_math = { path = "../math", version ="0.10.0" } +alexandria_macros = { path = "../macros", version ="0.10.0" } starknet.workspace = true diff --git a/packages/linalg/Scarb.toml b/packages/linalg/Scarb.toml index 254c8334..854d8fe4 100644 --- a/packages/linalg/Scarb.toml +++ b/packages/linalg/Scarb.toml @@ -10,7 +10,7 @@ cairo-version = "2.16.0" fmt.workspace = true [dependencies] -alexandria_math = { path = "../math", version ="0.9.0" } +alexandria_math = { path = "../math", version ="0.10.0" } [dev-dependencies] snforge_std.workspace = true diff --git a/packages/macros_tests/Scarb.toml b/packages/macros_tests/Scarb.toml index d1f50e85..0d5cfcf1 100644 --- a/packages/macros_tests/Scarb.toml +++ b/packages/macros_tests/Scarb.toml @@ -6,7 +6,7 @@ edition = "2024_07" cairo-version = "2.16.0" [dependencies] -starknet = "2.15.0" +starknet = "2.16.0" alexandria_macros = { path = "../macros", version = "*" } alexandria_math = { path = "../math", version = "*" } diff --git a/packages/merkle_tree/Scarb.toml b/packages/merkle_tree/Scarb.toml index 001b3bc7..8c3457a0 100644 --- a/packages/merkle_tree/Scarb.toml +++ b/packages/merkle_tree/Scarb.toml @@ -10,7 +10,7 @@ cairo-version = "2.16.0" fmt.workspace = true [dependencies] -alexandria_math = { path = "../math", version = "0.9.0" } +alexandria_math = { path = "../math", version = "0.10.0" } [dev-dependencies] snforge_std.workspace = true diff --git a/packages/numeric/Scarb.toml b/packages/numeric/Scarb.toml index b2e3f242..898338c7 100644 --- a/packages/numeric/Scarb.toml +++ b/packages/numeric/Scarb.toml @@ -10,8 +10,8 @@ cairo-version = "2.16.0" fmt.workspace = true [dependencies] -alexandria_math = { path = "../math", version = "0.9.0" } -alexandria_searching = { path = "../searching", version = "0.9.0" } +alexandria_math = { path = "../math", version = "0.10.0" } +alexandria_searching = { path = "../searching", version = "0.10.0" } [dev-dependencies] snforge_std.workspace = true diff --git a/packages/searching/Scarb.toml b/packages/searching/Scarb.toml index e6a4e663..e563a116 100644 --- a/packages/searching/Scarb.toml +++ b/packages/searching/Scarb.toml @@ -11,7 +11,7 @@ fmt.workspace = true [dependencies] # dependency due to VecTrait usage in dijkstra.cairo -alexandria_data_structures = { path = "../data_structures", version = "0.9.0" } +alexandria_data_structures = { path = "../data_structures", version = "0.10.0" } [dev-dependencies] snforge_std.workspace = true diff --git a/packages/sorting/Scarb.toml b/packages/sorting/Scarb.toml index 8fac8827..5e54ef45 100644 --- a/packages/sorting/Scarb.toml +++ b/packages/sorting/Scarb.toml @@ -10,7 +10,7 @@ cairo-version = "2.16.0" fmt.workspace = true [dependencies] -alexandria_data_structures = { path = "../data_structures", version = "0.9.0" } +alexandria_data_structures = { path = "../data_structures", version = "0.10.0" } [dev-dependencies] snforge_std.workspace = true