Merge pull request #78 from hyperoracle/dev

Refactor and Compatibility Updates for zkGraph API

.github/workflows/release.yml

@@ -0,0 +1,30 @@
+name: Release
+
+permissions:
+  contents: write
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Install pnpm
+        uses: pnpm/action-setup@v2
+
+      - name: Set node
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18.x
+          cache: pnpm
+
+      - run: npx changelogithub
+        env:
+          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}

api/compile.js

@@ -1,3 +1,6 @@
+import fs from "fs";
+import path from "path";
+import { fileURLToPath } from "url";
 import { currentNpmScriptName, logDivider } from "./common/log_utils.js";
 import { config } from "../config.js";
 import * as zkgapi from "@hyperoracle/zkgraph-api";
@@ -18,6 +21,11 @@ if (currentNpmScriptName() === "compile-local") {
   );
 } else if (currentNpmScriptName() === "compile") {
   // Compile Remotely
+  const dirname = path.dirname(fileURLToPath(import.meta.url));
+  const yamlContent = fs.readFileSync(
+    path.join(dirname, "../src/zkgraph.yaml"),
+    "utf8",
+  );
   let isCompilationSuccess = await zkgapi.compile(
     config.WasmBinPath,
     config.WasmBinPath.replace(/\.wasm/, ".wat"),

api/deploy.js

@@ -1,3 +1,6 @@
+import fs from "fs";
+import path from "path";
+import { fileURLToPath } from "url";
 import { program } from "commander";
 import { config } from "../config.js";
 import { getTargetNetwork } from "./common/utils.js";
@@ -37,9 +40,11 @@ if (currentNpmScriptName() === "deploy-local") {
 } else if (currentNpmScriptName() === "deploy") {
   wasmPath = config.WasmBinPath;
 }
-
+const dirname = path.dirname(fileURLToPath(import.meta.url));
+const wasm = fs.readFileSync(path.join(dirname, "../", wasmPath));
+const wasmUnit8Array = new Uint8Array(wasm);
 const deployedVerificationContractAddress = await zkgapi.deploy(
-  wasmPath,
+  wasmUnit8Array,
   targetNetwork.value,
   config.ZkwasmProviderUrl,
   config.UserPrivateKey,

api/exec.js

@@ -1,3 +1,6 @@
+import fs from "fs";
+import path from "path";
+import { fileURLToPath } from "url";
 import { program } from "commander";
 import { currentNpmScriptName, logDivider } from "./common/log_utils.js";
 import { config } from "../config.js";
@@ -34,16 +37,24 @@ if (currentNpmScriptName() === "exec-local") {
 
 let basePath = import.meta.url + "/../../";
 
+const dirname = path.dirname(fileURLToPath(import.meta.url));
+
 const JsonRpcProviderUrl = loadJsonRpcProviderUrl("src/zkgraph.yaml", true);
 const provider = new providers.JsonRpcProvider(JsonRpcProviderUrl);
 await validateProvider(provider);
 
 let rawReceiptList = await zkgapi.getRawReceipts(provider, blockid, false);
 
+const wasm = fs.readFileSync(path.join(dirname, "../", wasmPath));
+const wasmUnit8Array = new Uint8Array(wasm);
+const yamlContent = fs.readFileSync(
+  path.join(dirname, "../src/zkgraph.yaml"),
+  "utf8",
+);
+
 let state = await zkgapi.executeOnRawReceipts(
-  basePath,
-  wasmPath,
-  "src/zkgraph.yaml",
+  wasmUnit8Array,
+  yamlContent,
   rawReceiptList,
   isLocal,
   true,

api/prove.js

@@ -1,5 +1,8 @@
 // usage: node prove.js [--inputgen/test] <blocknum/blockhash> <state> -> wasm input
 // TODO: add -o --outfile <file> under inputgen mode
+import fs from "fs";
+import path from "path";
+import { fileURLToPath } from "url";
 import { program } from "commander";
 import { currentNpmScriptName, logDivider } from "./common/log_utils.js";
 import { config } from "../config.js";
@@ -83,8 +86,16 @@ const blockNumber = parseInt(block.number);
 const blockHash = block.hash;
 const receiptsRoot = block.receiptsRoot;
 
+const dirname = path.dirname(fileURLToPath(import.meta.url));
+const wasm = fs.readFileSync(path.join(dirname, "../", wasmPath));
+const wasmUnit8Array = new Uint8Array(wasm);
+const yamlContent = fs.readFileSync(
+  path.join(dirname, "../src/zkgraph.yaml"),
+  "utf8",
+);
+
 let [privateInputStr, publicInputStr] = await zkgapi.proveInputGenOnRawReceipts(
-  "src/zkgraph.yaml",
+  yamlContent,
   rawReceiptList,
   blockNumber,
   blockHash,
@@ -107,8 +118,7 @@ switch (options.inputgen || options.test || options.prove) {
     let basePath = import.meta.url + "/../../";
 
     let mock_succ = await zkgapi.proveMock(
-      basePath,
-      wasmPath,
+      wasmUnit8Array,
       privateInputStr,
       publicInputStr,
     );
@@ -123,7 +133,7 @@ switch (options.inputgen || options.test || options.prove) {
   // Prove mode
   case options.prove === true:
     let result = await zkgapi.prove(
-      wasmPath,
+      wasmUnit8Array,
       privateInputStr,
       publicInputStr,
       config.ZkwasmProviderUrl,

api/publish.js

@@ -1,4 +1,7 @@
 // npm run publish 0x0000000000000000000000000000000000000000 Qmcpu8YNbHpjnEpxe5vUkz8TZYzv8oCbiUGj3a66rNngjQ 0.1
+import fs from "fs";
+import path from "path";
+import { fileURLToPath } from "url";
 import { program } from "commander";
 import { logDivider } from "./common/log_utils.js";
 import * as zkgapi from "@hyperoracle/zkgraph-api";
@@ -35,8 +38,14 @@ bountyRewardPerTrigger *= Math.pow(10, 9);
 
 const JsonRpcProviderUrl = loadJsonRpcProviderUrl("src/zkgraph.yaml", false);
 
+const dirname = path.dirname(fileURLToPath(import.meta.url));
+const yamlContent = fs.readFileSync(
+  path.join(dirname, "../src/zkgraph.yaml"),
+  "utf8",
+);
+
 const publishTxHash = await zkgapi.publish(
-  "src/zkgraph.yaml",
+  yamlContent,
   JsonRpcProviderUrl,
   deployedContractAddress,
   ipfsHash,

api/setup.js

@@ -1,3 +1,6 @@
+import fs from "fs";
+import path from "path";
+import { fileURLToPath } from "url";
 import { config } from "../config.js";
 import { currentNpmScriptName, logDivider } from "./common/log_utils.js";
 import * as zkgapi from "@hyperoracle/zkgraph-api";
@@ -32,8 +35,13 @@ if (options.circuitSize !== undefined) {
 // Log script name
 console.log(">> SET UP", "\n");
 
+const dirname = path.dirname(fileURLToPath(import.meta.url));
+const wasm = fs.readFileSync(path.join(dirname, "../", wasmPath));
+const wasmUnit8Array = new Uint8Array(wasm);
+
 let { md5, taskId, success } = await zkgapi.setup(
-  wasmPath,
+  "poc.wasm",
+  wasmUnit8Array,
   cirSz,
   config.UserPrivateKey,
   config.ZkwasmProviderUrl,

api/verify.js

@@ -1,9 +1,12 @@
+import fs from "fs";
+import path from "path";
+import { fileURLToPath } from "url";
 import { program } from "commander";
 import * as zkgapi from "@hyperoracle/zkgraph-api";
 import { config } from "../config.js";
 import { logDivider } from "./common/log_utils.js";
 
-// npm run verify 64e52295abac08978a0e46cf
+// npm run verify 64fee557abfa8fdad38d73f3
 
 program.version("1.0.0");
 program.argument("<prove task id>", "Task id of prove task");
@@ -15,9 +18,13 @@ console.log(">> VERIFY PROOF ONCHAIN", "\n");
 
 // Inputs from command line
 const taskId = args[0];
-
+const dirname = path.dirname(fileURLToPath(import.meta.url));
+const yamlContent = fs.readFileSync(
+  path.join(dirname, "../src/zkgraph.yaml"),
+  "utf8",
+);
 const verifyResult = await zkgapi.verify(
-  "src/zkgraph.yaml",
+  yamlContent,
   taskId,
   config.ZkwasmProviderUrl,
   true,

example/hello/zkgraph.yaml

@@ -15,8 +15,3 @@ dataSources:
       eventHandlers:
         - event: "Sync(uint112,uint112)"
           handler: handleEvents
-dataDestinations:
-  - kind: ethereum/contract
-    network: sepolia
-    destination:
-      address: "0x0000000000000000000000000000000000000000"

example/multiaddr/zkgraph.yaml

@@ -29,8 +29,3 @@ dataSources:
       eventHandlers:
         - event: "SubmissionReceived(int256,uint32,address)"
           handler: handleEvents
-dataDestinations:
-  - kind: ethereum/contract
-    network: sepolia
-    destination:
-      address: "0x0000000000000000000000000000000000000000"

example/uniswapprice/zkgraph.yaml

@@ -15,8 +15,3 @@ dataSources:
       eventHandlers:
         - event: "Sync(uint112,uint112)"
           handler: handleEvents
-dataDestinations:
-  - kind: ethereum/contract
-    network: sepolia
-    destination:
-      address: "0x0000000000000000000000000000000000000000"

example/zkauto/mapping.ts

@@ -0,0 +1,11 @@
+//@ts-ignore
+import { require } from "@hyperoracle/zkgraph-lib";
+import { Bytes, Event, BigInt, ByteArray } from "@hyperoracle/zkgraph-lib";
+
+export function handleEvents(events: Event[]): Bytes {
+  // run() - keccak256 c0406226a44c49a673ef01611ce55e97850e1c520ac5d22c6854eb2dbaee7040
+  let tmp = Bytes.fromHexString(
+    "c0406226a44c49a673ef01611ce55e97850e1c520ac5d22c6854eb2dbaee7040",
+  );
+  return Bytes.fromHexString("c0406226").padEnd(32);
+}

example/zkauto/zkgraph.yaml

@@ -0,0 +1,23 @@
+specVersion: 0.0.1
+name: ex_hello
+description: Demo graph for zkAutomation. Use greeting string as the trigger payload.
+repository: https://github.com/hyperoracle/zkgraph
+dataSources:
+  - kind: ethereum/contract
+    network: sepolia
+    source:
+      address: '0x362b63b77448C2ffBC03511FE100fCd3d879795F'
+    mapping:
+      kind: ethereum/events
+      apiVersion: 0.0.1
+      language: wasm/assemblyscript
+      file: ./mapping.ts
+      eventHandlers:
+        - event: 'eventTriggered(uint256,uint256)'
+          handler: handleEvents
+# dataDestinations field is required for zkAutomation.
+dataDestinations:
+  - kind: ethereum/contract
+    network: sepolia
+    destination:
+      address: '0x362b63b77448C2ffBC03511FE100fCd3d879795F'