ZKWAS-228: add metadata param into interface for 'Creator Paid Proof' feature (#60)

Author: qozymandias

dist/cjs/helper/util.js

@@ -126,6 +126,8 @@ class ZkWasmUtil {
         message += params.description_url;
         message += params.avator_url;
         message += params.circuit_size;
+        message += params.metadata_keys;
+        message += params.metadata_vals;
         // Additional params afterwards
         if (params.initial_context) {
             message += params.initial_context_md5;
@@ -162,6 +164,8 @@ class ZkWasmUtil {
         message += params.md5;
         message += params.circuit_size;
         message += params.user_address;
+        message += params.metadata_keys;
+        message += params.metadata_vals;
         if (params.reset_context) {
             message += params.reset_context_md5;
         }

dist/cjs/interface/interface.d.ts

@@ -47,6 +47,12 @@ export interface VerifierContracts {
     circuit_size: number;
 }
 export type TaskType = "Setup" | "Prove" | "Reset";
+/**
+ * Image status:
+ *  Received: Server received setup task of the image but haven’t been done successfully.
+ *  Initialized: Server received setup task of the image and it is done successfully. No proof task had been done successfully for this image.
+ *  Verified: At least one of the proof task had been done successfully for the image.
+ **/
 export type ImageStatus = "Received" | "Initialized" | "Verified";
 export type TaskStatus = "Pending" | "Processing" | "DryRunFailed" | "Done" | "Fail" | "Stale";
 export interface PaginationResult<T> {
@@ -61,6 +67,8 @@ export interface BaseAddImageParams {
     description_url: string;
     avator_url: string;
     circuit_size: number;
+    metadata_keys: string[];
+    metadata_vals: string[];
 }
 export interface WithInitialContext {
     initial_context: unknown;
@@ -102,6 +110,8 @@ export interface BaseResetImageParams {
     md5: string;
     circuit_size: number;
     user_address: string;
+    metadata_keys: string[];
+    metadata_vals: string[];
 }
 export interface WithResetContext {
     reset_context: unknown;
@@ -209,6 +219,11 @@ export interface Image {
     initial_context?: Uint8Array;
     status: string;
     checksum: ImageChecksum | null;
+    metadata: {
+        values: {
+            [key: string]: string;
+        };
+    };
 }
 export interface ImageChecksum {
     x: Uint8Array;

dist/mjs/helper/util.js

@@ -156,6 +156,8 @@ export class ZkWasmUtil {
         message += params.description_url;
         message += params.avator_url;
         message += params.circuit_size;
+        message += params.metadata_keys;
+        message += params.metadata_vals;
         // Additional params afterwards
         if (params.initial_context) {
             message += params.initial_context_md5;
@@ -192,6 +194,8 @@ export class ZkWasmUtil {
         message += params.md5;
         message += params.circuit_size;
         message += params.user_address;
+        message += params.metadata_keys;
+        message += params.metadata_vals;
         if (params.reset_context) {
             message += params.reset_context_md5;
         }

dist/mjs/interface/interface.d.ts

@@ -47,6 +47,12 @@ export interface VerifierContracts {
     circuit_size: number;
 }
 export type TaskType = "Setup" | "Prove" | "Reset";
+/**
+ * Image status:
+ *  Received: Server received setup task of the image but haven’t been done successfully.
+ *  Initialized: Server received setup task of the image and it is done successfully. No proof task had been done successfully for this image.
+ *  Verified: At least one of the proof task had been done successfully for the image.
+ **/
 export type ImageStatus = "Received" | "Initialized" | "Verified";
 export type TaskStatus = "Pending" | "Processing" | "DryRunFailed" | "Done" | "Fail" | "Stale";
 export interface PaginationResult<T> {
@@ -61,6 +67,8 @@ export interface BaseAddImageParams {
     description_url: string;
     avator_url: string;
     circuit_size: number;
+    metadata_keys: string[];
+    metadata_vals: string[];
 }
 export interface WithInitialContext {
     initial_context: unknown;
@@ -102,6 +110,8 @@ export interface BaseResetImageParams {
     md5: string;
     circuit_size: number;
     user_address: string;
+    metadata_keys: string[];
+    metadata_vals: string[];
 }
 export interface WithResetContext {
     reset_context: unknown;
@@ -209,6 +219,11 @@ export interface Image {
     initial_context?: Uint8Array;
     status: string;
     checksum: ImageChecksum | null;
+    metadata: {
+        values: {
+            [key: string]: string;
+        };
+    };
 }
 export interface ImageChecksum {
     x: Uint8Array;

src/helper/util.ts

@@ -186,6 +186,8 @@ export class ZkWasmUtil {
     message += params.description_url;
     message += params.avator_url;
     message += params.circuit_size;
+    message += params.metadata_keys;
+    message += params.metadata_vals;
     // Additional params afterwards
     if (params.initial_context) {
       message += params.initial_context_md5;
@@ -231,6 +233,8 @@ export class ZkWasmUtil {
     message += params.md5;
     message += params.circuit_size;
     message += params.user_address;
+    message += params.metadata_keys;
+    message += params.metadata_vals;
     if (params.reset_context) {
       message += params.reset_context_md5;
     }

src/interface/interface.ts

@@ -83,6 +83,8 @@ export interface BaseAddImageParams {
   description_url: string;
   avator_url: string;
   circuit_size: number;
+  metadata_keys: string[];
+  metadata_vals: string[];
 }
 
 export interface WithInitialContext {
@@ -140,6 +142,8 @@ export interface BaseResetImageParams {
   md5: string;
   circuit_size: number;
   user_address: string;
+  metadata_keys: string[];
+  metadata_vals: string[];
 }
 
 export interface WithResetContext {
@@ -260,6 +264,9 @@ export interface Image {
   initial_context?: Uint8Array;
   status: string;
   checksum: ImageChecksum | null;
+  metadata : { 
+    values : { [key: string]: string }
+  };
 }
 
 export interface ImageChecksum {