Wasm wrapper

Cargo.toml

@@ -1,7 +1,7 @@
 [workspace]
 resolver = "2"
 
-members = ["rust-arkworks", "rust-k256"]
+members = ["rust-arkworks", "rust-k256", "javascript"]
 
 [patch.crates-io]
 ark-ec = { git = "https://github.com/FindoraNetwork/ark-algebra" }

javascript/.appveyor.yml

@@ -0,0 +1,11 @@
+install:
+  - appveyor-retry appveyor DownloadFile https://win.rustup.rs/ -FileName rustup-init.exe
+  - if not defined RUSTFLAGS rustup-init.exe -y --default-host x86_64-pc-windows-msvc --default-toolchain nightly
+  - set PATH=%PATH%;C:\Users\appveyor\.cargo\bin
+  - rustc -V
+  - cargo -V
+
+build: false
+
+test_script:
+  - cargo test --locked

javascript/.github/dependabot.yml

@@ -0,0 +1,8 @@
+version: 2
+updates:
+- package-ecosystem: cargo
+  directory: "/"
+  schedule:
+    interval: daily
+    time: "08:00"
+  open-pull-requests-limit: 10

javascript/.gitignore

@@ -1,9 +1,6 @@
-# Swap the comments on the following lines if you don't wish to use zero-installs
-# Documentation here: https://yarnpkg.com/features/zero-installs
-# !.yarn/cache
-.pnp.*
-
-# node.js
-/node_modules
-/dist
-
+/target
+**/*.rs.bk
+Cargo.lock
+bin/
+pkg/
+wasm-pack.log

javascript/.travis.yml

@@ -0,0 +1,69 @@
+language: rust
+sudo: false
+
+cache: cargo
+
+matrix:
+  include:
+
+  # Builds with wasm-pack.
+  - rust: beta
+    env: RUST_BACKTRACE=1
+    addons:
+      firefox: latest
+      chrome: stable
+    before_script:
+      - (test -x $HOME/.cargo/bin/cargo-install-update || cargo install cargo-update)
+      - (test -x $HOME/.cargo/bin/cargo-generate || cargo install --vers "^0.2" cargo-generate)
+      - cargo install-update -a
+      - curl https://rustwasm.github.io/wasm-pack/installer/init.sh -sSf | sh -s -- -f
+    script:
+      - cargo generate --git . --name testing
+      # Having a broken Cargo.toml (in that it has curlies in fields) anywhere
+      # in any of our parent dirs is problematic.
+      - mv Cargo.toml Cargo.toml.tmpl
+      - cd testing
+      - wasm-pack build
+      - wasm-pack test --chrome --firefox --headless
+
+  # Builds on nightly.
+  - rust: nightly
+    env: RUST_BACKTRACE=1
+    before_script:
+      - (test -x $HOME/.cargo/bin/cargo-install-update || cargo install cargo-update)
+      - (test -x $HOME/.cargo/bin/cargo-generate || cargo install --vers "^0.2" cargo-generate)
+      - cargo install-update -a
+      - rustup target add wasm32-unknown-unknown
+    script:
+      - cargo generate --git . --name testing
+      - mv Cargo.toml Cargo.toml.tmpl
+      - cd testing
+      - cargo check
+      - cargo check --target wasm32-unknown-unknown
+      - cargo check                                 --no-default-features
+      - cargo check --target wasm32-unknown-unknown --no-default-features
+      - cargo check                                 --no-default-features --features console_error_panic_hook
+      - cargo check --target wasm32-unknown-unknown --no-default-features --features console_error_panic_hook
+      - cargo check                                 --no-default-features --features "console_error_panic_hook wee_alloc"
+      - cargo check --target wasm32-unknown-unknown --no-default-features --features "console_error_panic_hook wee_alloc"
+
+  # Builds on beta.
+  - rust: beta
+    env: RUST_BACKTRACE=1
+    before_script:
+      - (test -x $HOME/.cargo/bin/cargo-install-update || cargo install cargo-update)
+      - (test -x $HOME/.cargo/bin/cargo-generate || cargo install --vers "^0.2" cargo-generate)
+      - cargo install-update -a
+      - rustup target add wasm32-unknown-unknown
+    script:
+      - cargo generate --git . --name testing
+      - mv Cargo.toml Cargo.toml.tmpl
+      - cd testing
+      - cargo check
+      - cargo check --target wasm32-unknown-unknown
+      - cargo check                                 --no-default-features
+      - cargo check --target wasm32-unknown-unknown --no-default-features
+      - cargo check                                 --no-default-features --features console_error_panic_hook
+      - cargo check --target wasm32-unknown-unknown --no-default-features --features console_error_panic_hook
+      # Note: no enabling the `wee_alloc` feature here because it requires
+      # nightly for now.

javascript/Cargo.toml

@@ -0,0 +1,35 @@
+[package]
+name = "plume-sig"
+version = "3.0.0-rc.1"
+authors = ["skaunov"]
+edition = "2018"
+keywords = ["nullifier", "zero-knowledge", "ECDSA", "PLUME"]
+repository = "https://github.com/plume-sig/zk-nullifier-sig/"
+description = "wrapper around `plume_rustcrypto` crate to produce PLUME signatures in JS contexts using Wasm"
+license = "MIT"
+
+[lib]
+crate-type = ["cdylib", "rlib"]
+
+[features]
+# I'd alias this to `sec1` if that won't be tricky
+verify = ["dep:sec1"]
+
+[dependencies]
+wasm-bindgen = "~0.2.84"
+js-sys = "0.3"
+
+plume_rustcrypto = {version = "~0.2.1", default-features = false} 
+sec1 = {version = "~0.7.3", optional = true} # match with `k256`
+elliptic-curve = {version = "~0.13.8"}
+zeroize = "1.8"
+signature = "^2.2.0"
+getrandom = { version = "0.2", features = ["js"] }
+anyhow = "1"
+
+[dev-dependencies]
+wasm-bindgen-test = "~0.3.34"
+
+[profile.release] # This comes from template; didn't touch this yet - docs doesn't tell much about it.
+# Tell `rustc` to optimize for small code size.
+# opt-level = "s"

javascript/README.md

@@ -0,0 +1,90 @@
+This is wrapper around `plume_rustcrypto` crate to produce PLUME signatures in JS contexts using Wasm.
+
+TODO add here couple of examples from systems which uses this.
+
+# Getting Started
+
+Get the package from NPM. The repository contains Rust code for generating Wasm and packaging it.
+
+The package usage outline; see the details in subsections.
+```js
+// ...
+let result = plume.sign(isV1, secretKeySec1Der, msg);
+console.log(result.nullifier);
+result.zeroizePrivateParts();
+```
+
+Please, refer to the JS-doc for types description, function signatures, and exceptions notes.
+
+Values in the following examples are in line with tests in the wrapped crate.
+## producing the signature
+```js
+import * as plume from 'plume-sig';
+
+let result = plume.sign(
+  false, 
+  new Uint8Array([48, 107, 2, 1, 1, 4, 32, 81, 155, 66, 61, 113, 95, 139, 88, 31, 79, 168, 238, 89, 244, 119, 26, 91, 68, 200, 19, 11, 78, 62, 172, 202, 84, 165, 109, 218, 114, 180, 100, 161, 68, 3, 66, 0, 4, 12, 236, 2, 142, 224, 141, 9, 224, 38, 114, 166, 131, 16, 129, 67, 84, 249, 234, 191, 255, 13, 230, 218, 204, 28, 211, 167, 116, 73, 96, 118, 174, 239, 244, 113, 251, 160, 64, 152, 151, 182, 164, 142, 136, 1, 173, 18, 249, 93, 0, 9, 183, 83, 207, 143, 81, 193, 40, 191, 107, 11, 210, 127, 189]),
+  new Uint8Array([
+    65, 110, 32, 101, 120, 97, 109, 112, 108, 101, 32, 97, 112, 112, 32, 109, 101, 115, 115, 97, 103, 101, 32, 115, 116, 114, 105, 110, 103
+  ])
+);
+```
+## getters
+`PlumeSignature` provide getters for each property of it, so you have access to any of them upon signing.
+```js
+// ...
+console.log(result.nullifier);
+/* Uint8Array(33) [
+    3,  87, 188,  62, 210, 129, 114, 239,
+  138, 221, 228, 185, 224, 194, 204, 231,
+   69, 252, 197, 166, 100, 115, 164,  92,
+   30,  98, 111,  29,  12, 103, 229,  88,
+   48
+] */
+console.log(result.s);
+/* Uint8Array(109) [
+   48, 107,   2,   1,   1,   4,  32,  73,  27, 195, 183, 106,
+  202, 136, 167,  50, 193, 119, 152, 153, 233,  56, 176,  58,
+  221, 183,   4, 126, 189,  69, 201, 173, 102,  98, 248,  36,
+  112, 183, 176, 161,  68,   3,  66,   0,   4,  13,  18, 115,
+  220, 215, 120, 156,  20, 128, 225, 106,  29, 255,  16, 218,
+    5,  19, 179,  80, 204,  25, 144,  61, 150, 121,  83,  76,
+  174,  21, 232,  58, 153,  97, 227, 239,  78, 114, 199,  53,
+  138,  93, 108, 150,  98, 141,  89, 159, 219, 243, 182, 188,
+   22, 224, 154, 171,
+  ... 9 more items
+] */
+console.log(result.c);
+console.log(result.pk);
+console.log(result.message);
+console.log(result.v1specific);
+// undefined
+```
+Note that variant is specified by `v1specific`; if it's `undefined` then the object contains V2, otherwise it's V1.
+```js
+// ...
+if (result.v1specific) {
+  console.log(result.v1specific.r_point);
+  console.log(result.v1specific.hashed_to_curve_r);
+}
+```
+Also there's #convertion utility provided.
+## zeroization
+Depending on your context you might want to clear values of the result from Wasm memory after getting the values.
+```js
+// ...
+result.zeroizePrivateParts();
+result.zeroizeAll();
+```
+
+# #convertion of `s` to `BigInt`
+JS most native format for scalar is `BigInt`, but it's not really transportable or secure, so for uniformity of approach `s` in `PlumeSignature` is defined similar to `c`; but if you want to have it as a `BigInt` there's `sec1DerScalarToBigint` helper funtion.
+
+# Working with source files
+
+This package is built with the tech provided by <https://github.com/rustwasm> which contains everything needed to work with it. Also the wrapper crate was initiated with `wasm-pack-template`.
+
+Note that the wrapper crate has `verify` feature which can check the resulting signature.
+
+# License
+See <https://github.com/plume-sig/zk-nullifier-sig/blob/main/LICENSE>.