Revamp wasm build & example

.cspell.jsonc

@@ -0,0 +1,21 @@
+{
+  // Version of the setting file.  Always 0.2
+  "version": "0.2",
+  // language - current active spelling language
+  "language": "en",
+  // words - list of words to be always considered correct
+  "words": ["bindgen", "ecies", "eciesrs", "keypair"],
+  // flagWords - list of words to be always considered incorrect
+  // This is useful for offensive words and common spelling errors.
+  // For example "hte" should be "the"
+  "flagWords": ["hte"],
+  "ignorePaths": [
+    ".git",
+    ".github",
+    ".gitignore",
+    ".cspell.jsonc",
+    "LICENSE",
+    "package.json",
+    "yarn.lock"
+  ]
+}

.github/dependabot.yml

@@ -3,5 +3,5 @@ updates:
 - package-ecosystem: cargo
   directory: "/"
   schedule:
-    interval: daily
+    interval: monthly
   open-pull-requests-limit: 10

.github/workflows/cd.yml

@@ -11,10 +11,10 @@ jobs:
   publish:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v1
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
         with:
-          node-version: 16
+          node-version: 20
           registry-url: "https://registry.npmjs.org"
       - uses: actions-rs/toolchain@v1
         with:
@@ -24,7 +24,7 @@ jobs:
       - uses: actions-rs/cargo@v1
         with:
           command: generate-lockfile
-      - uses: actions/cache@v2
+      - uses: actions/cache@v3
         with:
           path: |
             ~/.cargo/registry
@@ -34,10 +34,10 @@ jobs:
           key: ${{ runner.os }}-${{ hashFiles('**/Cargo.lock') }}
 
       - name: Install wasm pack
-        run: cargo install --git https://github.com/rustwasm/wasm-pack.git || true
+        run: cargo install wasm-pack || true
 
       - name: Build
-        run: wasm-pack build
+        run: wasm-pack build --target web
 
       - name: Publish
         run: cd pkg && npm publish

.github/workflows/ci.yml

@@ -14,10 +14,10 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v1
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
         with:
-          node-version: 16
+          node-version: 20
       - uses: actions-rs/toolchain@v1
         with:
           toolchain: stable
@@ -26,7 +26,7 @@ jobs:
       - uses: actions-rs/cargo@v1
         with:
           command: generate-lockfile
-      - uses: actions/cache@v2
+      - uses: actions/cache@v3
         with:
           path: |
             ~/.cargo/registry
@@ -35,11 +35,11 @@ jobs:
             target
           key: ${{ runner.os }}-${{ hashFiles('**/Cargo.lock') }}
 
-      - name: Install wasm pack # To fix bug: https://github.com/rustwasm/wasm-pack/issues/837
-        run: cargo install --git https://github.com/rustwasm/wasm-pack.git || true
+      - name: Install wasm pack
+        run: cargo install wasm-pack || true
 
       - name: Build
-        run: wasm-pack build
+        run: wasm-pack build --target web
 
       - name: Run tests
         run: wasm-pack test --node

.gitignore

@@ -9,3 +9,10 @@ Cargo.lock
 
 # These are backup files generated by rustfmt
 **/*.rs.bk
+
+
+.DS_Store
+
+# js stuff
+node_modules/
+dist/

.vscode/settings.json

@@ -1,11 +1,3 @@
 {
-  "spellright.language": ["en"],
-  "spellright.documentTypes": ["markdown", "latex", "plaintext", "toml"],
-  "rust-analyzer.cargo.target": "wasm32-unknown-unknown",
-  "spellright.ignoreFiles": [
-    "~/.cargo/",
-    "~/.rustup/",
-    "**/.gitignore",
-    "**/.spellignore"
-  ]
+  "rust-analyzer.cargo.target": "wasm32-unknown-unknown"
 }

CHANGELOG.md

@@ -0,0 +1,21 @@
+# Changelog
+
+## 0.2.0
+
+- Reduce wasm size from 1.2MB to ~100KB by revamping the build process
+- Rename `generate_keypair` to `generateKeypair` to follow JavaScript convention
+- Revamp wasm example to use vite instead of webpack
+- Revamp wasm build package to build web target
+- Bump dependencies
+
+## 0.1.2
+- Bump dependencies
+
+## 0.1.1
+
+- Expose `generate_keypair`
+- Revamp doc
+
+## 0.1.0
+
+- First beta release

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "ecies-wasm"
-version = "0.1.2"
+version = "0.2.0"
 # docs
 authors = ["Weiliang Li <to.be.impressive@gmail.com>"]
 description = "A WASM binding for eciesrs"
@@ -21,17 +21,22 @@ homepage = "https://ecies.org/rs-wasm/"
 repository = "https://github.com/ecies/rs-wasm"
 
 [dependencies]
-ecies = {version = "0.2.2", default-features = false, features = ["pure"]}
+ecies = {version = "0.2", default-features = false, features = ["pure"]}
+once_cell = {version = "1.18.0", default-features = false, features = ["std"]}
+
+# specify "lazy-static-context" to reduce wasm size
+libsecp256k1 = {version = "0.7.1", default-features = false, features = ["lazy-static-context"]}
 
 # wasm
-js-sys = "0.3.55"
-wasm-bindgen = "0.2.78"
+js-sys = "0.3.64"
+wasm-bindgen = "0.2.87"
 
 [dev-dependencies]
