ox 1.0.5 → 1.1.2

package/src/wasm/_test/Engine.test.ts

@@ -0,0 +1,96 @@
+import { Engine as CoreEngine } from 'ox'
+import { Engine, Hash } from 'ox/wasm'
+import { describe, expect, test } from 'vp/test'
+
+describe('engine', () => {
+  test('behavior: does not install', async () => {
+    const engine = await Engine.engine()
+    expect(Object.keys(engine)).toMatchInlineSnapshot(`
+      [
+        "Ed25519",
+        "Hash",
+        "Keystore",
+        "Mnemonic",
+        "X25519",
+      ]
+    `)
+    // Benches, differential tests, and composition need an implementation
+    // value without touching global state.
+    expect(CoreEngine.get()).toMatchInlineSnapshot('{}')
+  })
+
+  test('behavior: installs for the duration of a call', async () => {
+    // `with` is the case that genuinely needs a value: there is nothing
+    // installed for `set` to merge into.
+    const wasm = await Engine.engine()
+    const inside = CoreEngine.with(wasm, () => Hash.sha256('0xdeadbeef'))
+    expect(inside).toEqual(Hash.sha256('0xdeadbeef'))
+    expect(CoreEngine.get()).toMatchInlineSnapshot('{}')
+  })
+})
+
+describe('install', () => {
+  test('behavior: merges with a later set, rather than being replaced', async () => {
+    await Engine.install()
+    CoreEngine.set({ Bls: { randomSecretKey: () => new Uint8Array(32) } })
+    expect(Object.keys(CoreEngine.get()).sort()).toMatchInlineSnapshot(`
+      [
+        "Bls",
+        "Ed25519",
+        "Hash",
+        "Keystore",
+        "Mnemonic",
+        "X25519",
+      ]
+    `)
+  })
+
+  test('behavior: installs, and returns what it installed', async () => {
+    const before = Hash.sha256('0xdeadbeef')
+
+    const engine = await Engine.install()
+
+    expect(Object.keys(CoreEngine.get())).toEqual(Object.keys(engine))
+    // Installing changes which implementation runs, never the answer.
+    expect(Hash.sha256('0xdeadbeef')).toEqual(before)
+    expect(Engine.get()).toEqual(CoreEngine.get())
+  })
+
+  test('behavior: routes every slot it reports', async () => {
+    await Engine.install()
+    expect(
+      Object.fromEntries(
+        Object.entries(CoreEngine.get()).map(([slot, value]) => [
+          slot,
+          Object.keys(value ?? {}).sort(),
+        ]),
+      ),
+    ).toMatchInlineSnapshot(`
+        {
+          "Ed25519": [
+            "getPublicKey",
+            "sign",
+            "toMontgomerySecret",
+            "verify",
+          ],
+          "Hash": [
+            "blake3",
+            "hmacSha256",
+            "keccak256",
+            "ripemd160",
+            "sha256",
+          ],
+          "Keystore": [
+            "pbkdf2Sha256",
+          ],
+          "Mnemonic": [
+            "toSeed",
+          ],
+          "X25519": [
+            "getPublicKey",
+            "getSharedSecret",
+          ],
+        }
+      `)
+  })
+})

package/src/wasm/_test/Hash.browser.test.ts

