Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
Implement SAFE for field elements:
- Add `Safe` trait
- Add `Sponge` struct
- Add `Error` enum
- Add README
- Add Changelog
- Add documentation
- Add license
  • Loading branch information
moCello committed Mar 6, 2024
1 parent e5a0404 commit c6089cf
Show file tree
Hide file tree
Showing 12 changed files with 1,356 additions and 0 deletions.
23 changes: 23 additions & 0 deletions .github/workflows/dusk_ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
on:
pull_request:
push:
branches:
- main

name: Continuous integration

jobs:
code_analysis:
name: Code Analysis
uses: dusk-network/.github/.github/workflows/code-analysis.yml@main
with:
clippy_default: false
clippy_args: -- -D warnings

dusk_analyzer:
name: Dusk Analyzer
uses: dusk-network/.github/.github/workflows/dusk-analysis.yml@main

test_nightly:
name: Run tests
uses: dusk-network/.github/.github/workflows/run-tests.yml@main
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
/target
**/*.rs.bk
Cargo.lock
25 changes: 25 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]

### Added

- Add initial implementation of the SAFE framework [#3]
- Add `Safe` trait
- Add `Sponge` struct
- Add `Error` enum
- Add README
- Add Changelog
- Add documentation

<!-- ISSUES -->
[#3]: https://github.com/dusk-network/safe/issues/3

<!-- VERSIONS -->
[Unreleased]: https://github.com/dusk-network/poseidon252/compare/v0.1.0...HEAD
[0.1.0]: https://github.com/dusk-network/poseidon252/releases/tag/v0.1.0
18 changes: 18 additions & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
[package]
name = "dusk-safe"
version = "0.1.0"
description = "Sponge API for Field Elements"
categories = ["algorithms", "cryptography", "no-std"]
keywords = ["cryptography", "zero-knowledge", "crypto"]

repository = "https://github.com/dusk-network/safe"
edition = "2021"
license = "MPL-2.0"

[dependencies]
zeroize = "1"

[dev-dependencies]
dusk-bls12_381 = { version = "0.13", default-features = false }
ff = { version = "0.13", default-features = false }
rand = { version = "0.8", default-features = false, features = ["getrandom", "std_rng"] }
Loading

0 comments on commit c6089cf

Please # to comment.