feat: ed25519 digital signature scheme (#179)

* init: eddsa

* fix lint&spell

* improve code comment and add doc

* fix readme dsa, downgrade anim quality

* fix latex, add bench

* improve keygen algo

* improve doc

* fix doc

* fix doc tex, add sha512

* update spell dict

* mv imgs/gifs to assets, cleanup

* add mdbook and deploy on gh-pages

* fix fmt

* use write_all instead of write

* update readme,book.toml,add desc to create_mdbook

* finalize

* update book.toml

* add sk,pk to struct, generic sha

* remove unused feature

Author: mrdaybird

.codespell-ignore

@@ -2,3 +2,4 @@ ronkathon
 crate
 nd
 te
+SHS

.github/workflows/deploy.yml

@@ -0,0 +1,61 @@
+name: Deploy mdBook site to Pages
+
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches: ["main"]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  # Build job
+  build:
+    runs-on: ubuntu-latest
+    env:
+      MDBOOK_VERSION: 0.4.43
+      MDBOOK_KATEX_VERSION: 0.9.2
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install mdBook
+        run: |
+          curl --proto '=https' --tlsv1.2 https://sh.rustup.rs -sSf -y | sh
+          rustup update
+          cargo install --version ${MDBOOK_VERSION} mdbook
+          cargo install --version ${MDBOOK_KATEX_VERSION} mdbook-katex
+      - name: Setup Pages
+        id: pages
+        uses: actions/configure-pages@v5
+      - name: Build with mdBook
+        run: |
+          cargo run --bin create_mdbook
+          cp -r assets book/
+          mdbook build
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: ./docs
+
+  # Deployment job
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -33,3 +33,9 @@ dump
 
 # coverage files
 lcov.info
+
+# mdbook
+create_mdbook
+book
+mdbook
+docs

Cargo.lock

@@ -5,13 +5,16 @@ edition    ="2021"
 license    ="MIT OR Apache-2.0"
 name       ="ronkathon"
 repository ="https://github.com/pluto/ronkathon"
-version    = "0.1.1"
-exclude    =["CHANGELOG.md", "src/tree/ConstructMerkleTree.gif"]
+version    ="0.1.1"
+exclude    =["CHANGELOG.md", "assets/"]
 
 [dependencies]
-rand     ="0.8"
-itertools="0.14"
-hex      ="0.4"
+rand          ="0.8"
+itertools     ="0.14"
+hex           ="0.4"
+crypto-bigint ="0.6.0-rc.6"
+regex         ="1.11.1"
+num-traits    ="0.2.19"
 
 [dev-dependencies]
 rstest               ="0.24"
@@ -21,6 +24,7 @@ ark-ff               ={ version="0.5", features=["std"] }
 ark-crypto-primitives={ version="0.5", features=["sponge"] }
 des                  ="0.8"
 chacha20             ="0.9"
+hex-literal          ="0.4"
 
 [[bin]]
 name="hmac_sha256_bin"

Cargo.toml

@@ -34,9 +34,10 @@ to run example code.
 
 ## Primitives
 
-- [Finite Group](src/field/group.rs)
-- [Fields and Their Extensions](src/field/README.md)
-  - [Binary Fields](src/field/binary_towers/README.md)
+- **Fundamental Algebraic Structures**
+    - [Group](src/algebra/group/README.md)
+    - [Fields and Their Extensions](src/algebra/field/README.md)
+        - [Binary Fields](src/field/binary_towers/README.md)
 - [Curves and Their Pairings](src/curve/README.md)
 - [Polynomials](src/polynomial/mod.rs)
 - [KZG Commitments](src/kzg/README.md)
@@ -46,7 +47,9 @@ to run example code.
 
 ### Signatures
 
-- [Tiny ECDSA](src/ecdsa.rs)
+- [Digital Signature Algorithms](src/dsa/README.md)
+    - [Elliptic Curve Digital Signature Algorithm(ECDSA)](src/dsa/ecdsa.rs)
+    - [Edwards-Curve Digital Signature Algorithm(EdDSA)](src/dsa/eddsa/mod.rs)
 
 ### Encryption
 
@@ -68,10 +71,6 @@ to run example code.
 - [Sha256 Hash](src/hashes/README.md)
 - [Poseidon Hash](src/hashes/poseidon/README.md)
 
-## In Progress
-
-- [ ] Edwards curve Signatures (EdDSA)
-
 ## Resources
 
 We have found the following resources helpful in understanding the foundational mathematics behind this implementation. After going through these, you should be able to understand the codebase

README.md

@@ -0,0 +1,22 @@
+- [Introduction](README.md)
+- [Algebra](src/algebra/README.md)
+    - [Field](src/algebra/field/README.md)
+        - [Binary Towers](src/algebra/field/binary_towers/README.md)
+    - [Group](src/algebra/group/README.md)
+- [Codes](src/codes/README.md)
+- [Compiler](src/compiler/README.md)
+- [Curve](src/curve/README.md)
+- [Digital Signature Algorithms](src/dsa/README.md)
+- [Encryption]()
+    - [Asymmetric]()
+        - [RSA](src/encryption/asymmetric/rsa/README.md)
+    - [Symmetric Encryption](src/encryption/symmetric/README.md)
+        - [AES](src/encryption/symmetric/aes/README.md)
+        - [ChaCha](src/encryption/symmetric/chacha/README.md)
+        - [DES](src/encryption/symmetric/des/README.md)
+        - [Modes](src/encryption/symmetric/modes/README.md)
+- [Hashes](src/hashes/README.md)
+    - [Poseidon](src/hashes/poseidon/README.md)
+- [HMAC](src/hmac/README.md)
+- [KZG](src/kzg/README.md)
+- [Merkle Trees](src/tree/README.md)