Release v0.7.1

Author: mberry

.github/FUNDING.yml

@@ -0,0 +1,3 @@
+github: mberry
+ko_fi: mberry
+tidelift: cargo/pqc_kyber

CHANGELOG.md

@@ -1,4 +1,11 @@
-## 0.6.0 - 2023-4-18
+## 0.7.1 - 2023-8-23
+### Cosmetic
+ - Enforce cargo fmt
+ - Modify: Doc comments on functions for better DX
+ - Remove: Redundant comments
+ - Cleanup: function visibility
+
+## 0.7.0 - 2023-8-15
  - Handle RNG failure on embedded platforms
  - Deterministic keypair derivation
  - Public to private key conversion

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "pqc_kyber"
-version = "0.7.0"
+version = "0.7.1"
 authors = ["Mitchell Berry <[email protected]>"]
 edition = "2018"
 license = "MIT/Apache-2.0"

pkg/package.json

@@ -4,7 +4,7 @@
     "Mitchell Berry <[email protected]>"
   ],
   "description": "The post-quantum Kyber key exchange algorithm, written in rust and compiled to wasm",
-  "version": "0.7.0",
+  "version": "0.7.1",
   "license": "MIT/Apache-2.0",
   "repository": {
     "type": "git",

pkg/pqc_kyber_bg.js

@@ -505,6 +505,14 @@ export function __wbindgen_error_new(arg0, arg1) {
     return addHeapObject(ret);
 };
 
+export function __wbg_getRandomValues_37fa2ca9e4e07fab() { return handleError(function (arg0, arg1) {
+    getObject(arg0).getRandomValues(getObject(arg1));
+}, arguments) };
+
+export function __wbg_randomFillSync_dc1e9a60c158336d() { return handleError(function (arg0, arg1) {
+    getObject(arg0).randomFillSync(takeObject(arg1));
+}, arguments) };
+
 export function __wbg_crypto_c48a774b022d20ac(arg0) {
     const ret = getObject(arg0).crypto;
     return addHeapObject(ret);
@@ -556,14 +564,6 @@ export function __wbindgen_string_new(arg0, arg1) {
     return addHeapObject(ret);
 };
 
-export function __wbg_getRandomValues_37fa2ca9e4e07fab() { return handleError(function (arg0, arg1) {
-    getObject(arg0).getRandomValues(getObject(arg1));
-}, arguments) };
-
-export function __wbg_randomFillSync_dc1e9a60c158336d() { return handleError(function (arg0, arg1) {
-    getObject(arg0).randomFillSync(takeObject(arg1));
-}, arguments) };
-
 export function __wbg_newnoargs_2b8b6bd7753c76ba(arg0, arg1) {
     const ret = new Function(getStringFromWasm0(arg0, arg1));
     return addHeapObject(ret);

pkg/pqc_kyber_bg.wasm

@@ -136,7 +136,7 @@ If no security level is specified then kyber768 is used by default as recommende
 
 ```toml
 [dependencies]
-pqc_kyber = {version = "0.7.0", features = ["kyber512", "90s", "avx2"]}
+pqc_kyber = {version = "0.7.1", features = ["kyber512", "90s", "avx2"]}
 ```
 
 

readme.md

@@ -6,17 +6,20 @@
 
 3. Run tests and address sanitiser checks:
  ```bash
- export RUSTFLAGS="${RUSTFLAGS:-} -Z sanitizer=address -C target-cpu=native -C target-feature=+aes,+avx2,+sse2,+sse4.1,+bmi2,+popcnt";\
+ export RUSTFLAGS="${RUSTFLAGS:-} -Z sanitizer=address -C target-cpu=native -C target-feature=+aes,+avx2,+sse2,+sse4.1,+bmi2,+popcnt";
  export RUSTDOCFLAGS="-Z sanitizer=address";
  rustup default nightly;
  KAT=1 AVX2=1 NASM=1 ./tests/run_all_tests.sh;
+ unset RUSTFLAGS;
+ unset RUSTDOCFLAGS;
+ rustup default stable;
 ``` 
 
 4. Bump version in **Cargo.toml** and the features section of **readme.md**
 
 5. Update **changelog.md**
 
-6. `cargo +nightly fmt`
+6. `cargo fmt`
 
 7. `wasm-pack build -- --features wasm`
 
@@ -26,7 +29,7 @@
 
 9. `git commit -a -m "release v0.0.0"`
 
-10. `git tag v0.0.0`
+10. `git tag v0.0.0 -m "Version release"`
 
 11. `git push origin v0.0.0`