Wasm API to entropy-protocol uses camelCase function names (#566)

* Wasm API to entropy-protocol used camelCase function names

* Update CHANGELOG

* Update README

CHANGELOG.md

@@ -17,6 +17,7 @@ At the moment this project **does not** adhere to
 - In [#536](https://github.com/entropyxyz/entropy-core/pull/536/), the registered struct no longer holds a program but rather a hash of a program that is set in the set_program function
 - When executing the signing protocol on the client-side, a `sig-uid` no longer needs to be given as
   an argument ([#549](https://github.com/entropyxyz/entropy-core/pull/549))
+- Wasm API to entropy-protocol uses camelCase function names ([#566](https://github.com/entropyxyz/entropy-core/pull/566))
 
 ### Added
 - Test CLI which calls the same code as in integration tests ([#417](https://github.com/entropyxyz/entropy-core/pull/417))

crates/protocol/js-README.md

@@ -5,8 +5,8 @@ the Entropy signing and DKG protocols on the client side.
 
 Exposed to JS:
 
-- `run_dkg_protocol`
-- `run_signing_protocol`
+- `runDkgProtocol`
+- `runSigningProtocol`
 - `ValidatorInfo`
 - `KeyShare`
 
@@ -36,24 +36,24 @@ other details (IP address and x25519 public encryption key) by using
 the staking pallet's `threshold_servers` query with the account ID.
 
 We create an array of `ValidatorInfo` objects containing these details,
-and pass this to the `run_dkg_protocol` function, together with the
+and pass this to the `runDkgProtocol` function, together with the
 user's secret sr25519 signing key.
 
-`run_dkg_protocol` returns a promise which if successful will resolve to a
+`runDkgProtocol` returns a promise which if successful will resolve to a
 `KeyShare`. `KeyShare` has methods for serialization and de-serialization,
 to/from both JSON and binary (using [bincode](https://docs.rs/bincode)).
 
 ## Signing in private access mode
 
-The `run_signing_protocol` function also takes an array of `ValidatorInfo`
+The `runSigningProtocol` function also takes an array of `ValidatorInfo`
 objects.  These should be selected using the message hash, exactly the
 same as the those used in a `UserSignatureRequest`.
 
-`run_signing_protocol` needs to be run concurrently whilst
+`runSigningProtocol` needs to be run concurrently whilst
 making the `user/sign_tx` http requests, for example by using
-`Promise.all`. `run_signing_protocol` also takes the user's `KeyShare`
+`Promise.all`. `runSigningProtocol` also takes the user's `KeyShare`
 as an argument, as well as the message hash, and the user's private
 sr25519 signing key.
 
-`run_signing_protocol` returns a promise which if successful will resolve
+`runSigningProtocol` returns a promise which if successful will resolve
 to an ECDSA signature with recovery bit, encoded as a base64 string.

crates/protocol/nodejs-test/index.js

@@ -33,15 +33,15 @@ try {
 
 switch(process.argv[2].toLowerCase()) {
     case 'register':
-        protocol.run_dkg_protocol(input.validators_info, input.user_sig_req_secret_key).then((keyShare) => {
+        protocol.runDkgProtocol(input.validators_info, input.user_sig_req_secret_key).then((keyShare) => {
           console.log(keyShare.toString())
         }).catch((err) => {
           console.error('ERR', err)
         })
         break
     case 'sign':
         let keyShare = protocol.KeyShare.fromString(input.key_share)
-        protocol.run_signing_protocol(keyShare, input.message_hash, input.validators_info, input.user_sig_req_secret_key)
+        protocol.runSigningProtocol(keyShare, input.message_hash, input.validators_info, input.user_sig_req_secret_key)
             .then((output) => {
                 console.log(output)
             }).catch((err) => {

crates/protocol/src/user/wasm.rs

@@ -9,7 +9,7 @@ use super::{user_participates_in_dkg_protocol, user_participates_in_signing_prot
 use crate::KeyParams;
 
 /// Run the DKG protocol on the client side and return a keyshare
-#[cfg_attr(feature = "wasm", wasm_bindgen)]
+#[cfg_attr(feature = "wasm", wasm_bindgen(js_name = runDkgProtocol))]
 pub async fn run_dkg_protocol(
     validators_info_js: ValidatorInfoArray,
     user_signing_secret_key: Vec<u8>,
@@ -27,7 +27,7 @@ pub async fn run_dkg_protocol(
 
 /// Run the signing protocol on the client side
 /// Returns a recoverable signature as a base64 encoded string
-#[cfg_attr(feature = "wasm", wasm_bindgen)]
+#[cfg_attr(feature = "wasm", wasm_bindgen(js_name = runSigningProtocol))]
 pub async fn run_signing_protocol(
     key_share: KeyShare,
     message_hash: Vec<u8>,
@@ -62,7 +62,7 @@ extern "C" {
 /// Details of a validator intended for use on JS
 /// This differs from [crate::ValidatorInfo] only in that the fields must be private
 #[derive(TryFromJsValue)]
-#[wasm_bindgen]
+#[wasm_bindgen(inspectable)]
 #[derive(Clone)]
 pub struct ValidatorInfo {
     x25519_public_key: [u8; 32],
@@ -136,7 +136,7 @@ fn parse_validator_info(
 
 /// Synedrion key share wrapped for wasm
 #[derive(TryFromJsValue)]
-#[wasm_bindgen]
+#[wasm_bindgen(inspectable)]
 #[derive(Clone)]
 pub struct KeyShare(synedrion::KeyShare<KeyParams>);