https://github.com/tangle-network/dkg-substrate
Multy-party threshold ECDSA (GG20) Substrate node
https://github.com/tangle-network/dkg-substrate
blockchain cryptography gg20 multiparty-computation polkadot substrate zero-knowledge
Last synced: 23 days ago
JSON representation
Multy-party threshold ECDSA (GG20) Substrate node
- Host: GitHub
- URL: https://github.com/tangle-network/dkg-substrate
- Owner: tangle-network
- License: gpl-3.0
- Created: 2021-10-25T16:30:13.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-12-18T16:13:30.000Z (over 1 year ago)
- Last Synced: 2025-04-09T23:05:16.201Z (about 1 month ago)
- Topics: blockchain, cryptography, gg20, multiparty-computation, polkadot, substrate, zero-knowledge
- Language: Rust
- Homepage: https://tangle.webb.tools/
- Size: 22.9 MB
- Stars: 60
- Watchers: 2
- Forks: 15
- Open Issues: 30
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
🚀 Threshold ECDSA Distributed Key Generation Protocol 🔑
[](https://github.com/webb-tools/dkg-substrate/actions) [](https://codecov.io/gh/webb-tools/dkg-substrate) [](https://www.gnu.org/licenses/gpl-3.0) [](https://t.me/webbprotocol) [](https://discord.gg/cv8EfJu3Tn)
📖 Table of Contents
Table of Contents
Getting Started 🎉
The DKG is a multi-party computation protocol that generates a group public and private key. We aim to use this group keypair to sign arbitrary messages that will govern protocols deployed around the blockchain ecosystem. One primary purpose for the DKG is to govern and facilitate operations of the private signature bridge/anchor system.
For additional information, please refer to the [Webb DKG Rust Docs](https://webb-tools.github.io/dkg-substrate/) 📝. Have feedback on how to improve the dkg? Or have a specific question to ask? Checkout the [DKG Feedback Discussion](https://github.com/webb-tools/feedback/discussions/categories/dkg-feedback) 💬.
## Prerequisites
This guide uses installer and the `rustup` tool to manage the Rust toolchain.
First install and configure `rustup`:
```bash
# Install
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
# Configure
source ~/.cargo/env
```
Configure the Rust toolchain to default to the latest stable version, add nightly and the nightly wasm target:
```bash
rustup default nightly
rustup update
rustup update nightly
rustup target add wasm32-unknown-unknown
```
## Installation 💻
```bash
cargo build --release
```
> NOTE: You _must_ use the release builds! The optimizations here are required
> as in debug mode, it is expected that nodes are not able to run fast enough to produce blocks.
## Installation Using Nix 💻
1. Install [Nix](https://nixos.org/download.html)
2. Enable [Flakes](https://nixos.wiki/wiki/Flakes)
3. If you have [`direnv`](https://github.com/nix-community/nix-direnv#installation) installed, everything should work out of the box.
4. Run `nix develop` in the root of this repo to get a shell with all the dependencies installed.
Usage
Standalone Local Testnet
```bash
./scripts/run-local-testnet.sh --clean
```
This should start the local testnet, you can view the logs in `/tmp` directory for all the authorities and use [polkadotJS](https://polkadot.js.org/apps/?rpc=ws%3A%2F%2F127.0.0.1%3A9944#/explorer) to view the running testnet.
Testing 🧪
The following instructions outline how to run dkg-substrate's base test suite and E2E test suite.
### Unit Tests
```
cargo test
```
### Stress Tests
When debugging the internal mechanics of the DKG, it is useful to run the stress tests. These tests are designed to run the DKG with a custom number of authorities. This allows you to quickly debug the DKG without having to setup a local chain.
```
# Build the dkg-standalone node
cargo build --release -p dkg-standalone-node --features=integration-tests,testing
# run the orchestrator, making sure to use the proper config
cargo run --package dkg-test-orchestrator --release --features=testing -- --config /path/to/orchestrator_config.toml
```
### Local Chain Tests (Automatic)
To test the DKG against a local testnet, run:
```
cargo make integration-tests
```
### Local Chain Tests (Manual)
If manual control is needed over the nodes (e.g., for debugging and/or shutting down nodes to test fault-tolerance), first build the binary:
```
cargo make build-test
```
Then, start the bootnode (Alice):
```
cargo make alice
```
Once Alice is running, start the other nodes each in separate terminals/processes:
```
cargo make bob
cargo make charlie
cargo make dave
cargo make eve
```
### Setting up debugging logs
If you would like to run the dkg with verbose logs you may add the following arguments during initial setup. You may change the target to include `debug | error | info| trace | warn`. You may also want to review [Substrate runtime debugging](https://docs.substrate.io/v3/runtime/debugging/).
```
-ldkg=debug \
-ldkg_metadata=debug \
-lruntime::offchain=debug \
-ldkg_proposal_handler=debug \
-ldkg_proposals=debug
```
Contributing
Interested in contributing to the Webb DKG Protocol? Thank you so much for your interest! We are always appreciative for contributions from the open-source community!
If you have a contribution in mind, please check out our [Contribution Guide](./.github/CONTRIBUTING.md) for information on how to do so. We are excited for your first contribution!
License
Licensed under GNU General Public License v3.0.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this crate by you, as defined in the GNU General Public License v3.0 license, shall be licensed as above, without any additional terms or conditions.
## Troubleshooting
The linking phase may fail due to not finding libgmp (i.e., "could not find library -lgmp") when building on a mac M1. To fix this problem, run:
```bash
brew install gmp
# make sure to run the commands below each time when starting a new env, or, append them to .zshrc
export LIBRARY_PATH=$LIBRARY_PATH:/opt/homebrew/lib
export INCLUDE_PATH=$INCLUDE_PATH:/opt/homebrew/include