@vlayer/sdk 0.1.0-nightly-20241028-74b5b0d → 0.1.0-nightly-202410292-42360cf

package/src/api/email/testdata/test_email_multiple_dkims.txt

@@ -1,28 +0,0 @@
-DKIM-Signature: a=rsa-sha256; bh=2jUSOH9NhtVGCQWNr9BrIAPreKQjO6Sn7XIkfJVOzv8=;
- c=simple/simple; d=google.com;
- h=Received:From:To:Subject:Date:Message-ID; i=joe@football.example.com;
- s=20230601; t=1615825284; v=1;
- b=Xh4Ujb2wv5x54gXtulCiy4C0e+plRm6pZ4owF+kICpYzs/8WkTVIDBrzhJP0DAYCpnL62T0G
- k+0OH8pi/yqETVjKtKk+peMnNvKkut0GeWZMTze0bfq3/JUK3Ln3jTzzpXxrgVnvBxeY9EZIL4g
- s4wwFRRKz/1bksZGSjD8uuSU=
-DKIM-Signature: a=rsa-sha256; bh=2jUSOH9NhtVGCQWNr9BrIAPreKQjO6Sn7XIkfJVOzv8=;
- c=simple/simple; d=google.com;
- h=Received:From:To:Subject:Date:Message-ID; i=joe@football.example.com;
- s=20230601; t=1615825284; v=1;
- b=Xh4Ujb2wv5x54gXtulCiy4C0e+plRm6pZ4owF+kICpYzs/8WkTVIDBrzhJP0DAYCpnL62T0G
- k+0OH8pi/yqETVjKtKk+peMnNvKkut0GeWZMTze0bfq3/JUK3Ln3jTzzpXxrgVnvBxeY9EZIL4g
- s4wwFRRKz/1bksZGSjD8uuSU=
-Received: from client1.football.example.com  [192.0.2.1]
-      by submitserver.example.com with SUBMISSION;
-      Fri, 11 Jul 2003 21:01:54 -0700 (PDT)
-From: Joe SixPack <joe@football.example.com>
-To: Suzie Q <suzie@shopping.example.net>
-Subject: Is dinner ready?
-Date: Fri, 11 Jul 2003 21:00:37 -0700 (PDT)
-Message-ID: <20030712040037.46341.5F8J@football.example.com>
-
-Hi.
-
-We lost the game. Are you hungry yet?
-
-Joe.

package/src/api/email/testdata/test_email_unknown_domain.txt

@@ -1,21 +0,0 @@
-DKIM-Signature: a=rsa-sha256; bh=2jUSOH9NhtVGCQWNr9BrIAPreKQjO6Sn7XIkfJVOzv8=;
- c=simple/simple; d=foobar.xyz;
- h=Received:From:To:Subject:Date:Message-ID; i=joe@football.example.com;
- s=wertyu; t=1615825284; v=1;
- b=Xh4Ujb2wv5x54gXtulCiy4C0e+plRm6pZ4owF+kICpYzs/8WkTVIDBrzhJP0DAYCpnL62T0G
- k+0OH8pi/yqETVjKtKk+peMnNvKkut0GeWZMTze0bfq3/JUK3Ln3jTzzpXxrgVnvBxeY9EZIL4g
- s4wwFRRKz/1bksZGSjD8uuSU=
-Received: from client1.football.example.com  [192.0.2.1]
-      by submitserver.example.com with SUBMISSION;
-      Fri, 11 Jul 2003 21:01:54 -0700 (PDT)
-From: Joe SixPack <joe@football.example.com>
-To: Suzie Q <suzie@shopping.example.net>
-Subject: Is dinner ready?
-Date: Fri, 11 Jul 2003 21:00:37 -0700 (PDT)
-Message-ID: <20030712040037.46341.5F8J@football.example.com>
-
-Hi.
-
-We lost the game. Are you hungry yet?
-
-Joe.

package/src/api/helpers.ts