-wasm-bindgen-test = "0.3.28"
+wasm-bindgen-test = "0.3.37"
 
 [lib]
 crate-type = ["cdylib", "rlib"]
 
 [profile.release]
 lto = true
+opt-level = "z"

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020-2021 Weiliang Li
+Copyright (c) 2020-2023 Weiliang Li
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -2,7 +2,7 @@
 
 [![License](https://img.shields.io/github/license/ecies/rs-wasm.svg)](https://github.com/ecies/rs-wasm)
 [![NPM Package](https://img.shields.io/npm/v/ecies-wasm.svg)](https://www.npmjs.com/package/ecies-wasm)
-[![CI](https://img.shields.io/github/workflow/status/ecies/rs-wasm/Build%20wasm)](https://github.com/ecies/rs-wasm/actions)
+[![CI](https://img.shields.io/github/actions/workflow/status/ecies/rs-wasm/ci.yml)](https://github.com/ecies/rs-wasm/actions)
 
 A WASM binding for [eciesrs](https://github.com/ecies/rs).
 
@@ -15,23 +15,26 @@ npm install ecies-wasm
 ## Usage
 
 ```js
-import * as ecies from "ecies-wasm";
+import init, * as ecies from "ecies-wasm";
+
+init(); // if built with vite without plugin
 
-const [sk, pk] = ecies.generate_keypair();
 const data = Uint8Array.from([1, 2, 3, 4]);
 
+const [sk, pk] = ecies.generateKeypair();
 const encrypted = ecies.encrypt(pk, data);
 const decrypted = ecies.decrypt(sk, encrypted);
 alert("decrypted: " + decrypted);
 ```
 
-Check [this example](https://github.com/ecies/wasm-example) for how to use it in browsers.
+Check [the example](./example) for how to use it in browsers.
 
 ## API
 
 ```ts
-function encrypt(receiver_pub: Uint8Array, msg: Uint8Array): Uint8Array | undefined;
-function decrypt(receiver_sec: Uint8Array, msg: Uint8Array): Uint8Array | undefined;
+export function generateKeypair(): Array<Uint8Array>; // [sk, pk]
+export function encrypt(pk: Uint8Array, msg: Uint8Array): Uint8Array;
+export function decrypt(sk: Uint8Array, msg: Uint8Array): Uint8Array;
 ```
 
 ## Build and test
@@ -40,3 +43,7 @@ function decrypt(receiver_sec: Uint8Array, msg: Uint8Array): Uint8Array | undefi
 wasm-pack build
 wasm-pack test --node
 ```
+
+## Changelog
+
+See [CHANGELOG.md](./CHANGELOG.md).

example/README.md

@@ -0,0 +1,13 @@
+# wasm example
+
+## Install
+
+`yarn install`
+
+## Run dev server
+
+`yarn dev`
+
+## Build and preview
+
+`yarn build && yarn preview`

example/index.html

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+
+<head>
+  <meta charset="utf-8">
+  <title>Hello ecies</title>
+</head>
+
+<body>
+  <main id="app"></main>
+  <noscript>This page contains webassembly and javascript content, please enable javascript in your browser.</noscript>
+  <script type="module" src="./index.js"></script>
+</body>
+
+</html>

example/index.js

@@ -0,0 +1,44 @@
+// need to build with `wasm-pack build --target web`
+import init, * as ecies from "../pkg/ecies_wasm";
+
+init();
+
+const data = Uint8Array.from([1, 2, 3, 4]);
+
+function checkOk() {
+  const [sk, pk] = ecies.generateKeypair();
+
+  const encrypted = ecies.encrypt(pk, data);
+  const decrypted = ecies.decrypt(sk, encrypted);
+  alert(`decrypted: ${decrypted}`);
+  if (decrypted.toString("hex") === data.toString("hex")) {
+    alert("call wasm encrypt decrypt ok");
+  }
+}
+
+function checkError() {
+  const pk = Uint8Array.from([0]);
+  try {
+    ecies.encrypt(pk, data);
+  } catch (e) {
+    alert(e);
+  }
+}
+
+document.querySelector("#app").innerHTML = `
+  <h1>WASM Test</h1>
+  <button id="ok">Check ok</button>
+  <button id="error">Check error</button>
+`;
+
+document.getElementById("ok").addEventListener("click", () => {
+  checkOk();
+});
+document.getElementById("error").addEventListener("click", () => {
+  checkError();
+});
+
+window.addEventListener("error", (event) => {
+  // catch all other errors
+  console.error(event);
+});

example/package.json

@@ -0,0 +1,21 @@
+{
+  "name": "ecies-wasm-example",
+  "version": "0.1.0",
+  "author": "Weiliang Li <to.be.impressive@gmail.com>",
+  "description": "ecies-wasm in browser",
+  "license": "MIT",
+  "main": "index.js",
+  "type": "module",
+  "repository": {
+    "url": "https://github.com/ecies/rs"
+  },
+  "scripts": {
+    "dev": "vite",
+    "build": "vite build",
+    "preview": "vite preview"
+  },
+  "dependencies": {},
+  "devDependencies": {
+    "vite": "^4.4.4"
+  }
+}

example/vite.config.js

@@ -0,0 +1,10 @@
+import { defineConfig } from "vite";
+
+export default defineConfig({
+  server: {
+    fs: {
+      // Allow serving files from one level up to the project root
+      allow: [".."],
+    },
+  },
+});