Skip to content

Commit

Permalink
Merge pull request #44 from LFDT-Lockness/discord
Browse files Browse the repository at this point in the history
Update links, add info about discord
  • Loading branch information
survived authored Sep 25, 2024
2 parents e65fa13 + 1a863c6 commit f5a1e7d
Show file tree
Hide file tree
Showing 11 changed files with 71 additions and 31 deletions.
14 changes: 11 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,14 @@

Thanks for taking interest to contributing to our project!

## Join us in Discord!
We welcome all contributors to communicate with us [in Discord]! Please, reach out to us
in `#lockness-contribute` room.

## Pull Requests
Prior to making a PR, we ask you to communicate it with us, preferably by opening an issue.
This would help to keep your work aligned with the maintainers view and get insights from
them.
Prior to making a PR, we ask you to communicate it with us, either [in Discord] or, if you
prefer, by opening an issue in the repo. This would help to keep your work aligned with the
maintainers view and avoid situations in which we can't accept your contribution.

All commits are required to be signed via verified GPG key. You can read about commit signing
in [this series of articles](https://docs.github.com/en/authentication/managing-commit-signature-verification)
Expand Down Expand Up @@ -62,3 +66,7 @@ communicate with us for other reasons.
However, if you want to report something that you believe might be a security
vulnerability or a security flaw in this or any upstream project, please report
it following the procedure described in [SECURITY.md](./SECURITY.md).

Feel free to reach out to us [in Discord] as well.

[in Discord]: https://discordapp.com/channels/905194001349627914/1285268686147424388
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
![License](https://img.shields.io/crates/l/generic-ec.svg)
[![Docs](https://docs.rs/generic-ec/badge.svg)](https://docs.rs/generic-ec)
[![Crates io](https://img.shields.io/crates/v/generic-ec.svg)](https://crates.io/crates/generic-ec)
[![Discord](https://img.shields.io/discord/905194001349627914?logo=discord&logoColor=ffffff&label=Discord)][in Discord]

# General elliptic curve cryptography

Expand Down Expand Up @@ -77,7 +78,7 @@ Crate provides support for following elliptic curves out of box:

[RustCrypto/k256]: https://github.com/RustCrypto/elliptic-curves/tree/master/k256
[RustCrypto/p256]: https://github.com/RustCrypto/elliptic-curves/tree/master/p256
[Dfns/stark]: https://github.com/dfns/stark-curve/
[Dfns/stark]: https://github.com/LFDT-Lockness/stark-curve/
[curve25519-dalek]: https://docs.rs/curve25519-dalek/

In order to use one of the supported curves, you need to turn on corresponding feature. E.g. if you want
Expand Down Expand Up @@ -167,6 +168,11 @@ let _ = some_generic_computation(&mut rng, point2);
[examples]: #examples
[supported curves]: #supported-curves

## Join us in Discord!
Feel free to reach out to us [in Discord]!

[in Discord]: https://discordapp.com/channels/905194001349627914/1285268686147424388

## License

The crate is licensed under MIT or Apache-2.0 at your choice.
Expand Down
9 changes: 7 additions & 2 deletions generic-ec-core/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,19 @@
## v0.2.1
* Update links, add info about our discord [#44]

[#44]: https://github.com/LFDT-Lockness/generic-ec/pull/44

## v0.2.0
* Change `IntegerEncoding` trait [#34]
* Add `Reduce` trait [#34]
* Remove hash to curve API [#34]

[#34]: https://github.com/dfns/generic-ec/pull/34
[#34]: https://github.com/LFDT-Lockness/generic-ec/pull/34

## v0.1.4
* Add `Additive::double` [#29]

[#29]: https://github.com/dfns/generic-ec/pull/29
[#29]: https://github.com/LFDT-Lockness/generic-ec/pull/29

## v0.1.3

Expand Down
4 changes: 2 additions & 2 deletions generic-ec-core/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
[package]
name = "generic-ec-core"
version = "0.2.0"
version = "0.2.1"
edition = "2021"
license = "MIT OR Apache-2.0"
repository = "https://github.com/dfns/generic-ec"
repository = "https://github.com/LFDT-Lockness/generic-ec"
description = "Core traits of `generic-ec` crate"

# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
Expand Down
11 changes: 8 additions & 3 deletions generic-ec-curves/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,22 @@
## v0.2.2
* Update links, add info about our discord [#44]

[#44]: https://github.com/LFDT-Lockness/generic-ec/pull/44

## v0.2.1
* Fix using wrong feature in conditional compilation that could cause compilation error [#36]

[#36]: https://github.com/dfns/generic-ec/pull/36
[#36]: https://github.com/LFDT-Lockness/generic-ec/pull/36

## v0.2.0
* Optimize `Scalar::from_{be|le}_bytes_mod_order` [#34]

[#34]: https://github.com/dfns/generic-ec/pull/34
[#34]: https://github.com/LFDT-Lockness/generic-ec/pull/34

## v0.1.5
* Provide `Additive::double` implementation for secp256k1, secp256r1, and stark curves [#29]

[#29]: https://github.com/dfns/generic-ec/pull/29
[#29]: https://github.com/LFDT-Lockness/generic-ec/pull/29

## v0.1.4

Expand Down
4 changes: 2 additions & 2 deletions generic-ec-curves/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
[package]
name = "generic-ec-curves"
version = "0.2.1"
version = "0.2.2"
edition = "2021"
license = "MIT OR Apache-2.0"
description = "Elliptic curves for `generic-ec` crate"
repository = "https://github.com/dfns/generic-ec"
repository = "https://github.com/LFDT-Lockness/generic-ec"

# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

Expand Down
13 changes: 9 additions & 4 deletions generic-ec-zkp/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,25 @@
## v0.4.2
* Update links, add info about our discord [#44]

[#44]: https://github.com/LFDT-Lockness/generic-ec/pull/44

## v0.4.1
* Fix `no_std` support [#43]

[#43]: https://github.com/dfns/generic-ec/pull/43
[#43]: https://github.com/LFDT-Lockness/generic-ec/pull/43

## v0.4.0
* Update `generic-ec` dep to v0.4 [#40]
* Update `udigest` dep to v0.2 [#40]

[#40]: https://github.com/dfns/generic-ec/pull/40
[#40]: https://github.com/LFDT-Lockness/generic-ec/pull/40

## v0.3.0
* Bump `generic-ec` to v0.3 [#30]
* Allow `generic_ec_zkp::polynomial::lagrange_coefficient` to accept zero scalars [#35]

[#30]: https://github.com/dfns/generic-ec/pull/30
[#35]: https://github.com/dfns/generic-ec/pull/35
[#30]: https://github.com/LFDT-Lockness/generic-ec/pull/30
[#35]: https://github.com/LFDT-Lockness/generic-ec/pull/35

## v0.2.0
All changes prior to this version weren't documented
4 changes: 2 additions & 2 deletions generic-ec-zkp/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
[package]
name = "generic-ec-zkp"
version = "0.4.1"
version = "0.4.2"
edition = "2021"
license = "MIT OR Apache-2.0"
repository = "https://github.com/dfns/generic-ec"
repository = "https://github.com/LFDT-Lockness/generic-ec"
description = "ZK-proofs and primitives built on top of `generic-ec` crate"

categories = ["cryptography", "no-std", "no-std::no-alloc"]
Expand Down
23 changes: 14 additions & 9 deletions generic-ec/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,18 @@
## v0.4.2
* Update links, add info about our discord [#44]

[#44]: https://github.com/LFDT-Lockness/generic-ec/pull/44

## v0.4.1
* Fix `no_std` support [#43]

[#43]: https://github.com/dfns/generic-ec/pull/43
[#43]: https://github.com/LFDT-Lockness/generic-ec/pull/43

## v0.4.0
* Update `udigest` to v0.2 [#40]
* Add hash to scalar primitive [#40]

[#40]: https://github.com/dfns/generic-ec/pull/40
[#40]: https://github.com/LFDT-Lockness/generic-ec/pull/40

## v0.3.0
* Rework `generic_ec::multiscalar` API, optimize Straus algorithm, add Dalek, remove
Expand All @@ -16,31 +21,31 @@
* Remove `hash_to_curve` primitive from library API [#34]
* Add `Scalar::is_zero` method [#35]

[#30]: https://github.com/dfns/generic-ec/pull/30
[#34]: https://github.com/dfns/generic-ec/pull/34
[#35]: https://github.com/dfns/generic-ec/pull/35
[#30]: https://github.com/LFDT-Lockness/generic-ec/pull/30
[#34]: https://github.com/LFDT-Lockness/generic-ec/pull/34
[#35]: https://github.com/LFDT-Lockness/generic-ec/pull/35

## v0.2.4
* Add `generic_ec::multiscalar` which helps optimizing multiscalar multiplication [#29]

[#29]: https://github.com/dfns/generic-ec/pull/29
[#29]: https://github.com/LFDT-Lockness/generic-ec/pull/29

## v0.2.3
* Add `generic_ec::serde::PreferCompact` that serializes points/scalars in compact form,
but deserialization recognizes both compact and non-compact formats [#28]

[#28]: https://github.com/dfns/generic-ec/pull/28
[#28]: https://github.com/LFDT-Lockness/generic-ec/pull/28

## v0.2.2
* Implement `serde_with::SerializeAs<&T>` for `generic_ec::serde::Compact` when `T` is
serializable via `Compact` [#27]

[#27]: https://github.com/dfns/generic-ec/pull/27
[#27]: https://github.com/LFDT-Lockness/generic-ec/pull/27

## v0.2.1
* Make `generic_ec::serde` module always available even when `serde` feature is disabled [#25]

[#25]: https://github.com/dfns/generic-ec/pull/25
[#25]: https://github.com/LFDT-Lockness/generic-ec/pull/25

## v0.2.0

Expand Down
4 changes: 2 additions & 2 deletions generic-ec/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
[package]
name = "generic-ec"
version = "0.4.1"
version = "0.4.2"
edition = "2021"
license = "MIT OR Apache-2.0"
repository = "https://github.com/dfns/generic-ec"
repository = "https://github.com/LFDT-Lockness/generic-ec"
description = "General elliptic curve cryptography"
readme = "../README.md"

Expand Down
8 changes: 7 additions & 1 deletion generic-ec/src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
//! ![License](https://img.shields.io/crates/l/generic-ec.svg)
//! [![Docs](https://docs.rs/generic-ec/badge.svg)](https://docs.rs/generic-ec)
//! [![Crates io](https://img.shields.io/crates/v/generic-ec.svg)](https://crates.io/crates/generic-ec)
//! [![Discord](https://img.shields.io/discord/905194001349627914?logo=discord&logoColor=ffffff&label=Discord)][in Discord]
//!
//! # General elliptic curve cryptography
//!
Expand Down Expand Up @@ -75,7 +76,7 @@
//!
//! [RustCrypto/k256]: https://github.com/RustCrypto/elliptic-curves/tree/master/k256
//! [RustCrypto/p256]: https://github.com/RustCrypto/elliptic-curves/tree/master/p256
//! [Dfns/stark]: https://github.com/dfns/stark-curve/
//! [Dfns/stark]: https://github.com/LFDT-Lockness/stark-curve/
//! [curve25519-dalek]: https://docs.rs/curve25519-dalek/
//!
//! In order to use one of the supported curves, you need to turn on corresponding feature. E.g. if you want
Expand Down Expand Up @@ -170,6 +171,11 @@
//! [examples]: #examples
//! [supported curves]: #supported-curves
//!
//! ## Join us in Discord!
//! Feel free to reach out to us [in Discord]!
//!
//! [in Discord]: https://discordapp.com/channels/905194001349627914/1285268686147424388
//!
//! ## License
//!
//! The crate is licensed under MIT or Apache-2.0 at your choice.
Expand Down

0 comments on commit f5a1e7d

Please sign in to comment.