build changes: Switch to pure ESM, switch tests to ts.

Author: paulmillr

.github/workflows/release.yml

@@ -4,8 +4,8 @@ on:
     types: [created]
 jobs:
   release-js:
-    name: 'jsbt v0.4.1'
-    uses: paulmillr/jsbt/.github/workflows/release.yml@2318b9efe24831b4bd4cadf720c96f071c69c64d
+    name: 'jsbt v0.4.2' # Should match commit below
+    uses: paulmillr/jsbt/.github/workflows/release.yml@5194a28c9f94ad504090fe037fe6efb41e5b8964
     with:
       build-path: test/build
       # slow-types: false

.github/workflows/test-js.yml

@@ -0,0 +1,8 @@
+name: Run TS tests
+on:
+  - push
+  - pull_request
+jobs:
+  test-ts:
+    name: 'jsbt v0.4.2' # Should match commit below
+    uses: paulmillr/jsbt/.github/workflows/test-ts.yml@5194a28c9f94ad504090fe037fe6efb41e5b8964

.github/workflows/test-ts.yml

@@ -1,6 +1,8 @@
-build/
-node_modules/
-/lib
+node_modules
+*.tgz
 /*.js
-/*.d.ts
-/*.map
+*.js.map
+*.d.ts
+*.d.ts.map
+/test/build
+/test/compiled

.gitignore

@@ -31,18 +31,12 @@ Audited & minimal JS implementation of sr25519 cryptography for Polkadot.
 
 > `deno add jsr:@scure/sr25519`
 
-> `deno doc jsr:@scure/sr25519` # command-line documentation
-
-
-```ts
-import * as sr25519 from '@scure/sr25519';
-```
-
 We support all major platforms and runtimes.
 
 ### Basic
 
 ```ts
+import * as sr25519 from '@scure/sr25519';
 const signature = sr25519.sign(pair.secretKey, msg);
 const isValid = sr25519.verify(msg, polkaSig, pair.publicKey);
 const secretKey = sr25519.secretFromSeed(seed);

README.md

@@ -3,47 +3,35 @@
   "version": "0.2.0",
   "description": "Audited & minimal implementation of sr25519 (polkadot) cryptography, with Merlin and Strobe",
   "files": [
-    "lib",
+    "index.js",
+    "index.js.map",
+    "index.d.ts",
+    "index.d.ts.map",
     "index.ts"
   ],
-  "exports": {
-    ".": {
-      "import": "./lib/esm/index.js",
-      "require": "./lib/index.js"
-    }
-  },
   "dependencies": {
-    "@noble/curves": "2.0.0-beta.2",
-    "@noble/hashes": "2.0.0-beta.4"
+    "@noble/curves": "2.0.0-beta.3",
+    "@noble/hashes": "2.0.0-beta.5"
   },
   "devDependencies": {
-    "@paulmillr/jsbt": "0.4.1",
-    "micro-bmark": "0.4.1",
+    "@paulmillr/jsbt": "0.4.2",
+    "micro-bmark": "0.4.2",
     "micro-should": "0.5.3",
-    "prettier": "3.5.2",
-    "typescript": "5.8.3"
-  },
-  "main": "index.js",
-  "module": "index.js",
-  "types": "index.d.ts",
-  "type": "module",
-  "sideEffects": false,
-  "author": "Paul Miller (https://paulmillr.com)",
-  "license": "MIT",
-  "homepage": "https://github.com/paulmillr/scure-sr25519",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/paulmillr/scure-sr25519.git"
+    "prettier": "3.6.2",
+    "typescript": "5.9.2"
   },
   "scripts": {
     "build": "tsc",
     "build:release": "npx --no @paulmillr/jsbt esbuild test/build",
-    "bench": "cd test/benchmark; npm i; node index.js",
-    "lint": "prettier --check index.ts test/*.test.js",
-    "format": "prettier --write index.ts test/*.test.js",
+    "bench": "cd test/benchmark; npm i; node index.ts",
+    "format": "prettier --write index.ts 'test/**/*.{js,ts}'",
     "test": "node test/index.ts",
     "test:bun": "bun test/index.ts",
-    "test:deno": "deno --allow-env --allow-read test/index.ts"
+    "test:deno": "deno --allow-env --allow-read test/index.ts",
+    "test:node20": "cd test; npx tsc; node compiled/test/index.js"
+  },
+  "engines": {
+    "node": ">= 20.19.0"
   },
   "keywords": [
     "sr25519",
@@ -55,5 +43,17 @@
     "ristretto",
     "ed25519"
   ],
