pvutils 1.2.0: isEqualBuffer

Clean-room public code sample — generation instructions

Write a brand-new, minimal, self-contained code sample in this clean-room directory.
Do not copy, paraphrase, or reference any existing project source. Work only from this spec.

A csx.json manifest scaffold already exists. Do not recreate it from memory. Preserve its case.goal, packages and symbols; fill its empty case.contract with exact assertions and correct its environment, commands and verifierAdapter for the files you generate.

Goal: verify pvutils.isEqualBuffer in pkg:npm/pvutils@1.2.0
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:npm/pvutils@1.2.0
Demonstrate these symbols/APIs:
  - pvutils.isEqualBuffer

Rules:
  - One focused purpose; the smallest project that proves the goal.
  - Include a contract test (test/contract.*) that runs OFFLINE and exits 0 exactly when the goal behavior works.
  - Pin every dependency with a lockfile so resolution is reproducible.
  - No secrets, credentials, or tokens. No real URLs (only example.com or localhost). No absolute paths.
  - No personal names, emails, company names, or project identifiers of any kind.
  - No binaries and no generated output (node_modules, dist, target, venv, .git, .env).
  - Keep it under 200 files and 256KB packed.

{"case":{"caseId":"case:sha256:05b99b48d45e6f8d9b9d768329e25e7d9fdcdb22bcd766e09e540f4af1a5971d","contract":["isEqualBuffer returns true for two distinct ArrayBuffer instances with identical byte contents","isEqualBuffer returns false when two ArrayBuffer instances have different lengths","isEqualBuffer returns false when two ArrayBuffer instances have the same length but differ in byte values","isEqualBuffer returns true when comparing two empty ArrayBuffer instances of zero length","isEqualBuffer returns true when comparing an ArrayBuffer instance with itself"],"goal":"verify pvutils.isEqualBuffer in pkg:npm/pvutils@1.2.0","kind":"HOW","packages":["pkg:npm/pvutils@1.2.0"],"schemaVersion":1,"symbols":["pvutils.isEqualBuffer"]},"contractCommand":["node","test/contract.mjs"],"environment":{"arch":"x64","distro":"ubuntu","ecosystem":"npm","libc":"glibc","libcVersion":"2.39","os":"linux","osVersionBucket":"24","packageManager":"npm","schemaVersion":1},"license":"MIT-0","packages":["pkg:npm/pvutils@1.2.0"],"schemaVersion":1,"subject":"pkg:npm/pvutils@1.2.0","symbols":["pvutils.isEqualBuffer"],"verifierAdapter":"node-typescript@1"}

{
  "name": "sample-pvutils-isequalbuffer",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "sample-pvutils-isequalbuffer",
      "version": "1.0.0",
      "license": "MIT-0",
      "dependencies": {
        "pvutils": "1.2.0"
      }
    },
    "node_modules/pvutils": {
      "version": "1.2.0",
      "resolved": "https://registry.npmjs.org/pvutils/-/pvutils-1.2.0.tgz",
      "integrity": "sha512-BbubeCEyTuQjVMakvJQ/Sxbc93F2pwmbsxONT/ZRrwU7Ua38d8unYTwXpTVLAKJ4BDuH9IGztCjQcd/N/39Dvg==",
      "license": "MIT",
      "engines": {
        "node": ">=16.0.0"
      }
    }
  }
}

{
  "name": "sample-pvutils-isequalbuffer",
  "version": "1.0.0",
  "private": true,
  "description": "Clean-room verification sample for pvutils.isEqualBuffer",
  "type": "module",
  "main": "src/index.js",
  "scripts": {
    "test": "node test/contract.mjs"
  },
  "dependencies": {
    "pvutils": "1.2.0"
  },
  "license": "MIT-0"
}

{
  "schemaVersion": 1,
  "goal": "verify pvutils.isEqualBuffer in pkg:npm/pvutils@1.2.0",
  "kind": "HOW",
  "packages": [
    "pkg:npm/pvutils@1.2.0"
  ],
  "symbols": [
    "pvutils.isEqualBuffer"
  ]
}

import { isEqualBuffer } from 'pvutils';

/**
 * Compares two ArrayBuffer instances for equality.
 * @param {ArrayBuffer} inputBuffer1 - First ArrayBuffer.
 * @param {ArrayBuffer} inputBuffer2 - Second ArrayBuffer.
 * @returns {boolean} True if both buffers have identical length and byte contents, false otherwise.
 */
export function compareBuffers(inputBuffer1, inputBuffer2) {
  return isEqualBuffer(inputBuffer1, inputBuffer2);
}

export { isEqualBuffer };

import assert from 'node:assert/strict';
import { isEqualBuffer, compareBuffers } from '../src/index.js';

// 1. isEqualBuffer returns true for two distinct ArrayBuffer instances with identical byte contents
const buf1 = new Uint8Array([10, 20, 30, 40]).buffer;
const buf2 = new Uint8Array([10, 20, 30, 40]).buffer;
assert.notStrictEqual(buf1, buf2, 'buffers must be distinct instances');
assert.strictEqual(isEqualBuffer(buf1, buf2), true);
assert.strictEqual(compareBuffers(buf1, buf2), true);

// 2. isEqualBuffer returns false when two ArrayBuffer instances have different lengths
const bufShort = new Uint8Array([10, 20, 30]).buffer;
assert.strictEqual(isEqualBuffer(buf1, bufShort), false);
assert.strictEqual(compareBuffers(buf1, bufShort), false);

// 3. isEqualBuffer returns false when two ArrayBuffer instances have the same length but differ in byte values
const bufDiff = new Uint8Array([10, 20, 99, 40]).buffer;
assert.strictEqual(isEqualBuffer(buf1, bufDiff), false);
assert.strictEqual(compareBuffers(buf1, bufDiff), false);

// 4. isEqualBuffer returns true when comparing two empty ArrayBuffer instances of zero length
const empty1 = new ArrayBuffer(0);
const empty2 = new ArrayBuffer(0);
assert.notStrictEqual(empty1, empty2, 'empty buffers must be distinct instances');
assert.strictEqual(isEqualBuffer(empty1, empty2), true);
assert.strictEqual(compareBuffers(empty1, empty2), true);

// 5. isEqualBuffer returns true when comparing an ArrayBuffer instance with itself
assert.strictEqual(isEqualBuffer(buf1, buf1), true);
assert.strictEqual(compareBuffers(buf1, buf1), true);

console.log('All pvutils.isEqualBuffer contract assertions passed.');