feature/August (#95)

rhaoio · web-flow · commit 5a97270202e3 · 2024-08-30T11:22:29.000+10:00
* ZKWAS-327: Node version information (#90) * version for nodes * optional field * server version info * rename * paginated node stats (#92) * guest static in task type (#94) * update package (#96)
diff --git a/dist/cjs/helper/task.d.ts b/dist/cjs/helper/task.d.ts
@@ -11,7 +11,7 @@ export declare class ZkWasmServiceHelper {
     queryDepositHistory(history_query: TxHistoryQueryParams): Promise<PaginationResult<ERC20DepositInfo[]>>;
     queryConfig(): Promise<AppConfig>;
     loadStatistics(): Promise<Statistics>;
-    queryNodeStatistics(query: NodeStatisticsQueryParams): Promise<NodeStatistics[]>;
+    queryNodeStatistics(query: NodeStatisticsQueryParams): Promise<PaginationResult<NodeStatistics[]>>;
     loadTasks(query: QueryParams): Promise<PaginationResult<Task[]>>;
     loadTaskList(query: QueryParams): Promise<PaginationResult<ConciseTask[]>>;
     queryAutoSubmitProofs(query: PaginatedQuery<AutoSubmitProofQuery>): Promise<PaginationResult<AutoSubmitProof[]>>;
diff --git a/dist/cjs/index.d.ts b/dist/cjs/index.d.ts
@@ -1,7 +1,7 @@
-import { Task, ConciseTask, ProvingParams, DeployParams, QueryParams, VerifyProofParams, VerifyData, StatusState, DeploymentInfo, Image, Statistics, AddImageParams, WithSignature, User, UserQueryParams, PaymentParams, SubscriptionParams, Subscription, SubscriptionType, SubscriptionRequest, TxHistoryQueryParams, TransactionInfo, TaskStatus, TaskType, AppConfig, PaginationResult, ResetImageParams, LogQuery, ModifyImageParams, ChainDetails, InputContextType, ContextHexString, WithCustomInputContextType, WithInitialContext, WithNonCustomInputContextType, WithResetContext, WithoutInitialContext, WithoutInputContextType, WithoutResetContext, AutoSubmitProofStatus, Round1Status, Round2Status, AutoSubmitProof, Round1Info, Round2Info, AutoSubmitProofQuery, Round1InfoQuery, Round2InfoQuery, PaginatedQuery, PaginationQuery, AutoSubmitStatus, VerifyBatchProofParams, AutoSubmitBatchMetadata, ProofSubmitMode, ProvePaymentSrc, NodeStatistics, NodeStatisticsQueryParams, MaintenanceModeType, SetMaintenanceModeParams, AdminRequestType } from "./interface/interface.js";
+import { Task, ConciseTask, ProvingParams, DeployParams, QueryParams, VerifyProofParams, VerifyData, StatusState, DeploymentInfo, Image, Statistics, AddImageParams, WithSignature, User, UserQueryParams, PaymentParams, SubscriptionParams, Subscription, SubscriptionType, SubscriptionRequest, TxHistoryQueryParams, TransactionInfo, TaskStatus, TaskType, AppConfig, PaginationResult, ResetImageParams, LogQuery, ModifyImageParams, ChainDetails, InputContextType, ContextHexString, WithCustomInputContextType, WithInitialContext, WithNonCustomInputContextType, WithResetContext, WithoutInitialContext, WithoutInputContextType, WithoutResetContext, AutoSubmitProofStatus, Round1Status, Round2Status, AutoSubmitProof, Round1Info, Round2Info, AutoSubmitProofQuery, Round1InfoQuery, Round2InfoQuery, PaginatedQuery, PaginationQuery, AutoSubmitStatus, VerifyBatchProofParams, AutoSubmitBatchMetadata, ProofSubmitMode, ProvePaymentSrc, NodeStatistics, NodeStatisticsQueryParams, MaintenanceModeType, SetMaintenanceModeParams, AdminRequestType, ServerVersionInfo } from "./interface/interface.js";
 import { ZkWasmUtil } from "./helper/util.js";
 import { ZkWasmServiceEndpoint } from "./helper/endpoint.js";
 import { ZkWasmServiceHelper } from "./helper/task.js";
 import { ERC20Lib } from "./abi/ERC20.js";
 export { ZkWasmServiceEndpoint, ZkWasmServiceHelper, ZkWasmUtil, ERC20Lib, InputContextType, AutoSubmitStatus, AutoSubmitProofStatus, Round1Status, Round2Status, ProofSubmitMode, ProvePaymentSrc, MaintenanceModeType, AdminRequestType, };
-export type { Task, ConciseTask, ProvingParams, DeployParams, QueryParams, VerifyProofParams, VerifyData, StatusState, DeploymentInfo, Image, Statistics, AddImageParams, TaskStatus, TaskType, WithSignature, User, UserQueryParams, Subscription, SubscriptionType, PaymentParams, SubscriptionParams, SubscriptionRequest, TxHistoryQueryParams, TransactionInfo, ResetImageParams, AppConfig, PaginationResult, LogQuery, ModifyImageParams, ChainDetails, ContextHexString, WithCustomInputContextType, WithInitialContext, WithNonCustomInputContextType, WithResetContext, WithoutInitialContext, WithoutInputContextType, WithoutResetContext, AutoSubmitProof, Round1Info, Round2Info, AutoSubmitProofQuery, Round1InfoQuery, Round2InfoQuery, PaginatedQuery, PaginationQuery, VerifyBatchProofParams, AutoSubmitBatchMetadata, NodeStatistics, NodeStatisticsQueryParams, SetMaintenanceModeParams, };
+export type { Task, ConciseTask, ProvingParams, DeployParams, QueryParams, VerifyProofParams, VerifyData, StatusState, DeploymentInfo, Image, Statistics, AddImageParams, TaskStatus, TaskType, WithSignature, User, UserQueryParams, Subscription, SubscriptionType, PaymentParams, SubscriptionParams, SubscriptionRequest, TxHistoryQueryParams, TransactionInfo, ResetImageParams, AppConfig, PaginationResult, LogQuery, ModifyImageParams, ChainDetails, ContextHexString, WithCustomInputContextType, WithInitialContext, WithNonCustomInputContextType, WithResetContext, WithoutInitialContext, WithoutInputContextType, WithoutResetContext, AutoSubmitProof, Round1Info, Round2Info, AutoSubmitProofQuery, Round1InfoQuery, Round2InfoQuery, PaginatedQuery, PaginationQuery, VerifyBatchProofParams, AutoSubmitBatchMetadata, NodeStatistics, NodeStatisticsQueryParams, SetMaintenanceModeParams, ServerVersionInfo, };
diff --git a/dist/cjs/interface/interface.d.ts b/dist/cjs/interface/interface.d.ts
@@ -19,6 +19,9 @@ export interface NodeStatistics {
         setup_timing_stats?: TimingStatistics;
         proof_timing_stats?: TimingStatistics;
     };
+    version_info?: {
+        version: string;
+    };
 }
 export interface NodeStatisticsQueryParams {
     address?: string;
@@ -56,6 +59,7 @@ export interface Task {
     task_fee?: Uint8Array;
     status_message?: string;
     internal_message?: string;
+    guest_statics?: number;
     task_verification_data: TaskVerificationData;
     debug_logs?: string;
     proof_submit_mode?: ProofSubmitMode;
@@ -344,6 +348,11 @@ export interface AppConfig {
     deployments: ContractDeployments[];
     subscription_plans: SubscriptionParams[];
     supported_auto_submit_network_ids: number[];
+    server_version_info: ServerVersionInfo;
+}
+export interface ServerVersionInfo {
+    current_version: string;
+    minimum_supported_node_version: string;
 }
 export interface ContractDeployments {
     chain_id: number;
diff --git a/dist/mjs/helper/task.d.ts b/dist/mjs/helper/task.d.ts
@@ -11,7 +11,7 @@ export declare class ZkWasmServiceHelper {
     queryDepositHistory(history_query: TxHistoryQueryParams): Promise<PaginationResult<ERC20DepositInfo[]>>;
     queryConfig(): Promise<AppConfig>;
     loadStatistics(): Promise<Statistics>;
-    queryNodeStatistics(query: NodeStatisticsQueryParams): Promise<NodeStatistics[]>;
+    queryNodeStatistics(query: NodeStatisticsQueryParams): Promise<PaginationResult<NodeStatistics[]>>;
     loadTasks(query: QueryParams): Promise<PaginationResult<Task[]>>;
     loadTaskList(query: QueryParams): Promise<PaginationResult<ConciseTask[]>>;
     queryAutoSubmitProofs(query: PaginatedQuery<AutoSubmitProofQuery>): Promise<PaginationResult<AutoSubmitProof[]>>;
diff --git a/dist/mjs/index.d.ts b/dist/mjs/index.d.ts
@@ -1,7 +1,7 @@
-import { Task, ConciseTask, ProvingParams, DeployParams, QueryParams, VerifyProofParams, VerifyData, StatusState, DeploymentInfo, Image, Statistics, AddImageParams, WithSignature, User, UserQueryParams, PaymentParams, SubscriptionParams, Subscription, SubscriptionType, SubscriptionRequest, TxHistoryQueryParams, TransactionInfo, TaskStatus, TaskType, AppConfig, PaginationResult, ResetImageParams, LogQuery, ModifyImageParams, ChainDetails, InputContextType, ContextHexString, WithCustomInputContextType, WithInitialContext, WithNonCustomInputContextType, WithResetContext, WithoutInitialContext, WithoutInputContextType, WithoutResetContext, AutoSubmitProofStatus, Round1Status, Round2Status, AutoSubmitProof, Round1Info, Round2Info, AutoSubmitProofQuery, Round1InfoQuery, Round2InfoQuery, PaginatedQuery, PaginationQuery, AutoSubmitStatus, VerifyBatchProofParams, AutoSubmitBatchMetadata, ProofSubmitMode, ProvePaymentSrc, NodeStatistics, NodeStatisticsQueryParams, MaintenanceModeType, SetMaintenanceModeParams, AdminRequestType } from "./interface/interface.js";
+import { Task, ConciseTask, ProvingParams, DeployParams, QueryParams, VerifyProofParams, VerifyData, StatusState, DeploymentInfo, Image, Statistics, AddImageParams, WithSignature, User, UserQueryParams, PaymentParams, SubscriptionParams, Subscription, SubscriptionType, SubscriptionRequest, TxHistoryQueryParams, TransactionInfo, TaskStatus, TaskType, AppConfig, PaginationResult, ResetImageParams, LogQuery, ModifyImageParams, ChainDetails, InputContextType, ContextHexString, WithCustomInputContextType, WithInitialContext, WithNonCustomInputContextType, WithResetContext, WithoutInitialContext, WithoutInputContextType, WithoutResetContext, AutoSubmitProofStatus, Round1Status, Round2Status, AutoSubmitProof, Round1Info, Round2Info, AutoSubmitProofQuery, Round1InfoQuery, Round2InfoQuery, PaginatedQuery, PaginationQuery, AutoSubmitStatus, VerifyBatchProofParams, AutoSubmitBatchMetadata, ProofSubmitMode, ProvePaymentSrc, NodeStatistics, NodeStatisticsQueryParams, MaintenanceModeType, SetMaintenanceModeParams, AdminRequestType, ServerVersionInfo } from "./interface/interface.js";
 import { ZkWasmUtil } from "./helper/util.js";
 import { ZkWasmServiceEndpoint } from "./helper/endpoint.js";
 import { ZkWasmServiceHelper } from "./helper/task.js";
 import { ERC20Lib } from "./abi/ERC20.js";
 export { ZkWasmServiceEndpoint, ZkWasmServiceHelper, ZkWasmUtil, ERC20Lib, InputContextType, AutoSubmitStatus, AutoSubmitProofStatus, Round1Status, Round2Status, ProofSubmitMode, ProvePaymentSrc, MaintenanceModeType, AdminRequestType, };
-export type { Task, ConciseTask, ProvingParams, DeployParams, QueryParams, VerifyProofParams, VerifyData, StatusState, DeploymentInfo, Image, Statistics, AddImageParams, TaskStatus, TaskType, WithSignature, User, UserQueryParams, Subscription, SubscriptionType, PaymentParams, SubscriptionParams, SubscriptionRequest, TxHistoryQueryParams, TransactionInfo, ResetImageParams, AppConfig, PaginationResult, LogQuery, ModifyImageParams, ChainDetails, ContextHexString, WithCustomInputContextType, WithInitialContext, WithNonCustomInputContextType, WithResetContext, WithoutInitialContext, WithoutInputContextType, WithoutResetContext, AutoSubmitProof, Round1Info, Round2Info, AutoSubmitProofQuery, Round1InfoQuery, Round2InfoQuery, PaginatedQuery, PaginationQuery, VerifyBatchProofParams, AutoSubmitBatchMetadata, NodeStatistics, NodeStatisticsQueryParams, SetMaintenanceModeParams, };
+export type { Task, ConciseTask, ProvingParams, DeployParams, QueryParams, VerifyProofParams, VerifyData, StatusState, DeploymentInfo, Image, Statistics, AddImageParams, TaskStatus, TaskType, WithSignature, User, UserQueryParams, Subscription, SubscriptionType, PaymentParams, SubscriptionParams, SubscriptionRequest, TxHistoryQueryParams, TransactionInfo, ResetImageParams, AppConfig, PaginationResult, LogQuery, ModifyImageParams, ChainDetails, ContextHexString, WithCustomInputContextType, WithInitialContext, WithNonCustomInputContextType, WithResetContext, WithoutInitialContext, WithoutInputContextType, WithoutResetContext, AutoSubmitProof, Round1Info, Round2Info, AutoSubmitProofQuery, Round1InfoQuery, Round2InfoQuery, PaginatedQuery, PaginationQuery, VerifyBatchProofParams, AutoSubmitBatchMetadata, NodeStatistics, NodeStatisticsQueryParams, SetMaintenanceModeParams, ServerVersionInfo, };
diff --git a/dist/mjs/interface/interface.d.ts b/dist/mjs/interface/interface.d.ts
@@ -19,6 +19,9 @@ export interface NodeStatistics {
         setup_timing_stats?: TimingStatistics;
         proof_timing_stats?: TimingStatistics;
     };
+    version_info?: {
+        version: string;
+    };
 }
 export interface NodeStatisticsQueryParams {
     address?: string;
@@ -56,6 +59,7 @@ export interface Task {
     task_fee?: Uint8Array;
     status_message?: string;
     internal_message?: string;
+    guest_statics?: number;
     task_verification_data: TaskVerificationData;
     debug_logs?: string;
     proof_submit_mode?: ProofSubmitMode;
@@ -344,6 +348,11 @@ export interface AppConfig {
     deployments: ContractDeployments[];
     subscription_plans: SubscriptionParams[];
     supported_auto_submit_network_ids: number[];
+    server_version_info: ServerVersionInfo;
+}
+export interface ServerVersionInfo {
+    current_version: string;
+    minimum_supported_node_version: string;
 }
 export interface ContractDeployments {
     chain_id: number;
diff --git a/examples/package-lock.json b/examples/package-lock.json
diff --git a/examples/package.json b/examples/package.json
@@ -5,7 +5,7 @@
   "description": "Examples for zkwasm playground helper lib to communicate with zkwasm cloud service",
   "dependencies": {
     "tsx": "^4.16.0",
-    "zkwasm-service-helper": "https://github.com/DelphinusLab/zkWasm-service-helper#zkwas-289"
+    "zkwasm-service-helper": "git+https://github.com/DelphinusLab/zkWasm-service-helper.git#feature/August"
   },
   "scripts": {
     "build": "rm -fr dist/* && npx tsc -p tsconfig.json && npx tsc -p tsconfig-cjs.json && sh ./addhybridpackage.sh"
diff --git a/examples/src/tasks/submitProofTask.ts b/examples/src/tasks/submitProofTask.ts
@@ -33,7 +33,8 @@ export async function AddNewProofTask() {
   };
 
   // Context type for proof task. If none provided, will default to InputContextType.ImageCurrent in the server and use the image's current context
-  const selectedInputContextType = InputContextType.Custom;
+  const selectedInputContextType =
+    InputContextType.ImageCurrent as InputContextType; // (as InputContextType) for compiler to allow comparison below since just hardcoded here.
 
   // For Custom Context, upload a binary file first containing the context.
   if (selectedInputContextType === InputContextType.Custom) {
diff --git a/src/helper/task.ts b/src/helper/task.ts
@@ -162,7 +162,7 @@ export class ZkWasmServiceHelper {
 
   async queryNodeStatistics(
     query: NodeStatisticsQueryParams
-  ): Promise<NodeStatistics[]> {
+  ): Promise<PaginationResult<NodeStatistics[]>> {
     let headers = { "Content-Type": "application/json" };
     let queryJson = JSON.parse(JSON.stringify(query));
 
@@ -175,7 +175,7 @@ export class ZkWasmServiceHelper {
       console.log("loading node statistics");
     }
 
-    return res as NodeStatistics[];
+    return res as PaginationResult<NodeStatistics[]>;
   }
 
   async loadTasks(query: QueryParams): Promise<PaginationResult<Task[]>> {
@@ -431,12 +431,13 @@ export class ZkWasmServiceHelper {
   }
 
   async setMaintenanceMode(req: WithSignature<SetMaintenanceModeParams>) {
-    let response = await this.sendRequestWithSignature<SetMaintenanceModeParams>(
-      "POST",
-      TaskEndpoint.SET_MAINTENANCE_MODE,
-      req,
-      true,
-    );
+    let response =
+      await this.sendRequestWithSignature<SetMaintenanceModeParams>(
+        "POST",
+        TaskEndpoint.SET_MAINTENANCE_MODE,
+        req,
+        true
+      );
     if (this.endpoint.enable_logs) {
       console.log("setMaintenanceMode response:", response.toString());
     }
diff --git a/src/index.ts b/src/index.ts
@@ -59,6 +59,7 @@ import {
   MaintenanceModeType,
   SetMaintenanceModeParams,
   AdminRequestType,
+  ServerVersionInfo,
 } from "./interface/interface.js";
 
 import { ZkWasmUtil } from "./helper/util.js";
@@ -134,4 +135,5 @@ export type {
   NodeStatistics,
   NodeStatisticsQueryParams,
   SetMaintenanceModeParams,
+  ServerVersionInfo,
 };
diff --git a/src/interface/interface.ts b/src/interface/interface.ts
@@ -21,6 +21,9 @@ export interface NodeStatistics {
     setup_timing_stats?: TimingStatistics;
     proof_timing_stats?: TimingStatistics;
   };
+  version_info?: {
+    version: string;
+  };
 }
 
 export interface NodeStatisticsQueryParams {
@@ -62,6 +65,7 @@ export interface Task {
   task_fee?: Uint8Array;
   status_message?: string;
   internal_message?: string;
+  guest_statics?: number;
   task_verification_data: TaskVerificationData;
   debug_logs?: string;
   proof_submit_mode?: ProofSubmitMode;
@@ -428,6 +432,12 @@ export interface AppConfig {
   deployments: ContractDeployments[];
   subscription_plans: SubscriptionParams[];
   supported_auto_submit_network_ids: number[];
+  server_version_info: ServerVersionInfo;
+}
+
+export interface ServerVersionInfo {
+  current_version: string;
+  minimum_supported_node_version: string;
 }
 
 export interface ContractDeployments {
@@ -580,8 +590,8 @@ export enum AdminRequestType {
 }
 
 export interface SetMaintenanceModeParams {
-  mode: MaintenanceModeType,
-  nonce : number,
-  request_type: AdminRequestType,
-  user_address: string,
+  mode: MaintenanceModeType;
+  nonce: number;
+  request_type: AdminRequestType;
+  user_address: string;
 }