@@ -0,0 +1,54 @@
+import { blake3 } from '@noble/hashes/blake3.js'
+import { keccak_256 } from '@noble/hashes/sha3.js'
+import { describe, expect, test, vi } from 'vp/test'
+import * as Engine from '../../core/Engine.js'
+import * as Hash from '../../core/Hash.js'
+import * as WasmHash from '../Hash.js'
+
+describe('engine', () => {
+  test('behavior: instantiates asynchronously', async () => {
+    // Chrome refuses to compile modules above a few kilobytes synchronously on
+    // the main thread, so `new WebAssembly.Module` must never be reached. A spy
+    // is the only way to assert that, since the artifact happens to be small
+    // enough today that a synchronous compile would succeed.
+    const Module = vi.spyOn(globalThis.WebAssembly, 'Module')
+    const Instance = vi.spyOn(globalThis.WebAssembly, 'Instance')
+    try {
+      const engine = await WasmHash.engine()
+      expect(Module).not.toHaveBeenCalled()
+      expect(Instance).not.toHaveBeenCalled()
+
+      const input = new Uint8Array(32).fill(1)
+      expect(engine.keccak256(input)).toEqual(keccak_256(input))
+      expect(engine.blake3(input)).toEqual(blake3(input))
+    } finally {
+      Module.mockRestore()
+      Instance.mockRestore()
+    }
+  })
+
+  test('behavior: grows memory in a real browser, then hashes a small input', async () => {
+    const engine = await WasmHash.engine()
+
+    const large = new Uint8Array(3 * 1024 * 1024).fill(7)
+    expect(engine.keccak256(large)).toEqual(keccak_256(large))
+    expect(engine.blake3(large)).toEqual(blake3(large))
+
+    // `memory.grow` detached the previous `ArrayBuffer`; a retained view would
+    // now read zero bytes.
+    const small = new Uint8Array(32).fill(1)
+    expect(engine.keccak256(small)).toEqual(keccak_256(small))
+    expect(engine.blake3(small)).toEqual(blake3(small))
+  })
+
+  test('behavior: ox uses the WASM implementation once installed', async () => {
+    await Engine.install({ Hash: WasmHash.engine() })
+    try {
+      expect(Hash.keccak256('0xdeadbeef')).toBe(
+        '0xd4fd4e189132273036449fc9e11198c739161b4c0116a9a2dccdfa1c492006f1',
+      )
+    } finally {
+      Engine.reset()
+    }
+  })
+})

package/src/wasm/_test/Hash.fuzz.ts

