@vlayer/sdk 0.1.0-nightly-20241009-c348db7 → 0.1.0-nightly-20241011-0d0e255

package/package.json

@@ -2,7 +2,7 @@
   "name": "@vlayer/sdk",
   "type": "module",
   "module": "src/index.ts",
-  "version": "0.1.0-nightly-20241009-c348db7",
+  "version": "0.1.0-nightly-20241011-0d0e255",
   "types": "src/index.ts",
   "scripts": {
     "build": "npm run gen:types",

package/src/api/lib/client.ts

@@ -1,8 +1,25 @@
-import { VlayerClient } from "types/vlayer";
+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 dropProofFromArgs(args: unknown) {
+  if (Array.isArray(args)) {
+    return args.slice(1);
+  }
+  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",
@@ -17,9 +34,43 @@ export const createVlayerClient = (
 ): VlayerClient => {
   // TODO : implement high level api
   console.log("createVlayerClient with", url, webProofProvider);
+  const resultHashMap = new Map<
+    string,
+    [Promise<VCallResponse>, Abi, string]
+  >();
+
   return {
     prove: async ({ address, functionName, chainId, proverAbi, args }) => {
-      return prove(address, proverAbi, functionName, args, chainId, url);
+      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 = dropProofFromArgs(
+        decodeFunctionResult({
+          abi: savedProvingData[1] as Abi,
+          data: evm_call_result,
+          functionName: savedProvingData[2] as string,
+        }),
+      );
+
+      return { proof, result };
     },
   };
 };

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

@@ -1,5 +1,5 @@
 import { Abi, Address, Hex } from "viem";
-import { Branded } from "./utils";
+import { Branded } from "@vlayer/web-proof-commons";
 export type Bytecode = {
   object: Hex;
 };

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

@@ -1,5 +1,4 @@
 export * from "./ethereum";
-export * from "./webProof";
-export * from "./utils";
+export * from "@vlayer/web-proof-commons/lib/types/webProof";
 export * from "./vlayer";
 export * from "./webProofProvider";

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

@@ -66,7 +66,12 @@ export type VlayerClient = {
     F extends ContractFunctionName<T>,
   >(
     args: VlayerClientProveArgs<T, F>,
-  ) => void;
+  ) => Promise<{ hash: string }>;
+  waitForProvingResult: ({
+    hash,
+  }: {
+    hash: string;
+  }) => Promise<{ proof: Proof; result: unknown[] }>;
 };
 
 export type VlayerClientProveArgs<

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

@@ -1,44 +1,11 @@
-import { WebProof } from "types/webProof.ts";
 import { AbiFunction, Hex, Abi, ContractFunctionName } from "viem";
-import { Branded } from "types/utils.ts";
 import type { ContractFunctionArgsWithout } from "./viem";
-
-export const EXTENSION_STEP = {
-  expectUrl: "expectUrl",
-  startPage: "startPage",
-  notarize: "notarize",
-} as const;
-
-export type ExtensionStep =
-  (typeof EXTENSION_STEP)[keyof typeof EXTENSION_STEP];
-
-export type WebProofStepNotarize = Branded<
-  {
-    url: string;
-    method: string;
-    label: string;
-    step: typeof EXTENSION_STEP.notarize;
-  },
-  "notarize"
->;
-
-export type WebProofStepExpectUrl = Branded<
-  {
-    url: string;
-    label: string;
-    step: typeof EXTENSION_STEP.expectUrl;
-  },
-  "expectUrl"
->;
-
-export type WebProofStepStartPage = Branded<
-  {
-    url: string;
-    label: string;
-    step: typeof EXTENSION_STEP.startPage;
-  },
-  "startPage"
->;
+import {
+  Branded,
+  WebProof,
+  WebProofStepExpectUrl,
+  WebProofStepStartPage,
+} from "@vlayer/web-proof-commons";
 
 export type WebProofSetupInput = {
   logoUrl: string;
@@ -62,6 +29,7 @@ export type ProverCallCommitment<
   commitmentArgs: ContractFunctionArgsWithout<T, F, { name: "webProof" }>;
   chainId: number;
 };
+
 export type GetWebProofArgs<
   T extends readonly [AbiFunction, ...Abi[number][]],
   F extends ContractFunctionName<T>,

package/src/api/prover.ts

@@ -5,7 +5,6 @@ import {
   type Address,
   ContractFunctionArgs,
   ContractFunctionName,
-  decodeFunctionResult,
   encodeFunctionData,
 } from "viem";
 
@@ -35,16 +34,5 @@ export async function prove<
     chain_id: chainId,
   };
 
-  const {
-    result: { proof, evm_call_result },
-  } = await v_call(call, context, url);
-
-  const [, ...result] = decodeFunctionResult({
-    abi: abi as Abi,
-    data: evm_call_result,
-    functionName: functionName as string,
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  }) as any[];
-
-  return { proof, result };
+  return v_call(call, context, url);
 }

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