@@ -1,173 +0,0 @@
-import {
-  type Abi,
-  Account,
-  type Address,
-  type Chain,
-  type ContractFunctionArgs,
-  type ContractFunctionName,
-  createTestClient,
-  type Hex,
-  http,
-  HttpTransport,
-  publicActions,
-  PublicClient,
-  walletActions,
-  WriteContractParameters,
-} from "viem";
-
-import { privateKeyToAccount, generatePrivateKey } from "viem/accounts";
-import { foundry } from "viem/chains";
-
-import type { ContractSpec, ContractArg } from "types/ethereum";
-
-const rpcUrls: Map<number, HttpTransport> = new Map([[foundry.id, http()]]);
-
-export const chainIds = [foundry.id];
-
-export function createAnvilClient(
-  chainId: number = foundry.id,
-): ReturnType<typeof walletActions> & PublicClient {
-  const transport = rpcUrls.get(chainId);
-  if (transport == undefined) {
-    throw Error(`No url for chainId ${chainId}`);
-  }
-
-  return createTestClient({
-    chain: foundry,
-    mode: "anvil",
-    transport: transport,
-  })
-    .extend(publicActions)
-    .extend(walletActions);
-}
-
-export async function deployContract(
-  contractSpec: ContractSpec,
-  args: ContractArg[] = [],
-  chainId: number = foundry.id,
-): Promise<Address> {
-  const ethClient = createAnvilClient(chainId);
-
-  const [deployer] = await ethClient.getAddresses();
-
-  const txHash = await ethClient.deployContract({
-    abi: contractSpec.abi,
-    bytecode: contractSpec.bytecode.object,
-    account: deployer,
-    args,
-    chain: foundry,
-  });
-
-  const receipt = await ethClient.waitForTransactionReceipt({ hash: txHash });
-
-  if (receipt.status != "success") {
-    throw new Error(
-      `Contract deployment failed with status: ${receipt.status}`,
-    );
-  }
-
-  return receipt.contractAddress as Address;
-}
-
-type DeploySpec<T extends Abi> = {
-  abi: T;
-  bytecode: {
-    object: Hex;
-  };
-};
-
-type Tail<T> = T extends readonly [unknown, ...infer U] ? U : [];
-
-export async function deployProverVerifier<P extends Abi, V extends Abi>(
-  proverSpec: DeploySpec<P>,
-  verifierSpec: DeploySpec<V>,
-  args: {
-    prover?: ContractArg[];
-    verifier?: Tail<ContractArg>[];
-  } = {},
-  chainId: number = foundry.id,
-) {
-  console.log("Deploying prover");
-  const proverAddress = await deployContract(
-    proverSpec,
-    args.prover ?? [],
-    chainId,
-  );
-  console.log(`Prover has been deployed on ${proverAddress} address`);
-
-  console.log("Deploying verifier");
-  const verifierAddress = await deployContract(
-    verifierSpec,
-    [proverAddress, ...(args.verifier ?? [])],
-    chainId,
-  );
-  console.log(`Verifier has been deployed on ${verifierAddress} address`);
-
-  return [proverAddress, verifierAddress];
-}
-
-export async function call<
-  T extends Abi,
-  F extends ContractFunctionName<T, "pure" | "view">,
->(
-  abi: T,
-  address: Address,
-  functionName: F,
-  args?: ContractFunctionArgs<T, "pure" | "view", F>,
-  chainId: number = foundry.id,
-) {
-  const ethClient = createAnvilClient(chainId);
-
-  return ethClient.readContract({
-    abi,
-    address,
-    functionName,
-    args,
-  });
-}
-
-export async function writeContract<
-  T extends Abi,
-  F extends ContractFunctionName<T, "payable" | "nonpayable">,
->(
-  address: Address,
-  abi: T,
-  functionName: F,
-  args: ContractFunctionArgs<T, "payable" | "nonpayable", F>,
-  sender?: Address,
-  chain: Chain = foundry,
-) {
-  const ethClient = createAnvilClient(chain.id);
-  const selectedSender = sender || (await ethClient.getAddresses())[0];
-
-  const txHash = await ethClient.writeContract({
-    address,
-    abi: abi as Abi,
-    functionName,
-    args: args as readonly unknown[],
-    chain,
-    account: selectedSender,
-    chainOverride: undefined,
-  } as WriteContractParameters<
-    Abi,
-    ContractFunctionName<Abi, "nonpayable" | "payable">,
-    ContractFunctionArgs<Abi, "nonpayable" | "payable", F>,
-    Chain | undefined,
-    Account | undefined,
-    Chain | undefined
-  >);
-
-  const txReceipt = await ethClient.waitForTransactionReceipt({ hash: txHash });
-
-  if (txReceipt.status != "success") {
-    throw new Error(`Transaction failed with status: ${txReceipt.status}`);
-  }
-
-  return txReceipt;
-}
-
-export const getTestAccount = () => privateKeyToAccount(generatePrivateKey());
-
-export const getTestAddresses = (
-  chainId: number = foundry.id,
-): Promise<Address[]> => createAnvilClient(chainId).getAddresses();