@@ -0,0 +1,223 @@
+import { fc, test } from '@fast-check/vitest'
+import { blake3 } from '@noble/hashes/blake3.js'
+import { hmac } from '@noble/hashes/hmac.js'
+import { ripemd160 } from '@noble/hashes/legacy.js'
+import { sha256 } from '@noble/hashes/sha2.js'
+import { keccak_256 } from '@noble/hashes/sha3.js'
+import { Hash as WasmHash } from 'ox/wasm'
+import { beforeAll, describe, expect } from 'vp/test'
+import { numRuns } from '../../../test/fuzz/numRuns.js'
+
+let engine: WasmHash.engine.ReturnType
+
+beforeAll(async () => {
+  engine = await WasmHash.engine()
+})
+
+/**
+ * `@noble/hashes` is the oracle: it is audited and it is what ox ships by
+ * default, so any divergence here is a bug in the WASM implementation. Published
+ * vectors live in `Hash.vectors.test.ts` and cover the case where both
+ * implementations could be wrong together.
+ *
+ * The distribution is weighted toward the sizes where padding and block-boundary
+ * bugs hide -- empty input, exact multiples of the keccak256 rate (136) and the
+ * SHA-2 block (64), BLAKE3 chunk (1024), and the 56-byte threshold at which
+ * the SHA-2 length counter no longer fits in the final block.
+ */
+const arbitraryInput = fc.oneof(
+  { arbitrary: fc.uint8Array({ maxLength: 300, minLength: 0 }), weight: 6 },
+  {
+    arbitrary: fc
+      .constantFrom(
+        0,
+        1,
+        55,
+        56,
+        63,
+        64,
+        65,
+        111,
+        112,
+        135,
+        136,
+        137,
+        272,
+        1023,
+        1024,
+        1025,
+        2048,
+        2049,
+      )
+      .chain((size) => fc.uint8Array({ maxLength: size, minLength: size })),
+    weight: 3,
+  },
+  {
+    arbitrary: fc.uint8Array({ maxLength: 4096, minLength: 1024 }),
+    weight: 1,
+  },
+)
+
+/**
+ * HMAC key lengths straddling the 64-byte block. At or under it the key is
+ * zero-padded; over it, it is hashed first -- a different code path that the
+ * message-shaped arbitrary above would only reach by chance.
+ */
+const arbitraryKey = fc.oneof(
+  {
+    arbitrary: fc
+      .constantFrom(0, 1, 32, 63, 64, 65, 96, 128, 129)
+      .chain((size) => fc.uint8Array({ maxLength: size, minLength: size })),
+    weight: 3,
+  },
+  { arbitrary: fc.uint8Array({ maxLength: 200, minLength: 0 }), weight: 1 },
+)
+
+const primitives = {
+  blake3: {
+    reference: (input: Uint8Array) => blake3(input),
+    wasm: (input: Uint8Array) => engine.blake3(input),
+  },
+  hmacSha256: {
+    reference: (input: Uint8Array, key: Uint8Array) => hmac(sha256, key, input),
+    wasm: (input: Uint8Array, key: Uint8Array) => engine.hmacSha256(key, input),
+  },
+  keccak256: {
+    reference: (input: Uint8Array) => keccak_256(input),
+    wasm: (input: Uint8Array) => engine.keccak256(input),
+  },
+  ripemd160: {
+    reference: (input: Uint8Array) => ripemd160(input),
+    wasm: (input: Uint8Array) => engine.ripemd160(input),
+  },
+  sha256: {
+    reference: (input: Uint8Array) => sha256(input),
+    wasm: (input: Uint8Array) => engine.sha256(input),
+  },
+} as const
+
+type Name = keyof typeof primitives
+
+describe('Hash', () => {
+  test.prop({ input: arbitraryInput }, { numRuns })(
+    'blake3 ≡ @noble/hashes',
+    ({ input }) => {
+      expect(engine.blake3(input)).toEqual(blake3(input))
+    },
+  )
+
+  test.prop({ input: arbitraryInput }, { numRuns })(
+    'keccak256 ≡ @noble/hashes',
+    ({ input }) => {
+      expect(engine.keccak256(input)).toEqual(keccak_256(input))
+    },
+  )
+
+  test.prop({ input: arbitraryInput }, { numRuns })(
+    'sha256 ≡ @noble/hashes',
+    ({ input }) => {
+      expect(engine.sha256(input)).toEqual(sha256(input))
+    },
+  )
+
+  test.prop({ input: arbitraryInput }, { numRuns })(
+    'ripemd160 ≡ @noble/hashes',
+    ({ input }) => {
+      expect(engine.ripemd160(input)).toEqual(ripemd160(input))
+    },
+  )
+
+  test.prop({ input: arbitraryInput, key: arbitraryKey }, { numRuns })(
+    'hmacSha256 ≡ @noble/hashes',
+    ({ input, key }) => {
+      expect(engine.hmacSha256(key, input)).toEqual(hmac(sha256, key, input))
+    },
+  )
+})
+
+describe('memory', () => {
+  test.prop(
+    {
+      operations: fc.array(
+        fc.record({
+          input: arbitraryInput,
+          key: arbitraryKey,
+          name: fc.constantFrom<Name>(
+            'blake3',
+            'hmacSha256',
+            'keccak256',
+            'ripemd160',
+            'sha256',
+          ),
+        }),
+        { maxLength: 24, minLength: 2 },
+      ),
+    },
+    { numRuns },
+  )('an arbitrary sequence of calls agrees at every step', ({ operations }) => {
+    // Every primitive shares one region of WASM linear memory, reusing it call
+    // after call. A mis-sized reservation, an off-by-one write, or a digest read
+    // from the wrong offset can leave earlier bytes behind and still produce a
+    // correct answer in isolation -- it only shows up when calls of differing
+    // sizes and kinds are interleaved. Comparing every step of a random sequence
+    // is what catches that; a fixed a/b/a pattern does not.
+    for (const { input, key, name } of operations) {
+      const primitive = primitives[name]
+      expect(
+        primitive.wasm(input, key),
+        `${name} with a ${input.length} byte input`,
+      ).toEqual(primitive.reference(input, key))
+    }
+  })
+
+  test.prop(
+    {
+      sizes: fc.array(fc.integer({ max: 20, min: 0 }), {
+        maxLength: 6,
+        minLength: 2,
+      }),
+    },
+    { numRuns: Math.min(numRuns, 20) },
+  )('repeated growth keeps results correct', ({ sizes }) => {
+    // Each size is a page count. Going up grows linear memory and detaches the
+    // previous `ArrayBuffer`; coming back down must not, since WASM memory never
+    // shrinks. Either way the view has to be re-derived, and a stale one reads
+    // as zeroes rather than throwing.
+    for (const pages of sizes) {
+      const input = new Uint8Array(pages * 65_536).fill(pages & 0xff)
+      expect(engine.keccak256(input), `${pages} pages`).toEqual(
+        keccak_256(input),
+      )
+    }
+  })
+
+  test.prop({ input: arbitraryInput }, { numRuns })(
+    'digests never alias WASM memory',
+    ({ input }) => {
+      // A digest returned as a view over linear memory would be silently
+      // rewritten by the next call. Hold one across a larger call and check it.
+      const digest = engine.keccak256(input)
+      const snapshot = digest.slice()
+      engine.keccak256(new Uint8Array(input.length + 1024).fill(0xaa))
+      expect(digest).toEqual(snapshot)
+
+      const blake3Digest = engine.blake3(input)
+      const blake3Snapshot = blake3Digest.slice()
+      engine.blake3(new Uint8Array(input.length + 1024).fill(0xaa))
+      expect(blake3Digest).toEqual(blake3Snapshot)
+    },
+  )
+
+  test.prop({ input: arbitraryInput }, { numRuns })(
+    'inputs are not mutated',
+    ({ input }) => {
+      const snapshot = input.slice()
+      engine.blake3(input)
+      engine.keccak256(input)
+      engine.sha256(input)
+      engine.ripemd160(input)
+      engine.hmacSha256(input, input)
+      expect(input).toEqual(snapshot)
+    },
+  )
+})