-  "funding": "https://paulmillr.com/funding/"
-}
+  "homepage": "https://paulmillr.com/noble/#scure",
+  "funding": "https://paulmillr.com/funding/",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/paulmillr/scure-sr25519.git"
+  },
+  "type": "module",
+  "main": "index.js",
+  "module": "index.js",
+  "types": "index.d.ts",
+  "sideEffects": false,
+  "author": "Paul Miller (https://paulmillr.com)",
+  "license": "MIT"
+}

package-lock.json

@@ -1,8 +1,8 @@
-import { mark } from 'micro-bmark';
 import { hexToBytes, utf8ToBytes } from '@noble/hashes/utils';
-import * as sr25519 from '../../lib/esm/index.js';
 import * as polka from '@polkadot/util-crypto';
 import { deepStrictEqual } from 'assert';
+import { mark } from 'micro-bmark';
+import * as sr25519 from '../../index.ts';
 
 async function compare(title, runs, kinds) {
   for (let [name, fn] of Object.entries(kinds)) {
@@ -34,7 +34,7 @@ async function compare(title, runs, kinds) {
   if (BENCH) {
     await compare('secretFromSeed', 100_000, {
       wasm: () => polka.sr25519PairFromSeed(selfSeed),
-      micro: () => sr25519.secretFromSeed(selfSeed),
+      scure: () => sr25519.secretFromSeed(selfSeed),
     });
   }
 
@@ -48,7 +48,7 @@ async function compare(title, runs, kinds) {
   if (BENCH) {
     await compare('getSharedSecret', 1_000, {
       wasm: () => polka.sr25519Agreement(skSelf, pubOther),
-      micro: () => sr25519.getSharedSecret(skSelf, pubOther),
+      scure: () => sr25519.getSharedSecret(skSelf, pubOther),
     });
   }
 
@@ -63,7 +63,7 @@ async function compare(title, runs, kinds) {
   if (BENCH) {
     await compare('HDKD.secretHard', 50_000, {
       wasm: () => polka.sr25519DeriveHard(pair, cc),
-      micro: () => sr25519.HDKD.secretHard(skSelf, cc),
+      scure: () => sr25519.HDKD.secretHard(skSelf, cc),
     });
   }
 
@@ -77,7 +77,7 @@ async function compare(title, runs, kinds) {
   if (BENCH) {
     await compare('HDKD.secretSoft', 1_000, {
       wasm: () => polka.sr25519DeriveSoft(pair, cc),
-      micro: () => sr25519.HDKD.secretSoft(skSelf, cc),
+      scure: () => sr25519.HDKD.secretSoft(skSelf, cc),
     });
   }
 
@@ -89,7 +89,7 @@ async function compare(title, runs, kinds) {
   if (BENCH) {
     await compare('HDKD.publicSoft', 1_000, {
       wasm: () => polka.sr25519DerivePublic(pubSelf, cc),
-      micro: () => sr25519.HDKD.publicSoft(pubSelf, cc),
+      scure: () => sr25519.HDKD.publicSoft(pubSelf, cc),
     });
   }
 
@@ -104,11 +104,11 @@ async function compare(title, runs, kinds) {
   if (BENCH) {
     await compare('sign', 1_000, {
       wasm: () => polka.sr25519Sign(msg, pair),
-      micro: () => sr25519.sign(pair.secretKey, msg),
+      scure: () => sr25519.sign(pair.secretKey, msg),
     });
     await compare('verify', 1_000, {
       wasm: () => polka.sr25519Verify(msg, nobleSig, pair.publicKey),
-      micro: () => sr25519.verify(msg, nobleSig, pair.publicKey),
+      scure: () => sr25519.verify(msg, nobleSig, pair.publicKey),
     });
   }
   // VRF
@@ -123,11 +123,11 @@ async function compare(title, runs, kinds) {
   if (BENCH) {
     await compare('vrfSign', 1_000, {
       wasm: () => polka.sr25519VrfSign(msg, pair),
-      micro: () => sr25519.vrf.sign(msg, pair.secretKey),
+      scure: () => sr25519.vrf.sign(msg, pair.secretKey),
     });
     await compare('vrfVerify', 1_000, {
       wasm: () => polka.sr25519VrfVerify(msg, polkaVrfSig, pair.publicKey),
-      micro: () => sr25519.vrf.verify(msg, nobleVrfSig, pair.publicKey),
+      scure: () => sr25519.vrf.verify(msg, nobleVrfSig, pair.publicKey),
     });
   }
 })();

package.json

@@ -14,4 +14,4 @@
   "devDependencies": {
     "@polkadot/util-crypto": "13.5.1"
   }
-}
+}