Release/v0.1.0

.github/workflows/rust.yml

@@ -0,0 +1,71 @@
+name: CI
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "*" ]
+
+env:
+  CARGO_TERM_COLOR: always
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    env:
+      CODE_COV_VAL: '0'
+
+    steps:
+    - name: Clone main repository
+      uses: actions/checkout@v4
+
+    - uses: moonrepo/setup-rust@v1
+      with:
+        components: rustfmt
+        cache: false
+      name: Setup Rust Toolchain
+
+    - uses: Swatinem/rust-cache@v2
+      name: Cache Rust Dependencies
+
+    - run: export RUSTFLAGS="-D warnings" && cargo build
+      name: Run build scripts
+
+    - name: Check Format
+      run: cargo fmt --check
+      working-directory: .
+
+    - name: Run Clippy
+      run: rustup component add clippy && cargo clippy
+      working-directory: .
+
+    - name: Install dependencies
+      run: sudo apt-get install -y musl-tools
+
+    - name: Install tarpaulin
+      run: cargo install cargo-tarpaulin
+
+    - name: Run tests with coverage
+      run: |
+        cargo tarpaulin --lib --out Html --output-dir target/debug/tarpaulin/ -- --nocapture > test.log
+        LAST_LINE=$( tail -n 1 test.log)
+        CODE_COV=$(echo "$LAST_LINE" | cut -d '%' -f 1)
+        echo "CODE_COV: $CODE_COV"
+        COLOR=$(
+          float=$(echo "$CODE_COV" | bc)
+          threshold=80.0
+          if (( $(echo "$float > $threshold" | bc -l) )); then
+              echo "brightgreen"
+          else
+              echo "yellow"
+          fi
+        )
+        echo "COLOR: $COLOR"
+        sh ./scripts/gen_svg.sh $COLOR $CODE_COV
+
+    - name: Deploy to GitHub Pages
+      uses: peaceiris/actions-gh-pages@v4
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        publish_dir: ./target/debug/tarpaulin/
+        publish_branch: gh-pages

.gitignore

@@ -0,0 +1,12 @@
+/target
+.vscode/
+target/
+logs/
+plonky2/
+config/local.toml
+config/prod.toml
+test-data/user-data*/
+test-data/proofs*/
+my_permanent_leveldb/
+*level_db*/
+*.json

CHANGELOG.md

@@ -0,0 +1,50 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [0.1.0] - 2024-08-23
+
+### 🚀 Features
+
+- Add general-recursive-n proofs ([#74](https://github.com/okx/proof-of-reserves-v2/pull/74))
+- Add-merkle-sum-tree-circuit-with-tests ([#14](https://github.com/okx/proof-of-reserves-v2/pull/14))
+- Add tracing ([#9](https://github.com/okx/proof-of-reserves-v2/pull/9))
+- Add leveldb ([#20](https://github.com/okx/proof-of-reserves-v2/pull/20))
+- Add-scheme-for-userid-hashing ([#14](https://github.com/okx/proof-of-reserves-v2/pull/14))
+- Add global mst ([#35](https://github.com/okx/proof-of-reserves-v2/issues/35))
+- Add-merkle-proof-logic ([#41](https://github.com/okx/proof-of-reserves-v2/pull/41))
+- Add-merkle-verification-logic ([#63](https://github.com/okx/proof-of-reserves-v2/pull/63))
+- Add-merkle-proof-sdk ([#63](https://github.com/okx/proof-of-reserves-v2/pull/63))
+- Add-account-to-merkle-proof ([#63](https://github.com/okx/proof-of-reserves-v2/pull/63))
+
+### 🐛 Bug Fixes
+
+- Merkle-proof-non-power-of-2-recursive
+- Fix-mst-proof-bug
+
+### 🚜 Refactor
+
+- Remove-proving-circuits
+- Refactor-and-wrap-recursive-in-prover
+- Add-root-as-input
+
+### 📚 Documentation
+
+- Add readme description
+
+### 🧪 Testing
+
+- Add-tests-for-merkle-proof ([#41](https://github.com/okx/proof-of-reserves-v2/pull/41))
+- Test-get-index
+
+### ⚙️ Miscellaneous Tasks
+
+- Add code coverage ([#24](https://github.com/okx/proof-of-reserves-v2/pull/24))
+- Refactor-recursive-wrap-in-prover
+- Refactor-into-prover
+
+### Bugfix
+
+- File reader reads zero account
+
+<!-- generated by git-cliff -->