zkcloudworker 0.11.4 → 0.11.7

package/lib/ts/src/cloud/worker/cloud.d.ts

@@ -1,6 +1,7 @@
 /// <reference types="node" />
 import { blockchain } from "../networks";
 import { JobData } from "./job";
+import { TransactionMetadata } from "./transaction";
 /**
  * Interface for the deployer key pair
  * Used to get the public and private keys of the deployer for test networks only
@@ -190,6 +191,16 @@ export declare abstract class Cloud {
      * @returns the transactions
      */
     abstract getTransactions(): Promise<CloudTransaction[]>;
+    /**
+     * Publish the transaction metadata in human-readable format
+     * @param params
+     * @param params.txId the transaction id
+     * @param params.metadata the metadata
+     */
+    abstract publishTransactionMetadata(params: {
+        txId: string;
+        metadata: TransactionMetadata;
+    }): Promise<void>;
     /**
      * Abstract method to delete the task
      * Used to delete the task
@@ -213,42 +224,3 @@ export declare abstract class Cloud {
      */
     abstract forceWorkerRestart(): Promise<void>;
 }
-/**
- * Abstract class for the zkCloudWorker
- * Used to define the zkCloudWorker methods and properties
- * Should be implemented for by the developer for the zkCloudWorker in the cloud
- * @param cloud: the cloud
- */
-export declare abstract class zkCloudWorker {
-    readonly cloud: Cloud;
-    /**
-     * Constructor for the zkCloudWorker class
-     * @param cloud the cloud instance provided by the zkCloudWorker in the local environment or in the cloud
-     */
-    constructor(cloud: Cloud);
-    /**
-     * Creates a new proof from a transaction
-     * @param transaction the transaction
-     * @returns the serialized proof
-     */
-    create(transaction: string): Promise<string | undefined>;
-    /**
-     * Merges two proofs
-     * @param proof1 the first proof
-     * @param proof2 the second proof
-     * @returns the merged proof
-     */
-    merge(proof1: string, proof2: string): Promise<string | undefined>;
-    /**
-     * Executes the transactions
-     * @param transactions the transactions, can be empty list
-     * @returns the result
-     */
-    execute(transactions: string[]): Promise<string | undefined>;
-    processTransactions(transactions: CloudTransaction[]): Promise<void>;
-    /**
-     * process the task defined by the developer
-     * @returns the result
-     */
-    task(): Promise<string | undefined>;
-}

package/lib/ts/src/cloud/worker/cloud.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.zkCloudWorker = exports.Cloud = void 0;
+exports.Cloud = void 0;
 /*
  * Abstract class for the cloud service
  * Used to define the cloud methods and properties
@@ -55,57 +55,3 @@ class Cloud {
     }
 }
 exports.Cloud = Cloud;
-/**
- * Abstract class for the zkCloudWorker
- * Used to define the zkCloudWorker methods and properties
- * Should be implemented for by the developer for the zkCloudWorker in the cloud
- * @param cloud: the cloud
- */
-class zkCloudWorker {
-    /**
-     * Constructor for the zkCloudWorker class
-     * @param cloud the cloud instance provided by the zkCloudWorker in the local environment or in the cloud
-     */
-    constructor(cloud) {
-        this.cloud = cloud;
-    }
-    // Those methods should be implemented for recursive proofs calculations
-    /**
-     * Creates a new proof from a transaction
-     * @param transaction the transaction
-     * @returns the serialized proof
-     */
-    async create(transaction) {
-        return undefined;
-    }
-    /**
-     * Merges two proofs
-     * @param proof1 the first proof
-     * @param proof2 the second proof
-     * @returns the merged proof
-     */
-    async merge(proof1, proof2) {
-        return undefined;
-    }
-    // Those methods should be implemented for anything except for recursive proofs
-    /**
-     * Executes the transactions
-     * @param transactions the transactions, can be empty list
-     * @returns the result
-     */
-    async execute(transactions) {
-        return undefined;
-    }
-    /* Process the transactions received by the cloud
-     * @param transactions: the transactions
-     */
-    async processTransactions(transactions) { }
-    /**
-     * process the task defined by the developer
-     * @returns the result
-     */
-    async task() {
-        return undefined;
-    }
-}
-exports.zkCloudWorker = zkCloudWorker;

