2 unstable releases

new 0.1.0 Nov 19, 2024
0.0.1 Oct 12, 2024

#3 in #round

Download history 176/week @ 2024-10-08 39/week @ 2024-10-15 3/week @ 2024-10-22 4/week @ 2024-10-29 5/week @ 2024-11-05

67 downloads per month

AGPL-3.0-or-later

200KB
4K SLoC

Round-based distributed protocols

crate Docs License Build Status Coveralls

The body is round

Goals

  • Sans-I/O API. That is, bring your own async libraries, or don't.
  • Generic over signer/verifier/signature types, so you can use whatever your blockchain uses.
  • Support parallelization where possible, to offload expensive cryptographic operations into spawned tasks (but since it's Sans-I/O, it's up to you to make use of that functionality).
  • Provide tools for unit and integration testing of the protocols.
  • Support generating malicious behavior proofs with bundled signed messages.
  • Support caching messages intended for the next round and then applying them when it starts (since some nodes can finalize a round before others and send out a new batch of messages).

Assumptions

We try to find the balance between supporting the majority of protocols and keeping the API simple. Currently we operate under the following assumptions:

  • A protocol consists of several rounds.
  • A round generates messages to send out without any additional external input, then waits for messages from other parties. When it receives enough messages, it can be finalized.
  • On finalization, a round can return the result, halt with an error, or continue to another round.
  • Each round declares a set of parties it sends messages to. Then it can optionally send a direct message to each party in the set, set a regular broadcast to all parties in the set, or send an echo-broadcast to all parties in the set (that is, a broadcast where it is ensured that all parties received the same thing). Any number of these options can be picked.

Dependencies

~1.7–2.8MB
~62K SLoC