ceremonyclient/crates/dkls23/README.md
Cassandra Heart 12996487c3
v2.1.0.18 (#508)
* experiment: reject bad peer info messages

* v2.1.0.18 preview

* add tagged sync

* Add missing hypergraph changes

* small tweaks to sync

* allow local sync, use it for provers with workers

* missing file

* resolve build error

* resolve sync issue, remove raw sync

* resolve deletion promotion bug

* resolve sync abstraction leak from tree deletion changes

* rearrange prover sync

* remove pruning from sync

* restore removed sync flag

* fix: sync, event stream deadlock, heuristic scoring of better shards

* resolve hanging shutdown + pubsub proxy issue

* further bugfixes: sync (restore old leaf sync), pubsub shutdown, merge events

* fix: clean up rust ffi, background coverage events, and sync tweaks

* fix: linking issue for channel, connectivity test aggression, sync regression, join tests

* fix: disjoint sync, improper application of filter

* resolve sync/reel/validation deadlock

* adjust sync to handle no leaf edge cases, multi-path segment traversal

* use simpler sync

* faster, simpler sync with some debug extras

* migration to recalculate

* don't use batch

* square up the roots

* fix nil pointer

* fix: seniority calculation, sync race condition, migration

* make sync dumber

* fix: tree deletion issue

* fix: missing seniority merge request canonical serialization

* address issues from previous commit test

* stale workers should be cleared

* remove missing gap check

* rearrange collect, reduce sync logging noise

* fix: the disjoint leaf/branch sync case

* nuclear option on sync failures

* v2.1.0.18, finalized
2026-02-08 23:51:51 -06:00

64 lines
2.3 KiB
Markdown

<div align="center">
<picture>
<source srcset=".assets/dkls23-banner.png" media="(prefers-color-scheme: dark)">
<img src=".assets/dkls23-banner.png" alt="DKLs logo">
</picture>
<p>
<a href="https://github.com/0xCarbon/DKLs23/actions?query=workflow%3Abackend-ci">
<img src="https://github.com/0xCarbon/DKLs23/actions/workflows/backend-ci.yml/badge.svg?event=push" alt="Test Status">
</a>
<a href="https://crates.io/crates/dkls23">
<img src="https://img.shields.io/crates/v/dkls23.svg" alt="DKLs23 Crate">
</a>
<a href="https://docs.rs/dkls23/latest/dkls23/">
<img src="https://docs.rs/dkls23/badge.svg" alt="DKLs23 Docs">
</a>
</p>
</div>
<br />
## Overview
DKLs23 is an advanced open-source implementation of the Threshold ECDSA method (see https://eprint.iacr.org/2023/765.pdf). The primary goal of DKLs23 is to compute a secret key without centralizing it in a single location. Instead, it leverages multiple parties to compute the secret key, with each party receiving a key share. This approach enhances security by eliminating single points of failure.
## Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
### Installation
A step-by-step guide to installing the project.
1. **Install Rust using `rustup`**
``` bash
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
```
2. **Clone the repository:**
```bash
git clone https://github.com/0xCarbon/DKLs23 cd DKLs23
```
3. **Install dependencies:**
```bash
cargo build
```
## Contributing
We welcome contributions! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for details on how to get started.
## Security
For information on how to report security vulnerabilities, please see our [SECURITY.md](SECURITY.md).
## Code of Conduct
Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.
## License
This project is licensed under either of
- [Apache License, Version 2.0](LICENSE-APACHE)
- [MIT license](LICENSE-MIT)
at your option.
## Authors
See the list of [contributors](https://github.com/0xCarbon/DKLs23/contributors) who participated in this project.