package/lib/ts/src/cloud/worker/index.d.ts

@@ -1,3 +1,5 @@
 export * from "./cloud";
 export * from "./job";
 export * from "./task";
+export * from "./transaction";
+export * from "./worker";

package/lib/ts/src/cloud/worker/index.js

@@ -17,3 +17,5 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./cloud"), exports);
 __exportStar(require("./job"), exports);
 __exportStar(require("./task"), exports);
+__exportStar(require("./transaction"), exports);
+__exportStar(require("./worker"), exports);

package/lib/ts/src/cloud/worker/transaction.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Human-readable transaction metadata
+ * events: the events
+ * actions: the actions
+ * custom: the custom metadata defined by the developer
+ */
+export interface TransactionMetadata {
+    events: object[];
+    actions: object[];
+    custom: object;
+}

package/lib/ts/src/cloud/worker/transaction.js

@@ -0,0 +1,8 @@
+"use strict";
+/**
+ * Human-readable transaction metadata
+ * events: the events
+ * actions: the actions
+ * custom: the custom metadata defined by the developer
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/ts/src/cloud/worker/worker.d.ts

@@ -0,0 +1,40 @@
+import { Cloud, CloudTransaction } from "./cloud";
+/**
+ * Abstract class for the zkCloudWorker
+ * Used to define the zkCloudWorker methods and properties
+ * Should be implemented for by the developer for the zkCloudWorker in the cloud
+ * @param cloud: the cloud
+ */
+export declare abstract class zkCloudWorker {
+    readonly cloud: Cloud;
+    /**
+     * Constructor for the zkCloudWorker class
+     * @param cloud the cloud instance provided by the zkCloudWorker in the local environment or in the cloud
+     */
+    constructor(cloud: Cloud);
+    /**
+     * Creates a new proof from a transaction
+     * @param transaction the transaction
+     * @returns the serialized proof
+     */
+    create(transaction: string): Promise<string | undefined>;
+    /**
+     * Merges two proofs
+     * @param proof1 the first proof
+     * @param proof2 the second proof
+     * @returns the merged proof
+     */
+    merge(proof1: string, proof2: string): Promise<string | undefined>;
+    /**
+     * Executes the transactions
+     * @param transactions the transactions, can be empty list
+     * @returns the result
+     */
+    execute(transactions: string[]): Promise<string | undefined>;
+    processTransactions(transactions: CloudTransaction[]): Promise<void>;
+    /**
+     * process the task defined by the developer
+     * @returns the result
+     */
+    task(): Promise<string | undefined>;
+}

package/lib/ts/src/cloud/worker/worker.js

@@ -0,0 +1,57 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.zkCloudWorker = void 0;
+/**
+ * Abstract class for the zkCloudWorker
+ * Used to define the zkCloudWorker methods and properties
+ * Should be implemented for by the developer for the zkCloudWorker in the cloud
+ * @param cloud: the cloud
+ */
+class zkCloudWorker {
+    /**
+     * Constructor for the zkCloudWorker class
+     * @param cloud the cloud instance provided by the zkCloudWorker in the local environment or in the cloud
+     */
+    constructor(cloud) {
+        this.cloud = cloud;
+    }
+    // Those methods should be implemented for recursive proofs calculations
+    /**
+     * Creates a new proof from a transaction
+     * @param transaction the transaction
+     * @returns the serialized proof
+     */
+    async create(transaction) {
+        return undefined;
+    }
+    /**
+     * Merges two proofs
+     * @param proof1 the first proof
+     * @param proof2 the second proof
+     * @returns the merged proof
+     */
+    async merge(proof1, proof2) {
+        return undefined;
+    }
+    // Those methods should be implemented for anything except for recursive proofs
+    /**
+     * Executes the transactions
+     * @param transactions the transactions, can be empty list
+     * @returns the result
+     */
+    async execute(transactions) {
+        return undefined;
+    }
+    /* Process the transactions received by the cloud
+     * @param transactions: the transactions
+     */
+    async processTransactions(transactions) { }
+    /**
+     * process the task defined by the developer
+     * @returns the result
+     */
+    async task() {
+        return undefined;
+    }
+}
+exports.zkCloudWorker = zkCloudWorker;

