@vlayer/sdk 0.1.0-nightly-20241210-34a8354 → 0.1.0-nightly-20241210-eb73222

package/dist/api/email/preverify.test.js

@@ -1,109 +0,0 @@
-import { describe, expect, test } from "vitest";
-import { readFile } from "../../testHelpers/readFile.js";
-import { findIndicesOfMatchingDomains, preverifyEmail } from "./preverify.js";
-const rawEmail = readFile("./src/api/email/testdata/test_email.txt");
-describe("Preverify email: integration", () => {
-    test("adds dns record to email mime", async () => {
-        const preverifiedEmail = await preverifyEmail(rawEmail);
-        expect(preverifiedEmail).toMatchObject({
-            email: rawEmail,
-            dnsRecords: [expect.stringContaining("v=DKIM1; k=rsa; p=")],
-        });
-    });
-    test("throws error if DKIM not found", async () => {
-        const emailWithNoDkimHeader = 'From: "Alice"\n\nBody';
-        await expect(preverifyEmail(emailWithNoDkimHeader)).rejects.toThrow("No DKIM header found");
-    });
-    test("throws error if DNS could not be resolved", async () => {
-        const emailWithNoDkimHeader = readFile("./src/api/email/testdata/test_email_unknown_domain.txt");
-        await expect(preverifyEmail(emailWithNoDkimHeader)).rejects.toThrow();
-    });
-    describe("multiple DKIM headers", () => {
-        function addDkimWithDomain(domain, email) {
-            return `DKIM-Signature: v=1; a=rsa-sha256; d=${domain};
- s=selector; c=relaxed/relaxed; q=dns/txt; bh=; h=From:Subject:Date:To; b=
-${email}`;
-        }
-        function addFakeDkimWithDomain(domain, email) {
-            return `X-${addDkimWithDomain(domain, email)}`;
-        }
-        test("looks for DKIM header with the domain matching the sender and removes all other DKIM headers", async () => {
-            const emailWithAddedHeaders = [
-                "example.com",
-                "hello.kitty",
-                "google.com",
-            ].reduce((email, domain) => addDkimWithDomain(domain, email), rawEmail);
-            const email = await preverifyEmail(emailWithAddedHeaders);
-            expect(email.email
-                .startsWith(`X-DKIM-Signature: v=1; a=rsa-sha256; d=google.com;
- s=selector; c=relaxed/relaxed; q=dns/txt; bh=; h=From:Subject:Date:To; b=
-X-DKIM-Signature: v=1; a=rsa-sha256; d=hello.kitty;
- s=selector; c=relaxed/relaxed; q=dns/txt; bh=; h=From:Subject:Date:To; b=
-DKIM-Signature: v=1; a=rsa-sha256; d=example.com;
- s=selector; c=relaxed/relaxed; q=dns/txt; bh=; h=From:Subject:Date:To; b=
-X-DKIM-Signature: a=rsa-sha256; bh=2jUSOH9NhtVGCQWNr9BrIAPreKQjO6Sn7XIkfJVOzv8=;\r
- c=simple/simple; d=google.com;`)).toBeTruthy();
-            expect(email.dnsRecords).toStrictEqual(["v=DKIM1; p="]);
-        });
-        test("throws error if no DNS record domain matches the sender", async () => {
-            const emailWithAddedHeaders = addDkimWithDomain("otherdomain.com", rawEmail);
-            await expect(preverifyEmail(emailWithAddedHeaders)).rejects.toThrow("Found 0 DKIM headers matching the sender domain");
-        });
-        test("throws error if multiple DNS record domains match the sender", async () => {
-            let emailWithAddedHeaders = addDkimWithDomain("example.com", rawEmail);
-            emailWithAddedHeaders = addDkimWithDomain("example.com", emailWithAddedHeaders);
-            await expect(preverifyEmail(emailWithAddedHeaders)).rejects.toThrow("Found 2 DKIM headers matching the sender domain");
-        });
-        test("ignores x-dkim-signature headers", async () => {
-            const emailWithPrefixedDkim = addDkimWithDomain("example.com", addFakeDkimWithDomain("example.com", rawEmail));
-            const email = await preverifyEmail(emailWithPrefixedDkim);
-            expect(email.email
-                .startsWith(`DKIM-Signature: v=1; a=rsa-sha256; d=example.com;
- s=selector; c=relaxed/relaxed; q=dns/txt; bh=; h=From:Subject:Date:To; b=
-X-DKIM-Signature: v=1; a=rsa-sha256; d=example.com;
- s=selector; c=relaxed/relaxed; q=dns/txt; bh=; h=From:Subject:Date:To; b=
-X-DKIM-Signature: a=rsa-sha256; bh=2jUSOH9NhtVGCQWNr9BrIAPreKQjO6Sn7XIkfJVOzv8=;\r
- c=simple/simple; d=google.com;`)).toBeTruthy();
-        });
-        test("ignores dkim-signature somewhere inside a header", async () => {
-            const headerWithDkim = `WTF-IS-THIS-HEADER: DKIM-SIGNATURE;`;
-            const emailWithDkimInHeader = `${headerWithDkim}\n${addDkimWithDomain("example.com", rawEmail)}`;
-            const email = await preverifyEmail(emailWithDkimInHeader);
-            expect(email.email.startsWith(`WTF-IS-THIS-HEADER: DKIM-SIGNATURE;
-DKIM-Signature: v=1; a=rsa-sha256; d=example.com;
- s=selector; c=relaxed/relaxed; q=dns/txt; bh=; h=From:Subject:Date:To; b=
-X-DKIM-Signature: a=rsa-sha256; bh=2jUSOH9NhtVGCQWNr9BrIAPreKQjO6Sn7XIkfJVOzv8=;\r
- c=simple/simple; d=google.com;`)).toBeTruthy();
-        });
-        test("ignores dkim-signature somewhere inside a body", async () => {
-            const emailWithAddedDkim = addDkimWithDomain("example.com", rawEmail);
-            const emailWithDkimsInBody = `${emailWithAddedDkim}\ndkim-signature   dkim-signature\r\ndkim-signature`;
-            const email = await preverifyEmail(emailWithDkimsInBody);
-            expect(email.email
-                .startsWith(`DKIM-Signature: v=1; a=rsa-sha256; d=example.com;
- s=selector; c=relaxed/relaxed; q=dns/txt; bh=; h=From:Subject:Date:To; b=
-X-DKIM-Signature: a=rsa-sha256; bh=2jUSOH9NhtVGCQWNr9BrIAPreKQjO6Sn7XIkfJVOzv8=;\r
- c=simple/simple; d=google.com;`)).toBeTruthy();
-            expect(email.email.endsWith(`\ndkim-signature   dkim-signature\r\ndkim-signature`)).toBeTruthy();
-        });
-    });
-});
-describe("findIndicesOfMatchingDomains", () => {
-    test("returns indices of matching domains", () => {
-        const signers = [
-            { domain: "example.com", selector: "selector1" },
-            { domain: "other.other", selector: "selector2" },
-            { domain: "example.com", selector: "selector3" },
-        ];
-        expect(findIndicesOfMatchingDomains(signers, "example.com")).toStrictEqual([
-            0, 2,
-        ]);
-    });
-    test("returns empty array if no matching domains", () => {
-        const signers = [
-            { domain: "example.com", selector: "selector1" },
-            { domain: "example.org", selector: "selector2" },
-        ];
-        expect(findIndicesOfMatchingDomains(signers, "other.other")).toStrictEqual([]);
-    });
-});

