feat!: adopt optimized api interfaces & remove local

Author: nom4dv3

README.md

@@ -313,7 +313,7 @@ Please note that (during testnet phrase) your address balance (in zkwasm server)
 #### WasmBinPath
 
 - **Type:** `string`
-- **Default**: `[root]/build/cle_full.wasm`
+- **Default**: `[root]/build/cle.wasm`
 
 CLE CLI Build-In a tag name is `root`.  
 The `root` is user project root path.  

package.json

@@ -23,7 +23,7 @@
     "@antfu/ni": "^0.21.8",
     "@antfu/utils": "^0.7.6",
     "@murongg/eslint-config": "^0.2.1",
-    "@ora-io/cle-lib": "^1.0.1-alpha.2",
+    "@ora-io/cle-lib": "^1.0.1-alpha.4",
     "@types/fs-extra": "^11.0.2",
     "@types/node": "^18.18.4",
     "assemblyscript": "^0.27.12",

packages/cle-cli/README.md

@@ -260,7 +260,7 @@ Please note that (during testnet phrase) your address balance (in zkwasm server)
 #### WasmBinPath
 
 - **Type:** `string`
-- **Default**: `[root]/build/cle_full.wasm`
+- **Default**: `[root]/build/cle.wasm`
 
 CLE CLI Build-In a tag name is `root`.  
 The `root` is user project root path.  

packages/cle-cli/package.json