package/lib/ts/src/mina/index.d.ts

@@ -2,4 +2,4 @@ export * from "./api/api";
 export * from "./encryption";
 export * from "./utils";
 export * from "./local/local";
-export * from "./verification/verification";
+export * from "./verification";

package/lib/ts/src/mina/index.js

@@ -18,4 +18,4 @@ __exportStar(require("./api/api"), exports);
 __exportStar(require("./encryption"), exports);
 __exportStar(require("./utils"), exports);
 __exportStar(require("./local/local"), exports);
-__exportStar(require("./verification/verification"), exports);
+__exportStar(require("./verification"), exports);

package/lib/ts/src/mina/local/local.d.ts

@@ -1,9 +1,5 @@
 /// <reference types="node" />
-import { Cloud, zkCloudWorker } from "../../cloud";
-import { JobData, JobEvent } from "../../cloud";
-import { TaskData } from "../../cloud";
-import { blockchain } from "../../cloud";
-import { CloudTransaction, DeployerKeyPair } from "../../cloud";
+import { blockchain, TransactionMetadata, CloudTransaction, DeployerKeyPair, TaskData, JobData, JobEvent, Cloud, zkCloudWorker } from "../../cloud";
 import { ApiCommand } from "../api/api";
 /**
  * LocalCloud is a cloud that runs on the local machine for testing and development
@@ -89,6 +85,16 @@ export declare class LocalCloud extends Cloud {
      */
     deleteTransaction(txId: string): Promise<void>;
     getTransactions(): Promise<CloudTransaction[]>;
+    /**
+     * Publish the transaction metadata in human-readable format
+     * @param params
+     * @param params.txId the transaction id
+     * @param params.metadata the metadata
+     */
+    publishTransactionMetadata(params: {
+        txId: string;
+        metadata: TransactionMetadata;
+    }): Promise<void>;
     /**
      * Runs the worker in the local cloud
      * @param params the parameters to run the worker

package/lib/ts/src/mina/local/local.js

@@ -2,7 +2,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.LocalStorage = exports.LocalCloud = void 0;
 const cloud_1 = require("../../cloud");
-const cloud_2 = require("../../cloud");
 /**
  * LocalCloud is a cloud that runs on the local machine for testing and development
  * It uses LocalStorage to store jobs, tasks, transactions, and data
@@ -115,7 +114,7 @@ class LocalCloud extends cloud_1.Cloud {
         //const data =
         //  tx ?? JSON.stringify({ time: Date.now(), data: makeString(32) });
         //return stringHash(data);
-        return Date.now() + "." + (0, cloud_2.makeString)(32);
+        return Date.now() + "." + (0, cloud_1.makeString)(32);
     }
     /**
      * Send transactions to the local cloud
@@ -167,6 +166,15 @@ class LocalCloud extends cloud_1.Cloud {
         });
         return txs;
     }
+    /**
+     * Publish the transaction metadata in human-readable format
+     * @param params
+     * @param params.txId the transaction id
+     * @param params.metadata the metadata
+     */
+    async publishTransactionMetadata(params) {
+        console.log("publishTransactionMetadata:", params);
+    }
     /**
      * Runs the worker in the local cloud
      * @param params the parameters to run the worker

package/lib/ts/src/mina/verification/index.d.ts

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

package/lib/ts/src/mina/verification/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./verification"), exports);

package/lib/ts/src/mina/verification/verification.d.ts

@@ -12,8 +12,8 @@ import { SmartContract } from "o1js";
  */
 export interface VerificationData {
     contract: typeof SmartContract;
-    contractDependencies: (typeof SmartContract)[];
-    programDependencies: any[];
+    contractDependencies?: (typeof SmartContract)[];
+    programDependencies?: any[];
     address: string;
     chain: blockchain;
 }