sl-dkls23 1.0.0-beta

DKLs23 implementation for threshold ECDSA signatures
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123

name: CI and Benchmarks

on:
  push:
    branches:
      - main
    paths:
      - 'src/**'
      - 'scripts/**'
      - 'crates/**'
      - '.github/**'
  pull_request:
    branches:
      - main
    paths:
      - 'src/**'
      - 'scripts/**'
      - 'crates/**'
      - '.github/**'

permissions:
  contents: write
  deployments: write

jobs:
  lints:
    name: Lints
    runs-on: github-builder
    steps:
      - name: Checkout sources
        uses: actions/checkout@v4

      - name: Install stable toolchain
        uses: dtolnay/rust-toolchain@1.85
        with:
          components: rustfmt clippy

      - uses: Swatinem/rust-cache@v2
        with:
          shared-key: "build"

      - name: Run cargo fmt
        run: |
          cargo fmt --all -- --check

      - name: Run cargo clippy
        run: cargo clippy --all -- -D warnings

  build-and-test:
    name: Rust tests
    runs-on: github-builder
    needs: lints
    steps:
      - name: Checkout sources
        uses: actions/checkout@v4
      - name: Install stable toolchain
        uses: dtolnay/rust-toolchain@1.85
      - uses: Swatinem/rust-cache@v2
        with:
          shared-key: "build"
      - run: cargo test --tests --all --release

  get_benchmark:
    name: Run Benchmarks
    runs-on: github-builder
    needs: build-and-test
    steps:
      - uses: actions/checkout@v4
      - name: Install stable toolchain
        uses: dtolnay/rust-toolchain@1.85
      - name: Run benchmark
        run: cd crates/dkls-metrics/benches && cargo +nightly bench -- --output-format bencher > /tmp/output.txt
      - name: Create benchmarks
        uses: benchmark-action/github-action-benchmark@v1.20.4
        with:
          name: Rust Benchmark
          tool: 'cargo'
          output-file-path: /tmp/output.txt
          github-token: ${{ secrets.GITHUB_TOKEN }}
          benchmark-data-dir-path: docs
          auto-push: true
          comment-on-alert: true
          summary-always: true

  make_the_html_page:
    name: Create HTML page
    runs-on: github-builder
    needs: get_benchmark
    steps:
      - name: Checkout code (main)
        uses: actions/checkout@v4
      - name: Checkout gh-pages branch
        uses: actions/checkout@v4
        with:
          ref: gh-pages
          path: gh-pages
      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version: 3.9
      - name: Install stable toolchain
        uses: dtolnay/rust-toolchain@1.85
        with:
          toolchain: 1.85
      - name: Write the HTML page
        run: |
          python -m pip install --upgrade pip
          python scripts/process_benchmarks_to_html.py gh-pages/docs/data.js
          cargo clean
          cargo doc --no-deps
          mkdir -p docs/rustdocs
          mkdir -p docs/docs
          cp scripts/sil.jpg docs
          mv gh-pages/* docs
          mv index.html docs
          cp -rf target/doc/* docs/dkls23/
          cp -rf target/doc/* docs/docs/
          
      - name: Deploy to GitHub Pages
        uses: JamesIves/github-pages-deploy-action@v4
        with:
          branch: gh-pages
          folder: docs