package/src/api/lib/client.ts

@@ -1,76 +0,0 @@
-import { VCallResponse, VlayerClient } from "types/vlayer";
-import { WebProofProvider } from "types/webProofProvider";
-
-import { prove } from "../prover";
-import { createExtensionWebProofProvider } from "../webProof";
-import { type Abi, decodeFunctionResult } from "viem";
-
-function dropEmptyProofFromArgs(args: unknown) {
-  if (Array.isArray(args)) {
-    return args.slice(1) as unknown[];
-  }
-  return [];
-}
-
-function generateRandomHash() {
-  let hash = "0x";
-  for (let i = 0; i < 40; ++i) {
-    hash += Math.floor(Math.random() * 16).toString(16);
-  }
-  return hash;
-}
-
-export const createVlayerClient = (
-  {
-    url = "http://127.0.0.1:3000",
-    webProofProvider = createExtensionWebProofProvider(),
-  }: {
-    url?: string;
-    webProofProvider?: WebProofProvider;
-  } = {
-    url: "http://127.0.0.1:3000",
-    webProofProvider: createExtensionWebProofProvider(),
-  },
-): VlayerClient => {
-  console.log("createVlayerClient with", url, webProofProvider);
-  const resultHashMap = new Map<
-    string,
-    [Promise<VCallResponse>, Abi, string]
-  >();
-
-  return {
-    // eslint-disable-next-line @typescript-eslint/require-await
-    prove: async ({ address, functionName, chainId, proverAbi, args }) => {
-      const result_promise = prove(
-        address,
-        proverAbi,
-        functionName,
-        args,
-        chainId,
-        url,
-      );
-      const hash = generateRandomHash();
-      resultHashMap.set(hash, [result_promise, proverAbi, functionName]);
-      return { hash };
-    },
-    waitForProvingResult: async ({ hash }) => {
-      const savedProvingData = resultHashMap.get(hash);
-      if (!savedProvingData) {
-        throw new Error("No result found for hash " + hash);
-      }
-      const {
-        result: { proof, evm_call_result },
-      } = await savedProvingData[0];
-
-      const result = dropEmptyProofFromArgs(
-        decodeFunctionResult({
-          abi: savedProvingData[1],
-          data: evm_call_result,
-          functionName: savedProvingData[2],
-        }),
-      );
-
-      return [proof, ...result];
-    },
-  };
-};

package/src/api/lib/types/ethereum.ts

