Support for compressed base64 wasm files

Upgrade to use WebAssembly.instantiateStreaming

Author: mainnet-pat

.eslintrc

@@ -7,7 +7,8 @@
     "node_modules",
     "build",
     "coverage",
-    "src/lib/schema/ajv/*.js"
+    "src/lib/schema/ajv/*.js",
+    "src/lib/bin/secp256k1/secp256k1.js"
   ],
   "extends": ["bitauth"],
   // "globals": { "BigInt": true, "console": true, "WebAssembly": true },

package.json

@@ -87,7 +87,8 @@
     "doc:generate": "api-documenter markdown -i temp -o build/api/markdown",
     "doc:check-api": "api-extractor run --typescript-compiler-folder node_modules/typescript",
     "changeset:version": "yarn changeset version && yarn fix:prettier",
-    "release": "yarn build && yarn changeset publish"
+    "release": "yarn build && yarn changeset publish",
+    "test:ripe": "c8 ava --match='*secp256k1*' --serial"
   },
   "engines": {
     "node": "^12.20.0 || ^14.13.1 || >=16.0.0"
@@ -215,4 +216,4 @@
   "resolutions": {
     "eslint-config-bitauth": "portal:./config/eslint-config-bitauth"
   }
-}
+}

src/lib/bin/hashes.ts

@@ -1,10 +1,47 @@
+import { binsAreEqual } from '../format/hex.js';
+
 export type HashFunction = {
   final: (rawState: Uint8Array) => Uint8Array;
   hash: (input: Uint8Array) => Uint8Array;
   init: () => Uint8Array;
   update: (rawState: Uint8Array, input: Uint8Array) => Uint8Array;
 };
 
+/* eslint-disable @typescript-eslint/require-await, functional/no-return-void, functional/no-expression-statements, @typescript-eslint/no-magic-numbers, @typescript-eslint/naming-convention */
+/**
+ * Reads in a wasm binary as an ArrayBuffer, checks if it was compressed and
+ * decompresses it if necessary. Returns a Response object with the wasm binary compatible with WebAssembly.instantiateStreaming.
+ */
+export const streamWasmArrayBuffer = async (
+  wasmArrayBuffer: ArrayBuffer,
+): Promise<Response> => {
+  // currently, we consume the data in a single chunk, but when ReadableStream.from() becomes widely available, we can switch to it
+  const wasmStream = new ReadableStream({
+    start(controller): void {
+      controller.enqueue(new Uint8Array(wasmArrayBuffer));
+      controller.close();
+    },
+  });
+
+  // if source is uncompressed, then return as is
+  if (
+    binsAreEqual(
+      new Uint8Array(wasmArrayBuffer, 0, 4),
+      new Uint8Array([0x00, 0x61, 0x73, 0x6d]),
+    )
+  ) {
+    return new Response(wasmStream, {
+      headers: new Headers({ 'content-type': 'application/wasm' }),
+    });
+  }
+
+  // otherwise, decompress the source
+  return new Response(wasmStream.pipeThrough(new DecompressionStream('gzip')), {
+    headers: new Headers({ 'content-type': 'application/wasm' }),
+  });
+};
+/* eslint-enable @typescript-eslint/require-await, functional/no-return-void, functional/no-expression-statements, @typescript-eslint/no-magic-numbers, @typescript-eslint/naming-convention */
+
 /* eslint-disable functional/no-conditional-statements, functional/no-let, functional/no-expression-statements, no-underscore-dangle, functional/no-try-statements, @typescript-eslint/no-magic-numbers, @typescript-eslint/max-params, @typescript-eslint/no-unsafe-call, @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-assignment, @typescript-eslint/no-non-null-assertion */
 /**
  * Note, most of this method is translated and boiled-down from the wasm-pack
@@ -19,8 +56,9 @@ export const instantiateRustWasm = async (
   updateExportName: string,
   finalExportName: string,
 ): Promise<HashFunction> => {
+  const webassemblyByteStream = await streamWasmArrayBuffer(webassemblyBytes);
   const wasm = (
-    await WebAssembly.instantiate(webassemblyBytes, {
+    await WebAssembly.instantiateStreaming(webassemblyByteStream, {
       [expectedImportModuleName]: {
         /**
          * This would only be called in cases where a `__wbindgen_malloc` failed.

src/lib/bin/ripemd160/ripemd160.base64.ts

@@ -12,6 +12,7 @@ import {
   getEmbeddedSecp256k1Binary,
   instantiateSecp256k1Wasm,
   instantiateSecp256k1WasmBytes,
+  streamWasmArrayBuffer,
 } from '../../lib.js';
 
 // test vectors from `zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo zoo wrong` (`xprv9s21ZrQH143K2PfMvkNViFc1fgumGqBew45JD8SxA59Jc5M66n3diqb92JjvaR61zT9P89Grys12kdtV4EFVo6tMwER7U2hcUmZ9VfMYPLC`), m/0 and m/1:
@@ -491,10 +492,13 @@ const testSecp256k1Wasm = (
 
 const binary = getEmbeddedSecp256k1Binary();
 
-test('[crypto] getEmbeddedSecp256k1Binary returns the proper binary', (t) => {
+test('[crypto] getEmbeddedSecp256k1Binary returns the proper binary', async (t) => {
   const path = join(new URL('.', import.meta.url).pathname, 'secp256k1.wasm');
   const binaryFromDisk = readFileSync(path).buffer;
-  t.deepEqual(binary, binaryFromDisk);
+  const eventuallyDecompressedBinary = await (
+    await streamWasmArrayBuffer(binary)
+  ).arrayBuffer();
+  t.deepEqual(eventuallyDecompressedBinary, binaryFromDisk);
 });
 
 test('[crypto] Secp256k1Wasm instantiated with embedded binary', async (t) => {

src/lib/bin/secp256k1/secp256k1-wasm.spec.ts

@@ -1,6 +1,7 @@
 /* eslint-disable no-underscore-dangle, @typescript-eslint/max-params, @typescript-eslint/naming-convention */
 // cSpell:ignore memcpy, anyfunc
 import { base64ToBin } from '../../format/format.js';
+import { streamWasmArrayBuffer } from '../hashes.js';
 
 import type { Secp256k1Wasm } from './secp256k1-wasm-types.js';
 import { CompressionFlag, ContextFlag } from './secp256k1-wasm-types.js';
@@ -352,11 +353,15 @@ export const instantiateSecp256k1WasmBytes = async (
     global: { Infinity, NaN },
   };
 
-  return WebAssembly.instantiate(webassemblyBytes, info).then((result) => {
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/no-unsafe-assignment
-    getErrNoLocation = result.instance.exports['___errno_location'] as any;
-    return wrapSecp256k1Wasm(result.instance, heapU8, heapU32);
-  });
+  const webassemblyByteStream = await streamWasmArrayBuffer(webassemblyBytes);
+
+  return WebAssembly.instantiateStreaming(webassemblyByteStream, info).then(
+    (result) => {
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/no-unsafe-assignment
+      getErrNoLocation = result.instance.exports['___errno_location'] as any;
+      return wrapSecp256k1Wasm(result.instance, heapU8, heapU32);
+    },
+  );
 };
 /* eslint-enable functional/immutable-data, functional/no-expression-statements, @typescript-eslint/no-magic-numbers, functional/no-conditional-statements, no-bitwise, functional/no-throw-statements */