DOCSEARCHbyAlgolia
Submit Docs

Commonware Documentation

repository·main·Indexed 20 days ago

https://github.com/commonwarexyz/monorepo

A collection of high-performance, security-focused primitives for adversarial environments. The monorepo includes crates for consensus (commonware-consensus), cryptography (commonware-cryptography), P2P networking/broadcasting (commonware-broadcast), actor coordination (commonware-actor), data serialization (commonware-codec), and erasure coding (commonware-coding), along with tools for conformance testing and Byzantine environment fuzzing.

Tokens
101.8K
Snippets
275
Records
439
Agent score
69%

What's inside Commonware

  1. Overview of commonware-glue

    main
    The commonware-glue crate provides default constructions and integrations that span multiple commonware primitives. It is designed to facilitate interoperability and higher-level orchestration between the individual building blocks of the commonware ecosystem.

  4. Overview of commonware-conformance

    main
    The commonware-conformance crate is used to automatically assert the stability of encoding mechanisms and primitives over time. This ensures that changes to the codebase do not inadvertently break established stability guarantees for core commonware components.

  5. Overview of commonware-codec

    main

    commonware-codec is a library designed for serializing structured data. It provides primitives for converting complex data structures into a format suitable for storage or transmission.

    Note on Stability: Stability levels vary depending on the specific primitive being used. Before integrating a primitive into a production environment, verify its stability level (e.g., BETA or higher) by checking the project's central stability documentation.

  8. Overview of commonware-parallel

    main
    The commonware-parallel crate provides tools to parallelize fold operations. It allows developers to execute folding logic across multiple threads or execution contexts using pluggable execution strategies, enabling efficient data processing through parallelism.

  10. Overview of commonware-stream

    main
    The commonware-stream crate provides a mechanism to exchange messages over arbitrary transport layers. It abstracts the underlying communication medium, allowing developers to implement message passing patterns that are decoupled from specific network or IPC protocols.

  11. Overview of commonware-cryptography

    main

    The commonware-cryptography crate provides tools for cryptographic operations, specifically focusing on key generation, message signing, and deterministic verification of untrusted signatures.

    Note on Stability: Stability levels vary depending on the specific cryptographic primitive used. Users should check the project's central stability guidelines to ensure they are using APIs that meet their production requirements.