@@ -1,43 +0,0 @@
-import { Abi, Address, Hex } from "viem";
-import { Branded } from "../../../web-proof-commons";
-
-export type Bytecode = {
-  object: Hex;
-};
-
-export type ContractSpec = {
-  abi: Abi;
-  bytecode: Bytecode;
-};
-
-export type ContractArg =
-  | number
-  | string
-  | boolean
-  | bigint
-  | number[]
-  | string[]
-  | boolean[]
-  | bigint[]
-  | Address[];
-
-export type EthereumAddress = Branded<Hex, "EthereumAddress">;
-export type EthereumTxHash = Branded<Hex, "EthereumTxHash">;
-
-export function assertEthereumAddress(
-  hash: string,
-): asserts hash is EthereumAddress {
-  const regex = /^(0x)?[0-9a-fA-F]{40}$/;
-  if (!regex.test(hash)) {
-    throw new Error(`Invalid ethereum account ${hash}`);
-  }
-}
-
-export function assertEthereumTxHash(
-  hash: string,
-): asserts hash is EthereumTxHash {
-  const regex = /^(0x)?[0-9a-fA-F]{64}$/;
-  if (!regex.test(hash)) {
-    throw new Error(`Invalid ethereum tx hash ${hash}`);
-  }
-}

package/src/api/lib/types/viem.ts

@@ -1,28 +0,0 @@
-import { Abi, ContractFunctionName } from "viem";
-import { AbiParametersToPrimitiveTypes, ExtractAbiFunction } from "abitype";
-
-type Without<T extends readonly unknown[], P> = T extends readonly [
-  infer F,
-  ...infer R,
-]
-  ? F extends P
-    ? Without<R, P>
-    : readonly [F, ...Without<R, P>]
-  : [];
-
-export type ContractFunctionArgsWithout<
-  abi extends Abi,
-  functionName extends ContractFunctionName<abi>,
-  without,
-> =
-  AbiParametersToPrimitiveTypes<
-    Without<
-      ExtractAbiFunction<abi extends Abi ? abi : Abi, functionName>["inputs"],
-      without
-    >,
-    "inputs"
-  > extends infer args
-    ? [args] extends [never]
-      ? readonly unknown[]
-      : args
-    : readonly unknown[];

package/src/api/lib/types/vlayer.ts

@@ -1,60 +0,0 @@
-import {
-  Abi,
-  AbiStateMutability,
-  Address,
-  ContractFunctionArgs,
-  ContractFunctionName,
-  Hex,
-} from "viem";
-
-type Calldata = string;
-
-export type CallParams = {
-  to: Address;
-  data: Calldata;
-};
-
-export type CallContext = {
-  chain_id: number; // 31337
-};
-
-export type Proof = {
-  length: bigint;
-  seal: {
-    verifierSelector: Hex;
-    seal: readonly [Hex, Hex, Hex, Hex, Hex, Hex, Hex, Hex];
-    mode: number;
-  };
-  callAssumptions: {
-    proverContractAddress: Address;
-    functionSelector: Hex;
-    settleBlockHash: Hex;
-    settleBlockNumber: bigint;
-  };
-};
-
-export interface VCallResult {
-  evm_call_result: Hex;
-  proof: Proof;
-}
-
-export interface VCallResponse {
-  jsonrpc: string;
-  result: VCallResult;
-  id: number;
-}
-
-export type VlayerClient = {
-  prove: <T extends Abi, F extends ContractFunctionName<T>>(args: {
-    address: Hex;
-    proverAbi: T;
-    functionName: F;
-    chainId: number;
-    args: ContractFunctionArgs<T, AbiStateMutability, F>;
-  }) => Promise<{ hash: string }>;
-  waitForProvingResult: ({
-    hash,
-  }: {
-    hash: string;
-  }) => Promise<[Proof, ...unknown[]]>;
-};

package/src/api/lib/types/webProofProvider.ts