@@ -6,12 +6,12 @@ import {
 
 import {
   ExtensionAction,
-  ExtensionMessage,
+  type ExtensionMessage,
   ExtensionMessageType,
+  type MessageToExtension,
+  WebProof,
 } from "@vlayer/web-proof-commons";
 
-import { WebProof } from "../../lib/types/webProof";
-
 // 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
@@ -20,7 +20,10 @@ import { WebProof } from "../../lib/types/webProof";
 
 declare const chrome: {
   runtime: {
-    sendMessage: (extensionId: string | undefined, message: unknown) => void;
+    sendMessage: (
+      extensionId: string | undefined,
+      message: MessageToExtension,
+    ) => void;
     connect: (extensionId: string) => {
       onMessage: {
         addListener: (message: unknown) => void;

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

@@ -1,7 +1,7 @@
 import {
   EXTENSION_STEP,
   WebProofStepExpectUrl,
-} from "../../../api/lib/types/webProofProvider";
+} from "@vlayer/web-proof-commons";
 
 export const expectUrl = (url: string, label: string) => {
   return {

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

@@ -1,7 +1,7 @@
 import {
   EXTENSION_STEP,
   WebProofStepNotarize,
-} from "../../../api/lib/types/webProofProvider";
+} from "@vlayer/web-proof-commons";
 
 export const notarize = (
   url: string,

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

@@ -1,7 +1,7 @@
 import {
   EXTENSION_STEP,
   WebProofStepStartPage,
-} from "../../../api/lib/types/webProofProvider";
+} from "@vlayer/web-proof-commons";
 
 export const startPage = (url: string, label: string) => {
   return {

package/node_modules/@vlayer/web-proof-commons/.gitignore

@@ -1,175 +0,0 @@
-# Based on https://raw.githubusercontent.com/github/gitignore/main/Node.gitignore
-
-# Logs
-
-logs
-_.log
-npm-debug.log_
-yarn-debug.log*
-yarn-error.log*
-lerna-debug.log*
-.pnpm-debug.log*
-
-# Caches
-
-.cache
-
-# Diagnostic reports (https://nodejs.org/api/report.html)
-
-report.[0-9]_.[0-9]_.[0-9]_.[0-9]_.json
-
-# Runtime data
-
-pids
-_.pid
-_.seed
-*.pid.lock
-
-# Directory for instrumented libs generated by jscoverage/JSCover
-
-lib-cov
-
-# Coverage directory used by tools like istanbul
-
-coverage
-*.lcov
-
-# nyc test coverage
-
-.nyc_output
-
-# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
-
-.grunt
-
-# Bower dependency directory (https://bower.io/)
-
-bower_components
-
-# node-waf configuration
-
-.lock-wscript
-
-# Compiled binary addons (https://nodejs.org/api/addons.html)
-
-build/Release
-
-# Dependency directories
-
-node_modules/
-jspm_packages/
-
-# Snowpack dependency directory (https://snowpack.dev/)
-
-web_modules/
-
-# TypeScript cache
-
-*.tsbuildinfo
-
-# Optional npm cache directory
-
-.npm
-
-# Optional eslint cache
-
-.eslintcache
-
-# Optional stylelint cache
-
-.stylelintcache
-
-# Microbundle cache
-
-.rpt2_cache/
-.rts2_cache_cjs/
-.rts2_cache_es/
-.rts2_cache_umd/
-
-# Optional REPL history
-
-.node_repl_history
-
-# Output of 'npm pack'
-
-*.tgz
-
-# Yarn Integrity file
-
-.yarn-integrity
-
-# dotenv environment variable files
-
-.env
-.env.development.local
-.env.test.local
-.env.production.local
-.env.local
-
-# parcel-bundler cache (https://parceljs.org/)
-
-.parcel-cache
-
-# Next.js build output
-
-.next
-out
-
-# Nuxt.js build / generate output
-
-.nuxt
-dist
-
-# Gatsby files
-
-# Comment in the public line in if your project uses Gatsby and not Next.js
-
-# https://nextjs.org/blog/next-9-1#public-directory-support
-
-# public
-
-# vuepress build output
-
-.vuepress/dist
-
-# vuepress v2.x temp and cache directory
-
-.temp
-
-# Docusaurus cache and generated files
-
-.docusaurus
-
-# Serverless directories
-
-.serverless/
-
-# FuseBox cache
-
-.fusebox/
-
-# DynamoDB Local files
-
-.dynamodb/
-
-# TernJS port file
-
-.tern-port
-
-# Stores VSCode versions used for testing VSCode extensions
-
-.vscode-test
-
-# yarn v2
-
-.yarn/cache
-.yarn/unplugged
-.yarn/build-state.yml
-.yarn/install-state.gz
-.pnp.*
-
-# IntelliJ based IDEs
-.idea
-
-# Finder (MacOS) folder config
-.DS_Store

package/node_modules/@vlayer/web-proof-commons/README.md

@@ -1,4 +0,0 @@
-# @vlayer/web-proof-commons
-
-`web-proof-commons` is a TypeScript package that provides common type definitions and utilities shared between the 
-`browser-extension` and `@vlayer/sdk` projects.

package/node_modules/@vlayer/web-proof-commons/index.ts

@@ -1 +0,0 @@
-export * from "./lib";

package/node_modules/@vlayer/web-proof-commons/lib/index.ts

@@ -1 +0,0 @@
-export * from "./message";

package/node_modules/@vlayer/web-proof-commons/lib/message.ts

@@ -1,20 +0,0 @@
-export const enum ExtensionAction {
-  RequestWebProof,
-}
-
-export const enum ExtensionMessageType {
-  ProofDone = "ProofDone",
-  ProofError = "ProofError",
-  RedirectBack = "RedirectBack",
-}
-
-export type ExtensionMessage =
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  | { type: ExtensionMessageType.ProofDone; proof: any } // Change to WebProof
-  | { type: ExtensionMessageType.ProofError; error: string }
-  | { type: ExtensionMessageType.RedirectBack };
-
-export type WebProverSessionConfig = {
-  notaryUrl: string;
-  wsProxyUrl: string;
-};

package/node_modules/@vlayer/web-proof-commons/package.json

@@ -1,17 +0,0 @@
-{
-  "name": "@vlayer/web-proof-commons",
-  "private": true,
-  "version": "1.0.0",
-  "module": "index.ts",
-  "type": "module",
-  "scripts": {
-    "lint": "eslint lib",
-    "lint:fix": "eslint --fix lib"
-  },
-  "devDependencies": {
-    "@types/bun": "latest"
-  },
-  "peerDependencies": {
-    "typescript": "^5.0.0"
-  }
-}

package/node_modules/@vlayer/web-proof-commons/tsconfig.json

@@ -1,27 +0,0 @@
-{
-  "compilerOptions": {
-    // Enable latest features
-    "lib": ["ESNext", "DOM"],
-    "target": "ESNext",
-    "module": "ESNext",
-    "moduleDetection": "force",
-    "jsx": "react-jsx",
-    "allowJs": true,
-
-    // Bundler mode
-    "moduleResolution": "bundler",
-    "allowImportingTsExtensions": true,
-    "verbatimModuleSyntax": true,
-    "noEmit": true,
-
-    // Best practices
-    "strict": true,
-    "skipLibCheck": true,
-    "noFallthroughCasesInSwitch": true,
-
-    // Some stricter flags (disabled by default)
-    "noUnusedLocals": false,
-    "noUnusedParameters": false,
-    "noPropertyAccessFromIndexSignature": false
-  }
-}

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

@@ -1,3 +0,0 @@
-declare const __brand: unique symbol;
-type Brand<B> = { [__brand]: B };
-export type Branded<T, B> = T & Brand<B>;

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

@@ -1,111 +0,0 @@
-// NOTE : this is copied from tlsn-js 5.4
-// for some reason newest versions doesn't export this type (clarification is in progress)
-// probably it should be reexported from tlsn-js
-
-export interface WebProof {
-  session: Session;
-  substrings: Substrings;
-  notaryUrl: string;
-}
-
-export interface Session {
-  header: Header;
-  signature: Signature;
-  session_info: SessionInfo;
-}
-
-export interface SessionInfo {
-  server_name: ServerName;
-  handshake_decommitment: HandshakeDecommitment;
-}
-
-export interface HandshakeDecommitment {
-  nonce: number[];
-  data: Data;
-}
-
-export interface Data {
-  server_cert_details: ServerCERTDetails;
-  server_kx_details: ServerKxDetails;
-  client_random: number[];
-  server_random: number[];
-}
-
-export interface ServerCERTDetails {
-  cert_chain: Array<number[]>;
-  ocsp_response: number[];
-  scts: null;
-}
-
-export interface ServerKxDetails {
-  kx_params: number[];
-  kx_sig: KxSig;
-}
-
-export interface KxSig {
-  scheme: string;
-  sig: number[];
-}
-
-export interface Header {
-  encoder_seed: number[];
-  merkle_root: number[];
-  sent_len: number;
-  recv_len: number;
-  handshake_summary: HandshakeSummary;
-}
-
-export interface HandshakeSummary {
-  time: number;
-  server_public_key: ServerPublicKey;
-  handshake_commitment: number[];
-}
-
-export interface ServerPublicKey {
-  group: string;
-  key: number[];
-}
-
-export interface ServerName {
-  Dns: string;
-}
-
-export interface Signature {
-  P256: string;
-}
-
-export interface Substrings {
-  openings: { [key: string]: Opening[] };
-  inclusion_proof: InclusionProof;
-}
-
-export interface InclusionProof {
-  proof: unknown[];
-  total_leaves: number;
-}
-
-export interface Opening {
-  kind?: string;
-  ranges?: Range[];
-  direction?: string;
-  Blake3?: Blake3;
-}
-
-export interface Blake3 {
-  data: number[];
-  nonce: number[];
-}
-
-export interface Range {
-  start: number;
-  end: number;
-}
-export const assertWebProof = function (candidate: {
-  notaryUrl?: string;
-}): asserts candidate is WebProof {
-  //for now only thing we check is notary url
-  //TODO: implement later once we known the conteact with tlsn-js
-  if (!candidate.notaryUrl) {
-    throw new Error("Missing required parameter");
-  }
-};