import { randomBytes } from "crypto"; import { readFileSync } from "fs"; import { join, resolve } from "path"; import { globSync } from "glob"; const yaml = require("js-yaml"); interface TestMeta< I extends Record, O extends boolean | string | string[] | Record, > { input: I; output: O; } import { loadTrustedSetup, blobToKzgCommitment, computeKzgProof, computeBlobKzgProof, verifyKzgProof, verifyBlobKzgProof, verifyBlobKzgProofBatch, BYTES_PER_BLOB, BYTES_PER_COMMITMENT, BYTES_PER_PROOF, BYTES_PER_FIELD_ELEMENT, ProofResult, } from "../lib/kzg"; const SETUP_FILE_PATH = resolve( __dirname, "__fixtures__", "testing_trusted_setups.json", ); const MAX_TOP_BYTE = 114; const TEST_DIR = "../../tests"; type BlobToKzgCommitmentTest = TestMeta<{ blob: string }, string>; const BLOB_TO_KZG_COMMITMENT_TESTS = join( TEST_DIR, "blob_to_kzg_commitment/*/*/data.yaml", ); type ComputeKzgProofTest = TestMeta<{ blob: string; z: string }, string[]>; const COMPUTE_KZG_PROOF_TESTS = join( TEST_DIR, "compute_kzg_proof/*/*/data.yaml", ); type ComputeBlobKzgProofTest = TestMeta< { blob: string; commitment: string }, string >; const COMPUTE_BLOB_KZG_PROOF_TESTS = join( TEST_DIR, "compute_blob_kzg_proof/*/*/data.yaml", ); type VerifyKzgProofTest = TestMeta< { commitment: string; y: string; z: string; proof: string }, boolean >; const VERIFY_KZG_PROOF_TESTS = join(TEST_DIR, "verify_kzg_proof/*/*/data.yaml"); type VerifyBlobKzgProofTest = TestMeta< { blob: string; commitment: string; proof: string }, boolean >; const VERIFY_BLOB_KZG_PROOF_TESTS = join( TEST_DIR, "verify_blob_kzg_proof/*/*/data.yaml", ); type VerifyBatchKzgProofTest = TestMeta< { blobs: string[]; commitments: string[]; proofs: string[] }, boolean >; const VERIFY_BLOB_KZG_PROOF_BATCH_TESTS = join( TEST_DIR, "verify_blob_kzg_proof_batch/*/*/data.yaml", ); const generateRandomBlob = () => { return new Uint8Array( randomBytes(BYTES_PER_BLOB).map((x, i) => { // Set the top byte to be low enough that the field element doesn't overflow the BLS modulus if (x > MAX_TOP_BYTE && i % BYTES_PER_FIELD_ELEMENT == 31) { return Math.floor(Math.random() * MAX_TOP_BYTE); } return x; }), ); }; const blobValidLength = randomBytes(BYTES_PER_BLOB); const blobBadLength = randomBytes(BYTES_PER_BLOB - 1); const commitmentValidLength = randomBytes(BYTES_PER_COMMITMENT); const commitmentBadLength = randomBytes(BYTES_PER_COMMITMENT - 1); const proofValidLength = randomBytes(BYTES_PER_PROOF); const proofBadLength = randomBytes(BYTES_PER_PROOF - 1); const fieldElementValidLength = randomBytes(BYTES_PER_FIELD_ELEMENT); const fieldElementBadLength = randomBytes(BYTES_PER_FIELD_ELEMENT - 1); function bytesFromHex(hexString: string): Buffer { return Buffer.from(hexString.slice(2), "hex"); } describe("C-KZG", () => { beforeAll(async () => { loadTrustedSetup(SETUP_FILE_PATH); }); describe("reference tests should pass", () => { it("reference tests for blobToKzgCommitment should pass", () => { let tests = globSync(BLOB_TO_KZG_COMMITMENT_TESTS); expect(tests.length).toBeGreaterThan(0); tests.forEach((testFile: string) => { const test: BlobToKzgCommitmentTest = yaml.load( readFileSync(testFile, "ascii"), ); let commitment: Buffer; let blob = bytesFromHex(test.input.blob); try { commitment = blobToKzgCommitment(blob); } catch (err) { expect(test.output).toBeNull(); return; } expect(test.output).not.toBeNull(); let expectedCommitment = bytesFromHex(test.output); expect(commitment).toEqual(expectedCommitment); }); }); it("reference tests for computeKzgProof should pass", () => { let tests = globSync(COMPUTE_KZG_PROOF_TESTS); expect(tests.length).toBeGreaterThan(0); tests.forEach((testFile: string) => { const test: ComputeKzgProofTest = yaml.load( readFileSync(testFile, "ascii"), ); let proof: ProofResult; let blob = bytesFromHex(test.input.blob); let z = bytesFromHex(test.input.z); try { proof = computeKzgProof(blob, z); } catch (err) { expect(test.output).toBeNull(); return; } expect(test.output).not.toBeNull(); expect(proof).toEqual(test.output.map((hex) => bytesFromHex(hex))); }); }); it("reference tests for computeBlobKzgProof should pass", () => { let tests = globSync(COMPUTE_BLOB_KZG_PROOF_TESTS); expect(tests.length).toBeGreaterThan(0); tests.forEach((testFile: string) => { const test: ComputeBlobKzgProofTest = yaml.load( readFileSync(testFile, "ascii"), ); let proof: Buffer; let blob = bytesFromHex(test.input.blob); let commitment = bytesFromHex(test.input.commitment); try { proof = computeBlobKzgProof(blob, commitment); } catch (err) { expect(test.output).toBeNull(); return; } expect(test.output).not.toBeNull(); let expectedProof = bytesFromHex(test.output); expect(proof).toEqual(expectedProof); }); }); it("reference tests for verifyKzgProof should pass", () => { let tests = globSync(VERIFY_KZG_PROOF_TESTS); expect(tests.length).toBeGreaterThan(0); tests.forEach((testFile: string) => { const test: VerifyKzgProofTest = yaml.load( readFileSync(testFile, "ascii"), ); let valid; let commitment = bytesFromHex(test.input.commitment); let z = bytesFromHex(test.input.z); let y = bytesFromHex(test.input.y); let proof = bytesFromHex(test.input.proof); try { valid = verifyKzgProof(commitment, z, y, proof); } catch (err) { expect(test.output).toBeNull(); return; } expect(valid).toEqual(test.output); }); }); it("reference tests for verifyBlobKzgProof should pass", () => { let tests = globSync(VERIFY_BLOB_KZG_PROOF_TESTS); expect(tests.length).toBeGreaterThan(0); tests.forEach((testFile: string) => { const test: VerifyBlobKzgProofTest = yaml.load( readFileSync(testFile, "ascii"), ); let valid; let blob = bytesFromHex(test.input.blob); let commitment = bytesFromHex(test.input.commitment); let proof = bytesFromHex(test.input.proof); try { valid = verifyBlobKzgProof(blob, commitment, proof); } catch (err) { expect(test.output).toBeNull(); return; } expect(valid).toEqual(test.output); }); }); it("reference tests for verifyBlobKzgProofBatch should pass", () => { let tests = globSync(VERIFY_BLOB_KZG_PROOF_BATCH_TESTS); expect(tests.length).toBeGreaterThan(0); tests.forEach((testFile: string) => { const test: VerifyBatchKzgProofTest = yaml.load( readFileSync(testFile, "ascii"), ); let valid; let blobs = test.input.blobs.map(bytesFromHex); let commitments = test.input.commitments.map(bytesFromHex); let proofs = test.input.proofs.map(bytesFromHex); try { valid = verifyBlobKzgProofBatch(blobs, commitments, proofs); } catch (err) { expect(test.output).toBeNull(); return; } expect(valid).toEqual(test.output); }); }); }); describe("edge cases for blobToKzgCommitment", () => { it("throws as expected when given an argument of invalid type", () => { // @ts-expect-error expect(() => blobToKzgCommitment("wrong type")).toThrowError( "Expected blob to be a Uint8Array", ); }); it("throws as expected when given an argument of invalid length", () => { expect(() => blobToKzgCommitment(blobBadLength)).toThrowError( "Expected blob to be 131072 bytes", ); }); }); // TODO: add more tests for this function. describe("edge cases for computeKzgProof", () => { it("computes a proof from blob/field element", () => { let blob = generateRandomBlob(); const zBytes = new Uint8Array(BYTES_PER_FIELD_ELEMENT).fill(0); computeKzgProof(blob, zBytes); }); it("throws as expected when given an argument of invalid length", () => { expect(() => computeKzgProof(blobBadLength, fieldElementValidLength), ).toThrowError("Expected blob to be 131072 bytes"); expect(() => computeKzgProof(blobValidLength, fieldElementBadLength), ).toThrowError("Expected zBytes to be 32 bytes"); }); }); // TODO: add more tests for this function. describe("edge cases for computeBlobKzgProof", () => { it("computes a proof from blob", () => { let blob = generateRandomBlob(); let commitment = blobToKzgCommitment(blob); computeBlobKzgProof(blob, commitment); }); it("throws as expected when given an argument of invalid length", () => { expect(() => computeBlobKzgProof( blobBadLength, blobToKzgCommitment(generateRandomBlob()), ), ).toThrowError("Expected blob to be 131072 bytes"); }); }); describe("edge cases for verifyKzgProof", () => { it("valid proof should result in true", () => { const commitment = new Uint8Array(BYTES_PER_COMMITMENT).fill(0); commitment[0] = 0xc0; const z = new Uint8Array(BYTES_PER_FIELD_ELEMENT).fill(0); const y = new Uint8Array(BYTES_PER_FIELD_ELEMENT).fill(0); const proof = new Uint8Array(BYTES_PER_PROOF).fill(0); proof[0] = 0xc0; expect(verifyKzgProof(commitment, z, y, proof)).toBe(true); }); it("invalid proof should result in false", () => { const commitment = new Uint8Array(BYTES_PER_COMMITMENT).fill(0); commitment[0] = 0xc0; const z = new Uint8Array(BYTES_PER_FIELD_ELEMENT).fill(1); const y = new Uint8Array(BYTES_PER_FIELD_ELEMENT).fill(1); const proof = new Uint8Array(BYTES_PER_PROOF).fill(0); proof[0] = 0xc0; expect(verifyKzgProof(commitment, z, y, proof)).toBe(false); }); it("throws as expected when given an argument of invalid length", () => { expect(() => verifyKzgProof( commitmentBadLength, fieldElementValidLength, fieldElementValidLength, proofValidLength, ), ).toThrowError("Expected commitmentBytes to be 48 bytes"); expect(() => verifyKzgProof( commitmentValidLength, fieldElementBadLength, fieldElementValidLength, proofValidLength, ), ).toThrowError("Expected zBytes to be 32 bytes"); expect(() => verifyKzgProof( commitmentValidLength, fieldElementValidLength, fieldElementBadLength, proofValidLength, ), ).toThrowError("Expected yBytes to be 32 bytes"); expect(() => verifyKzgProof( commitmentValidLength, fieldElementValidLength, fieldElementValidLength, proofBadLength, ), ).toThrowError("Expected proofBytes to be 48 bytes"); }); }); describe("edge cases for verifyBlobKzgProof", () => { it("correct blob/commitment/proof should verify as true", () => { let blob = generateRandomBlob(); let commitment = blobToKzgCommitment(blob); let proof = computeBlobKzgProof(blob, commitment); expect(verifyBlobKzgProof(blob, commitment, proof)).toBe(true); }); it("incorrect commitment should verify as false", () => { let blob = generateRandomBlob(); let commitment = blobToKzgCommitment(generateRandomBlob()); let proof = computeBlobKzgProof(blob, commitment); expect(verifyBlobKzgProof(blob, commitment, proof)).toBe(false); }); it("incorrect proof should verify as false", () => { let blob = generateRandomBlob(); let commitment = blobToKzgCommitment(blob); let randomBlob = generateRandomBlob(); let randomCommitment = blobToKzgCommitment(randomBlob); let proof = computeBlobKzgProof(randomBlob, randomCommitment); expect(verifyBlobKzgProof(blob, commitment, proof)).toBe(false); }); it("throws as expected when given an argument of invalid length", () => { expect(() => verifyBlobKzgProof( blobBadLength, commitmentValidLength, proofValidLength, ), ).toThrowError("Expected blob to be 131072 bytes"); expect(() => verifyBlobKzgProof( blobValidLength, commitmentBadLength, proofValidLength, ), ).toThrowError("Expected commitmentBytes to be 48 bytes"); expect(() => verifyBlobKzgProof( blobValidLength, commitmentValidLength, proofBadLength, ), ).toThrowError("Expected proofBytes to be 48 bytes"); }); }); describe("edge cases for verifyBlobKzgProofBatch", () => { it("should reject non-array args", () => { expect(() => verifyBlobKzgProofBatch( 2 as unknown as Uint8Array[], [commitmentValidLength, commitmentValidLength], [proofValidLength, proofValidLength], ), ).toThrowError("blobs, commitments, and proofs must all be arrays"); }); it("should reject non-bytearray blob", () => { expect(() => verifyBlobKzgProofBatch( ["foo", "bar"] as unknown as Uint8Array[], [commitmentValidLength, commitmentValidLength], [proofValidLength, proofValidLength], ), ).toThrowError("Expected blob to be a Uint8Array"); }); it("throws as expected when given an argument of invalid length", () => { expect(() => verifyBlobKzgProofBatch( [blobBadLength, blobValidLength], [commitmentValidLength, commitmentValidLength], [proofValidLength, proofValidLength], ), ).toThrowError("Expected blob to be 131072 bytes"); expect(() => verifyBlobKzgProofBatch( [blobValidLength, blobValidLength], [commitmentBadLength, commitmentValidLength], [proofValidLength, proofValidLength], ), ).toThrowError("Expected commitmentBytes to be 48 bytes"); expect(() => verifyBlobKzgProofBatch( [blobValidLength, blobValidLength], [commitmentValidLength, commitmentValidLength], [proofValidLength, proofBadLength], ), ).toThrowError("Expected proofBytes to be 48 bytes"); }); it("zero blobs/commitments/proofs should verify as true", () => { expect(verifyBlobKzgProofBatch([], [], [])).toBe(true); }); it("mismatching blobs/commitments/proofs should throw error", () => { let count = 3; let blobs = new Array(count); let commitments = new Array(count); let proofs = new Array(count); for (let [i] of blobs.entries()) { blobs[i] = generateRandomBlob(); commitments[i] = blobToKzgCommitment(blobs[i]); proofs[i] = computeBlobKzgProof(blobs[i], commitments[i]); } expect(verifyBlobKzgProofBatch(blobs, commitments, proofs)).toBe(true); expect(() => verifyBlobKzgProofBatch(blobs.slice(0, 1), commitments, proofs), ).toThrowError("requires equal number of blobs/commitments/proofs"); expect(() => verifyBlobKzgProofBatch(blobs, commitments.slice(0, 1), proofs), ).toThrowError("requires equal number of blobs/commitments/proofs"); expect(() => verifyBlobKzgProofBatch(blobs, commitments, proofs.slice(0, 1)), ).toThrowError("requires equal number of blobs/commitments/proofs"); }); }); });