@@ -1,44 +0,0 @@
-import { Hex, Abi, ContractFunctionName } from "viem";
-import type { ContractFunctionArgsWithout } from "./viem";
-import { Branded, WebProof, WebProofStep } from "../../../web-proof-commons";
-
-export type WebProofSetupInput = {
-  logoUrl: string;
-  steps: WebProofStep[];
-};
-
-export type WebProofSetup = Branded<
-  WebProofSetupInput & {
-    isWebProof: true;
-  },
-  "webProof"
->;
-
-export type ProverCallCommitment<
-  T extends Abi,
-  F extends ContractFunctionName<T>,
-> = {
-  address: Hex;
-  proverAbi: T;
-  functionName: F;
-  commitmentArgs: ContractFunctionArgsWithout<T, F, { name: "webProof" }>;
-  chainId: number;
-};
-
-export type GetWebProofArgs<
-  T extends Abi,
-  F extends ContractFunctionName<T>,
-> = {
-  proverCallCommitment: ProverCallCommitment<T, F>;
-} & WebProofSetupInput;
-
-export type WebProofProvider = {
-  getWebProof: <T extends Abi, F extends ContractFunctionName<T>>(
-    args: GetWebProofArgs<T, F>,
-  ) => Promise<WebProof>;
-};
-
-export type WebProofProviderSetup = {
-  notaryUrl?: string;
-  wsProxyUrl?: string;
-};

package/src/api/prover.ts

@@ -1,34 +0,0 @@
-import {
-  type Abi,
-  AbiStateMutability,
-  type Address,
-  ContractFunctionArgs,
-  ContractFunctionName,
-  encodeFunctionData,
-} from "viem";
-
-import { type CallContext, type CallParams } from "types/vlayer";
-import { v_call } from "./v_call";
-import { foundry } from "viem/chains";
-
-export async function prove<T extends Abi, F extends ContractFunctionName<T>>(
-  prover: Address,
-  abi: T,
-  functionName: F,
-  args: ContractFunctionArgs<T, AbiStateMutability, F>,
-  chainId: number = foundry.id,
-  url: string = "http://127.0.0.1:3000",
-) {
-  const calldata = encodeFunctionData({
-    abi: abi as Abi,
-    functionName: functionName as string,
-    args: args as readonly unknown[],
-  });
-
-  const call: CallParams = { to: prover, data: calldata };
-  const context: CallContext = {
-    chain_id: chainId,
-  };
-
-  return v_call(call, context, url);
-}

package/src/api/v_call.ts

@@ -1,45 +0,0 @@
-import { CallContext, CallParams, VCallResponse } from "types/vlayer";
-
-function v_callBody(call: CallParams, context: CallContext) {
-  return {
-    method: "v_call",
-    params: [call, context],
-    id: 1,
-    jsonrpc: "2.0",
-  };
-}
-
-export async function v_call(
-  call: CallParams,
-  context: CallContext,
-  url: string = "http://127.0.0.1:3000",
-): Promise<VCallResponse> {
-  const response = await fetch(url, {
-    method: "POST",
-    body: JSON.stringify(v_callBody(call, context)),
-    headers: { "Content-Type": "application/json" },
-  });
-
-  if (!response.ok) {
-    throw new Error(`HTTP error! status: ${response.status}`);
-  }
-
-  const response_json = await response.json();
-
-  //TODO we should launch some schema validation here
-  assertObject(response_json);
-
-  if ("error" in response_json) {
-    throw new Error(
-      `Error response: ${(response_json.error as { message: string }).message || "unknown error"}`,
-    );
-  }
-
-  return response_json as Promise<VCallResponse>;
-}
-
-function assertObject(x: unknown): asserts x is object {
-  if (typeof x !== "object") {
-    throw new Error("Expected object");
-  }
-}

package/src/api/webProof/createWebProof.ts

@@ -1,9 +0,0 @@
-import { WebProofSetup, WebProofSetupInput } from "types/webProofProvider.ts";
-
-export const createWebProof = ({ logoUrl, steps }: WebProofSetupInput) => {
-  return {
-    logoUrl,
-    steps,
-    isWebProof: true,
-  } as WebProofSetup;
-};

package/src/api/webProof/providers/extension.ts