package/src/wasm/_test/Hash.test-d.ts

@@ -0,0 +1,33 @@
+import { Hash as WasmHash } from 'ox/wasm'
+import { expectTypeOf, test } from 'vp/test'
+import type * as CoreEngine from '../../core/Engine.js'
+import * as CoreHash from '../../core/Hash.js'
+
+type Slot = Awaited<ReturnType<typeof WasmHash.engine>>
+
+test('every primitive is present, so callers need no assertion', () => {
+  expectTypeOf<Slot['blake3']>().toEqualTypeOf<
+    (input: Uint8Array) => Uint8Array
+  >()
+  expectTypeOf<Slot['keccak256']>().toEqualTypeOf<
+    (input: Uint8Array) => Uint8Array
+  >()
+  expectTypeOf<Slot['sha256']>().toEqualTypeOf<
+    (input: Uint8Array) => Uint8Array
+  >()
+  expectTypeOf<Slot['ripemd160']>().toEqualTypeOf<
+    (input: Uint8Array) => Uint8Array
+  >()
+  expectTypeOf<Slot['hmacSha256']>().toEqualTypeOf<
+    (key: Uint8Array, message: Uint8Array) => Uint8Array
+  >()
+})
+
+test('the result is the raw slot, so `Engine.install` accepts it', () => {
+  expectTypeOf<{ Hash: Slot }>().toExtend<CoreEngine.Engine>()
+})
+
+test('the WASM namespace exposes the public Hash API', () => {
+  expectTypeOf(WasmHash.sha256).toEqualTypeOf(CoreHash.sha256)
+  expectTypeOf<typeof WasmHash>().not.toHaveProperty('create')
+})