@@ -45,7 +45,7 @@
     "start": "esno src/index.ts"
   },
   "peerDependencies": {
-    "@ora-io/cle-lib": "^1.0.1-alpha.2"
+    "@ora-io/cle-lib": "^1.0.1-alpha.4"
   },
   "dependencies": {
     "@antfu/utils": "^0.7.6",
@@ -64,10 +64,11 @@
     "prompts": "^2.4.2",
     "semver": "^7.5.4",
     "ts-md5": "^1.3.1",
-    "unconfig": "^0.3.11"
+    "unconfig": "^0.3.11",
+    "zkwasm-toolchain": "^0.0.4"
   },
   "devDependencies": {
-    "@ora-io/cle-lib": "^1.0.1-alpha.0",
+    "@ora-io/cle-lib": "^1.0.1-alpha.4",
     "@types/js-yaml": "^4.0.6",
     "@types/prompts": "^2.4.6",
     "@types/semver": "^7.5.3"

packages/cle-cli/src/cli.ts

@@ -23,16 +23,16 @@ export async function run() {
     const { proveUsage, execUsage } = generateCommandUsage()
     cli
       .command('compile', 'Compile for Full Image (Link Compiled with Compiler Server)')
-      .option('--local', 'Compile for Local Image')
+      // .option('--local', 'Compile for Local Image')
       .option('--yaml-path <path>', 'Path to yaml file')
       .option('--mapping-path <path>', 'Path to mapping file')
       .example('cle compile')
       .action((options) => {
-        const { local = false, yamlPath = '', mappingPath = '' } = options
-        const wasmPath = local ? config.LocalWasmBinPath : config.WasmBinPath
+        const { yamlPath = '', mappingPath = '' } = options
+        const wasmPath = config.WasmBinPath
 
         compile({
-          local,
+          // local,
           yamlPath: yamlPath || config.YamlPath,
           compilerServerEndpoint: config.CompilerServerEndpoint,
           wasmPath,
@@ -43,14 +43,14 @@ export async function run() {
 
     cli
       .command('exec [...params]', 'Execute Full Image')
-      .option('--local', 'Execute Local Image')
+      // .option('--local', 'Execute Local Image')
       .example('cle exec 0000000')
-      .action((params, options) => {
-        const { local = false } = options
-        const wasmPath = local ? config.LocalWasmBinPath : config.WasmBinPath
+      .action((params, _options) => {
+        // const { local = false } = options
+        const wasmPath = config.WasmBinPath
 
         exec({
-          local,
+          // local,
           wasmPath,
           yamlPath: config.YamlPath,
           jsonRpcProviderUrl: config.JsonRpcProviderUrl,
@@ -64,13 +64,14 @@ Usage cases:
 
     cli
       .command('setup', 'Set Up Full Image')
-      .option('--local', 'Set Up Local Image')
+      // .option('--local', 'Set Up Local Image')
       .option('-k, --circuit-size <size>', 'Circuit size (k in 2^k) of image')
       .example('cle setup -k 20')
       .action((options) => {
-        const { circuitSize = '', local = false } = options
-        const wasmPath = local ? config.LocalWasmBinPath : config.WasmBinPath
-        const size = !circuitSize || circuitSize === 0 ? local ? 20 : 22 : Number(circuitSize)
+        // const { circuitSize = '', local = false } = options
+        const { circuitSize = '' } = options
+        const wasmPath = config.WasmBinPath
+        const size = !circuitSize || circuitSize === 0 ? 22 : Number(circuitSize)
         setup({
           circuitSize: size,
           wasmPath,
@@ -81,7 +82,7 @@ Usage cases:
 
     const proveCLI = cli
       .command('prove [...params]', 'Prove Full Image')
-      .option('--local', 'Prove Local Image')
+      // .option('--local', 'Prove Local Image')
       .option('-i, --inputgen', 'Run in input generation Mode')
       .option('-t, --test', 'Run in test Mode')
       .option('-p, --prove', 'Run in prove Mode')
@@ -90,7 +91,7 @@ Usage cases:
       .example('cle prove 2279547 a60ecf32309539dd84f27a9563754dca818b815e -p')
       .action((params, options) => {
         // eslint-disable-next-line prefer-const
-        let { inputgen = false, test = false, prove = false, local = false } = options
+        let { inputgen = false, test = false, prove = false } = options
         const hasMode = proveCLIHasModeOption()
         if (!hasMode)
           test = true
@@ -100,14 +101,14 @@ Usage cases:
           proveCLI.outputHelp()
           return
         }
-        const wasmPath = local ? config.LocalWasmBinPath : config.WasmBinPath
+        const wasmPath = config.WasmBinPath
 
         proveHandler({
           params,
           inputgen,
           test,
           prove,
-          local,
+          // local,
           wasmPath,
           yamlPath: config.YamlPath,
           jsonRpcProviderUrl: config.JsonRpcProviderUrl,
@@ -123,13 +124,13 @@ Usage cases:
 
     cli
       .command('upload', 'Upload CLE (Code and Full Image)')
-      .option('--local', 'Upload Local CLE (Code and Local Image)')
+      // .option('--local', 'Upload Local CLE (Code and Local Image)')
       .example('cle upload')
-      .action((options) => {
-        const { local = false } = options
+      .action((_options) => {
+        // const { local = false } = options
         upload({
-          local,
-          wasmPath: local ? config.LocalWasmBinPath : config.WasmBinPath,
+          // local,
+          wasmPath: config.WasmBinPath,
           yamlPath: config.YamlPath,
           pinataEndpoint: config.PinataEndpoint,
           pinataJWT: config.PinataJWT,

packages/cle-cli/src/commands/compile.ts

@@ -7,7 +7,7 @@ import { createOnNonexist, isTsFile } from '../utils'
 import { logger } from '../logger'
 
 export interface CompileOptions {
-  local: boolean
+  // local: boolean
   yamlPath?: string
   compilerServerEndpoint: string
   wasmPath: string
@@ -33,7 +33,7 @@ async function compileBasic(options: CompileOptions) {
     wasmPath,
     watPath,
     mappingPath,
-    local,
+    // local,
   } = options
   if (!yamlPath) {
     logger.error('no yaml path provided')
@@ -55,7 +55,7 @@ async function compileBasic(options: CompileOptions) {
     ...fileMap,
     [relativeYamlPath]: yaml,
   }, {
-    isLocal: local,
+    // isLocal: local,
     yamlPath: path.relative(path.dirname(mappingPath), yamlPath),
     outWasmPath: wasmPath,
     outWatPath: watPath,

packages/cle-cli/src/commands/exec.ts

@@ -7,22 +7,22 @@ import { logger } from '../logger'
 import type { UserConfig } from '../config'
 
 export interface ExecOptions {
-  local: boolean
+  // local: boolean
   wasmPath: string
   yamlPath: string
   jsonRpcProviderUrl: UserConfig['JsonRpcProviderUrl']
   params?: any[]
 }
 // TODO: prepare all params, dsp select params.
 export async function exec(options: ExecOptions) {
-  const { yamlPath, jsonRpcProviderUrl, wasmPath, local, params = [] } = options
+  const { yamlPath, jsonRpcProviderUrl, wasmPath, params = [] } = options
 
   const cleYaml = loadYamlFromPath(yamlPath)
   if (!cleYaml) {
     logger.error('[-] ERROR: Failed to get yaml')
     return
   }
-  const dsp = zkgapi.dspHub.getDSPByYaml(cleYaml, { isLocal: local })
+  const dsp = zkgapi.dspHub.getDSPByYaml(cleYaml)
   if (!dsp) {
     logger.error('[-] ERROR: Failed to get DSP')
     return
@@ -56,7 +56,7 @@ export async function exec(options: ExecOptions) {
   const state = await zkgapi.execute(
     cleExecutable,
     execParams,
-    local,
+    // local,
   )
 
   logger.info(`[+] CLE STATE OUTPUT: ${toHexString(state)}\n`)

packages/cle-cli/src/commands/prove.ts

@@ -3,6 +3,7 @@ import { providers } from 'ethers'
 import to from 'await-to-js'
 import prompts from 'prompts'
 import * as zkgapi from '@ora-io/cle-api'
+import type { Input } from 'zkwasm-toolchain'
 import { convertToMd5, generateDspHubParams, loadJsonRpcProviderUrl, loadYamlFromPath, logLoadingAnimation, taskPrettyPrint, validateProvider } from '../utils'
 import { logger } from '../logger'
 import type { UserConfig } from '../config'
@@ -14,7 +15,7 @@ export interface ProveOptions {
   inputgen: boolean
   test: boolean
   prove: boolean
-  local: boolean
+  // local: boolean
   wasmPath: string
   yamlPath: string
   jsonRpcProviderUrl: UserConfig['JsonRpcProviderUrl']
@@ -30,7 +31,7 @@ export async function prove(options: ProveOptions) {
     inputgen,
     test,
     prove,
-    local,
+    // local,
     wasmPath,
     yamlPath,
     jsonRpcProviderUrl,
@@ -44,7 +45,7 @@ export async function prove(options: ProveOptions) {
     logger.error('[-] ERROR: Failed to get yaml')
     return
   }
-  const dsp = zkgapi.dspHub.getDSPByYaml(yaml, { isLocal: local })
+  const dsp = zkgapi.dspHub.getDSPByYaml(yaml)
   if (!dsp) {
     logger.error('[-] ERROR: Failed to get DSP')
     return
@@ -102,24 +103,23 @@ export async function prove(options: ProveOptions) {
     cleYaml: yaml as zkgapi.CLEYaml,
   }
 
-  const [privateInputStr, publicInputStr] = await zkgapi.proveInputGen(
+  const input = await zkgapi.proveInputGen(
     cleExecutable,
     proveParams,
-    local,
   )
 
   if (inputgen) {
     // Input generation mode
-    logger.info('[+] PRIVATE INPUT FOR ZKWASM:' + `\n${privateInputStr}`)
-    logger.info('[+] PUBLIC INPUT FOR ZKWASM:' + `\n${publicInputStr}`)
+    logger.info('[+] PRIVATE INPUT FOR ZKWASM:' + `\n${input.getPrivateInputStr()}`)
+    logger.info('[+] PUBLIC INPUT FOR ZKWASM:' + `\n${input.getPublicInputStr()}`)
   }
   else if (test) {
     // Test mode
-    await testMode(wasmUint8Array, privateInputStr, publicInputStr)
+    await testMode(wasmUint8Array, input)
   }
   else if (prove) {
     // Prove mode
-    await proveMode(userPrivateKey, md5, privateInputStr, publicInputStr, zkWasmProviderUrl, outputProofFilePath)
+    await proveMode(userPrivateKey, md5, input.getPrivateInputStr(), input.getPublicInputStr(), zkWasmProviderUrl, outputProofFilePath)
   }
 }
 /**
@@ -128,16 +128,15 @@ export async function prove(options: ProveOptions) {
  * @param privateInputStr
  * @param publicInputStr
  */
-async function testMode(wasmUint8Array: Uint8Array, privateInputStr: string, publicInputStr: string) {
+async function testMode(wasmUint8Array: Uint8Array, input: Input) {
   const cleExecutable = {
     wasmUint8Array,
     cleYaml: null,
   }
 
   const [mockErr, mockSuccess] = await to(zkgapi.proveMock(
     cleExecutable,
-    privateInputStr,
-    publicInputStr,
+    input,
   ))
 
   if (mockErr) {

packages/cle-cli/src/commands/upload.ts

@@ -5,7 +5,7 @@ import { logger } from '../logger'
 import { checkPinataAuthentication, loadYamlFromPath } from '../utils'
 
 export interface UploadOptions {
-  local: boolean
+  // local: boolean
   wasmPath: string
   userPrivateKey: string
   yamlPath: string
@@ -36,15 +36,16 @@ export async function upload(options: UploadOptions) {
     'cle.wasm': wasmFile,
     'cle.yaml': yamlFile,
   }
+  const directoryTag = { userAddress, graphName: yaml.name }
+  const directoryName = `${directoryTag.graphName}-${directoryTag.userAddress}`
 
   const { isUploadSuccess, response, errorMessage } = await uploadApi(
     files,
     {
-      userAddress,
-      graphName: yaml.name,
+      pinataEndpoint,
+      pinataJWT,
+      directoryName,
     },
-    pinataEndpoint,
-    pinataJWT,
   )
   if (isUploadSuccess) {
     logger.info('[+] IPFS UPLOAD SUCCESS!')

packages/cle-cli/src/config.ts

@@ -37,10 +37,6 @@ export interface UserConfig {
    * @default "[root]/build/cle.wasm"
    */
   WasmBinPath?: string
-  /**
-   * @default "[root]/build/cle_local.wasm"
-   */
-  LocalWasmBinPath?: string
 
   /**
    * @default "[root]/src/cle.yaml"
@@ -108,7 +104,7 @@ export async function getConfig(configFile?: string, configRoot?: string) {
   const userConfig = await loadConfigFromFile(configFile, configRoot)
 
   userConfig.WasmBinPath = parseTemplateTag(userConfig.WasmBinPath || '', TAGS)
-  userConfig.LocalWasmBinPath = parseTemplateTag(userConfig.LocalWasmBinPath || '', TAGS)
+  // userConfig.LocalWasmBinPath = parseTemplateTag(userConfig.LocalWasmBinPath || '', TAGS)
   userConfig.YamlPath = parseTemplateTag(userConfig.YamlPath || '', TAGS)
   userConfig.MappingPath = parseTemplateTag(userConfig.MappingPath || '', TAGS)