package/dist/api/lib/client.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/api/lib/client.test.js

@@ -1,108 +0,0 @@
-import { describe, expect, it, vi, beforeEach, beforeAll, } from "vitest";
-import { createExtensionWebProofProvider } from "../webProof/index.js";
-import { createVlayerClient } from "./client.js";
-import { ZkProvingStatus } from "src/web-proof-commons";
-import createFetchMock from "vitest-fetch-mock";
-const fetchMocker = createFetchMock(vi);
-fetchMocker.enableMocks();
-beforeEach(() => {
-    global.chrome = {
-        runtime: {
-            sendMessage: vi.fn(),
-            connect: vi.fn().mockImplementation(() => {
-                return {
-                    onMessage: {
-                        addListener: vi.fn(),
-                    },
-                    postMessage: vi.fn(),
-                };
-            }),
-        },
-    };
-});
-function generateRandomHash() {
-    let hash = "0x";
-    for (let i = 0; i < 40; ++i) {
-        hash += Math.floor(Math.random() * 16).toString(16);
-    }
-    return hash;
-}
-describe("Success zk-proving", () => {
-    let hashStr;
-    let zkProvingSpy;
-    let vlayer;
-    beforeAll(() => {
-        hashStr = generateRandomHash();
-        const webProofProvider = createExtensionWebProofProvider();
-        zkProvingSpy = vi.spyOn(webProofProvider, "notifyZkProvingStatus");
-        vlayer = createVlayerClient({ webProofProvider });
-    });
-    it("should send message to extension that zkproving started", async () => {
-        fetchMocker.mockResponseOnce(() => {
-            return {
-                body: JSON.stringify({
-                    result: hashStr,
-                }),
-            };
-        });
-        const result = await vlayer.prove({
-            address: `0x${"a".repeat(40)}`,
-            functionName: "main",
-            proverAbi: [],
-            args: [],
-            chainId: 42,
-        });
-        expect(result.hash).toBe(hashStr);
-        expect(zkProvingSpy).toBeCalledTimes(2);
-        expect(zkProvingSpy).toHaveBeenNthCalledWith(1, ZkProvingStatus.Proving);
-    });
-    it("should send message to extension that zkproving is done", async () => {
-        fetchMocker.mockResponseOnce(() => {
-            return {
-                body: JSON.stringify({
-                    result: {
-                        status: "done",
-                        data: {},
-                    },
-                }),
-            };
-        });
-        const hash = { hash: hashStr };
-        await vlayer.waitForProvingResult({ hash });
-        expect(zkProvingSpy).toBeCalledTimes(2);
-        expect(zkProvingSpy).toHaveBeenNthCalledWith(2, ZkProvingStatus.Done);
-    });
-});
-describe("Failed zk-proving", () => {
-    beforeEach(() => {
-        fetchMocker.mockResponseOnce((req) => {
-            if (req.url === "http://127.0.0.1:3000/") {
-                return {
-                    status: 500,
-                };
-            }
-            return {};
-        });
-    });
-    it("should send message to extension that zkproving started and then that failed ", async () => {
-        const webProofProvider = createExtensionWebProofProvider();
-        const zkProvingSpy = vi.spyOn(webProofProvider, "notifyZkProvingStatus");
-        const vlayer = createVlayerClient({ webProofProvider });
-        try {
-            const hash = await vlayer.prove({
-                address: `0x${"a".repeat(40)}`,
-                functionName: "main",
-                proverAbi: [],
-                args: [],
-                chainId: 42,
-            });
-            await vlayer.waitForProvingResult({ hash });
-        }
-        catch (e) {
-            console.log("Error waiting for proving result", e);
-        }
-        expect(zkProvingSpy).toBeCalledTimes(2);
-        expect(zkProvingSpy).toHaveBeenNthCalledWith(1, ZkProvingStatus.Proving);
-        expect(zkProvingSpy).toHaveBeenNthCalledWith(2, ZkProvingStatus.Error);
-    });
-});