@@ -1,72 +0,0 @@
-import {
-  type WebProofProvider,
-  type WebProofProviderSetup,
-  type WebProofSetupInput,
-} from "../../lib/types/webProofProvider";
-
-import {
-  ExtensionAction,
-  type ExtensionMessage,
-  ExtensionMessageType,
-  type MessageToExtension,
-  WebProof,
-} from "../../../web-proof-commons";
-
-// NOTE @types/chrome and webextension-polyfill work only in the extension context
-// and looks that there is no community driven package providing typings for chrome.runtime
-// or polyfill logic for the browser APIs available in the browser context
-// we intentionally use chrome here instead of browser as we support only chrome for now
-// and there could be some differences in the API between browsers
-
-declare const chrome: {
-  runtime: {
-    sendMessage: (
-      extensionId: string | undefined,
-      message: MessageToExtension,
-    ) => void;
-    connect: (extensionId: string) => {
-      onMessage: {
-        addListener: (message: unknown) => void;
-      };
-    };
-  };
-};
-
-// this id is fixed in the extension by the key in manifest.json
-const EXTENSION_ID = "jbchhcgphfokabmfacnkafoeeeppjmpl";
-
-export const createExtensionWebProofProvider = (
-  {
-    notaryUrl = "https://notary.pse.dev/v0.1.0-alpha.5/",
-    wsProxyUrl = "wss://notary.pse.dev/proxy",
-  }: WebProofProviderSetup = {
-    notaryUrl: "https://notary.pse.dev/v0.1.0-alpha.5/",
-    wsProxyUrl: "wss://notary.pse.dev/proxy",
-  },
-): WebProofProvider => {
-  return {
-    getWebProof: async function (webProofSetup: WebProofSetupInput) {
-      return new Promise<WebProof>((resolve, reject) => {
-        chrome.runtime.sendMessage(EXTENSION_ID, {
-          action: ExtensionAction.RequestWebProof,
-          payload: {
-            notaryUrl,
-            wsProxyUrl,
-            logoUrl: webProofSetup.logoUrl,
-            steps: webProofSetup.steps,
-          },
-        });
-        const port = chrome.runtime.connect(EXTENSION_ID);
-        // TODO: validate message in runtime
-        port.onMessage.addListener((message: ExtensionMessage) => {
-          if (message.type === ExtensionMessageType.ProofDone) {
-            resolve(message.proof);
-          }
-          if (message.type === ExtensionMessageType.ProofError) {
-            reject(new Error(message.error));
-          }
-        });
-      });
-    },
-  };
-};

package/src/api/webProof/steps/expectUrl.ts

@@ -1,12 +0,0 @@
-import {
-  EXTENSION_STEP,
-  WebProofStepExpectUrl,
-} from "../../../web-proof-commons";
-
-export const expectUrl = (url: string, label: string) => {
-  return {
-    url,
-    label,
-    step: EXTENSION_STEP.expectUrl,
-  } as WebProofStepExpectUrl;
-};

package/src/api/webProof/steps/index.ts

@@ -1,11 +0,0 @@
-import { expectUrl } from "./expectUrl.ts";
-import { startPage } from "./startPage.ts";
-import { notarize } from "./notarize.ts";
-
-const steps = {
-  expectUrl,
-  startPage,
-  notarize,
-};
-
-export { expectUrl, startPage, notarize, steps };

package/src/api/webProof/steps/notarize.ts

@@ -1,17 +0,0 @@
-import {
-  EXTENSION_STEP,
-  WebProofStepNotarize,
-} from "../../../web-proof-commons";
-
-export const notarize = (
-  url: string,
-  method: string = "GET",
-  label: string,
-) => {
-  return {
-    url,
-    method,
-    label,
-    step: EXTENSION_STEP.notarize,
-  } as WebProofStepNotarize;
-};

package/src/api/webProof/steps/startPage.ts

@@ -1,12 +0,0 @@
-import {
-  EXTENSION_STEP,
-  WebProofStepStartPage,
-} from "../../../web-proof-commons";
-
-export const startPage = (url: string, label: string) => {
-  return {
-    url,
-    label,
-    step: EXTENSION_STEP.startPage,
-  } as WebProofStepStartPage;
-};