https://github.com/starknet-io/types-rs

🐺 Starknet Rust types 🦀
https://github.com/starknet-io/types-rs

Last synced: 4 days ago
JSON representation

🐺 Starknet Rust types 🦀

• Host: GitHub
• URL: https://github.com/starknet-io/types-rs
• Owner: starknet-io
• License: mit
• Created: 2023-05-25T06:48:29.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-11-05T07:32:51.000Z (about 1 month ago)
• Last Synced: 2024-11-30T18:56:08.603Z (12 days ago)
• Language: Rust
• Size: 198 KB
• Stars: 66
• Watchers: 3
• Forks: 41
• Open Issues: 22
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

• awesome-starknet - types-rs - Rust types. (Additional developer resources)
• awesome-ccamel - starknet-io/types-rs - 🐺 Starknet Rust types 🦀 (Rust)

README

        
# types-rs

 🐺  Starknet Rust types 🦀

 [![GitHub Workflow Status](https://github.com/starknet-io/types-rs/actions/workflows/test.yml/badge.svg)](https://github.com/starknet-io/types-rs/actions/workflows/test.yml)

[![Project license](https://img.shields.io/github/license/starknet-io/types-rs.svg?style=flat-square)](LICENSE)

[![Pull Requests welcome](https://img.shields.io/badge/PRs-welcome-ff69b4.svg?style=flat-square)](https://github.com/starknet-io/types-rs/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22)

[![Rust docs](https://docs.rs/starknet-types-core/badge.svg)](https://docs.rs/starknet-types-core)

[![Rust crate](https://img.shields.io/crates/v/starknet-types-core.svg)](https://crates.io/crates/starknet-types-core)

This repository is an initiative by a group of maintainers to address the fragmentation in the Starknet Rust ecosystem and improve its interoperability. The key motivation behind this repository is to standardize the representation of the `Felt` (Field Element) type in Rust, which is massively used as the core and atomic type of the Cairo language and its Virtual Machine.

The `Felt` type is currently defined in many different crates and repositories, resulting in increased code complexity and performance issues due to the need for numerous conversions. This repository aims to mitigate these issues by providing a universal `Felt` type in Rust.

## Crates

This repository hosts two crates:

- `starknet-types-core`: This crate provides the universal Felt (Field Element) type for Cairo and STARK proofs. It also focuses on Starknet types related to computation and execution, requiring performance and optimization for specific arithmetic and cryptographic operations.

- `starknet-types-rpc`: This crate deals with Starknet types used in RPC communication, serde, and transport.

## Usage

You can include any of these crates in your library via crates.io or as a git dependency. For example, to include the `starknet-types-core` crate, add the following to your `Cargo.toml`:

As a crates.io dependency:

```toml

[dependencies]

starknet-types-core = "0.1.0"

```

As a git dependency:

```toml

[dependencies]

starknet-types-core = { git = "https://github.com/starknet-io/types-rs.git", version = "0.1.0", default-features = false, features = ["serde"] }

```

## Build from source

To build the crates from source, clone the repository and run the following command:

```bash

cargo build --release

```

## Testing

To run the tests, clone the repository and run the following command:

```bash

cargo test

```

## Contributing

Contributions are welcome! Please read our [contributing guidelines](CONTRIBUTING.md) for more information.

## License

This repository is licensed under the MIT License, see [LICENSE](LICENSE) for more information.