package/dist/api/utils/prefixAllButNthSubstring.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/api/utils/prefixAllButNthSubstring.test.js

@@ -1,14 +0,0 @@
-import { describe, expect, test } from "vitest";
-import { prefixAllButNthSubstring } from "./prefixAllButNthSubstring.js";
-describe("prefixAllButNthSubstring", () => {
-    test("adds 'X-' prefix to all matches except n-th (indexed from 0)", () => {
-        const str = "abc 123 abc 456 abc 789";
-        expect(prefixAllButNthSubstring(str, /abc/gi, 3, 0)).toBe("abc 123 X-abc 456 X-abc 789");
-        expect(prefixAllButNthSubstring(str, /abc/gi, 3, 1)).toBe("X-abc 123 abc 456 X-abc 789");
-        expect(prefixAllButNthSubstring(str, /abc/gi, 3, 2)).toBe("X-abc 123 X-abc 456 abc 789");
-    });
-    test("does not add prefix to substrings past total substring count", () => {
-        const str = "abc 123 abc 456 abc 789 abc abc";
-        expect(prefixAllButNthSubstring(str, /abc/gi, 3, 1)).toBe("X-abc 123 abc 456 X-abc 789 abc abc");
-    });
-});

package/dist/api/utils/versions.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/api/utils/versions.test.js

@@ -1,39 +0,0 @@
-import { describe, test, expect } from "vitest";
-import { checkVersionCompatibility } from "./versions.js";
-describe("versions compatibility", () => {
-    test("throws if major version mismatches", () => {
-        expect(() => {
-            checkVersionCompatibility("1.2.3", "2.1.3");
-        }).toThrowError("SDK version 2.1.3 is incompatible with prover version 1.2.3");
-    });
-    test("throws if major version mismatches with metadata after dash", () => {
-        expect(() => {
-            checkVersionCompatibility("1.2.3-dev-123456-deadbeef", "2.1.3");
-        }).toThrowError("SDK version 2.1.3 is incompatible with prover version 1.2.3-dev-123456-deadbeef");
-    });
-    test("throws if major version is 0 and minor version mismatches", () => {
-        expect(() => {
-            checkVersionCompatibility("0.2.3", "0.1.3");
-        }).toThrowError("SDK version 0.1.3 is incompatible with prover version 0.2.3");
-    });
-    test("does not throw if major and minor versions match", () => {
-        expect(() => {
-            checkVersionCompatibility("1.2.3", "1.2.13");
-        }).not.toThrow();
-    });
-    test("does not throw if major version is >0 and minor mismatches", () => {
-        expect(() => {
-            checkVersionCompatibility("1.2.3", "1.5.8");
-        }).not.toThrow();
-    });
-    test("does not throw if major version is 0 and minor matches", () => {
-        expect(() => {
-            checkVersionCompatibility("0.2.3", "0.2.7");
-        }).not.toThrow();
-    });
-    test("works for semvers with metadata after dash", () => {
-        expect(() => {
-            checkVersionCompatibility("0.2.3-dev-123456-deadbeef", "0.2.7");
-        }).not.toThrow();
-    });
-});

package/dist/api/webProof/providers/extension.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/api/webProof/providers/extension.test.js

@@ -1,101 +0,0 @@
-import { createExtensionWebProofProvider } from "./extension.js";
-import { describe, it, expect, vi } from "vitest";
-import { expectUrl, startPage, notarize } from "../steps/index.js";
-import { StepValidationError } from "../../../web-proof-commons/index.js";
-const chrome = {
-    runtime: {
-        disconnectCallbacks: [],
-        connect: vi.fn().mockImplementation(() => ({
-            postMessage: vi.fn().mockImplementation(() => { }),
-            onMessage: {
-                addListener: vi.fn().mockImplementation(() => { }),
-            },
-            onDisconnect: {
-                addListener: vi.fn().mockImplementation((callback) => {
-                    chrome.runtime.disconnectCallbacks.push(callback);
-                }),
-            },
-        })),
-        disconnect: vi.fn().mockImplementation(() => {
-            chrome.runtime.disconnectCallbacks.forEach((callback) => {
-                callback();
-            });
-        }),
-    },
-};
-vi.stubGlobal("chrome", chrome);
-const defaults = {
-    logoUrl: "https://example.com/logo.png",
-    proverCallCommitment: {
-        address: "0x",
-        proverAbi: [],
-        chainId: 1,
-        functionName: "test",
-        commitmentArgs: null,
-    },
-};
-const invalidUrl = "http:/example.com";
-const invalidUrlPattern = "http://+.test";
-const validUrl = "https://example.com";
-const validUrlPattern = "https://example.com/test";
-const label = "test";
-describe("ExtensionWebProofProvider", () => {
-    it("should properly validate startPage step", () => {
-        const provider = createExtensionWebProofProvider();
-        expect(() => provider.requestWebProof({
-            ...defaults,
-            steps: [startPage(invalidUrl, label)],
-        })).toThrow(StepValidationError);
-    });
-    it("should properly validate expectUrl step", () => {
-        const provider = createExtensionWebProofProvider();
-        expect(() => provider.requestWebProof({
-            ...defaults,
-            steps: [expectUrl(invalidUrlPattern, label)],
-        })).toThrow(StepValidationError);
-    });
-    it("should properly validate notarize step", () => {
-        const provider = createExtensionWebProofProvider();
-        expect(() => provider.requestWebProof({
-            ...defaults,
-            steps: [notarize(invalidUrlPattern, "GET", label)],
-        })).toThrow(StepValidationError);
-    });
-    it("successfully validates all steps", () => {
-        const provider = createExtensionWebProofProvider();
-        expect(() => provider.requestWebProof({
-            ...defaults,
-            steps: [
-                startPage(validUrl, label),
-                expectUrl(validUrlPattern, label),
-                notarize(validUrlPattern, "GET", label),
-            ],
-        })).not.toThrow(StepValidationError);
-    });
-    it("should properly work backward compatible way with only urls used", () => {
-        const provider = createExtensionWebProofProvider();
-        expect(() => provider.requestWebProof({
-            ...defaults,
-            steps: [
-                startPage(validUrl, label),
-                expectUrl(validUrl, label),
-                expectUrl(validUrl, label),
-                notarize(validUrl, "GET", label),
-            ],
-        })).not.toThrow();
-    });
-    it("should reconnect extension on disconnect", () => {
-        const provider = createExtensionWebProofProvider();
-        provider.requestWebProof({
-            ...defaults,
-            steps: [
-                startPage(validUrl, label),
-                expectUrl(validUrlPattern, label),
-                notarize(validUrlPattern, "GET", label),
-            ],
-        });
-        chrome.runtime.connect.mockClear();
-        chrome.runtime.disconnect();
-        expect(chrome.runtime.connect).toHaveBeenCalled();
-    });
-});