zkcloudworker 0.11.5 → 0.11.8

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

@@ -1,33 +1,27 @@
 export { blockchain, MinaNetwork, networks, Mainnet, Devnet, Zeko, Lightnet, Local, };
 /**
- * blockchain is the type for the chain id
- * @param local the local chain id
- * @param devnet the devnet chain id
- * @param lightnet the lightnet chain id
- * @param mainnet the mainnet chain id
- * @param zeko the zeko chain id
- * @param mainnet the mainnet chain id
+ * blockchain is the type for the chain ID.
  */
-type blockchain = "local" | "devnet" | "lightnet" | "mainnet" | "zeko" | "mainnet";
+type blockchain = "local" | "devnet" | "lightnet" | "mainnet" | "zeko";
 /**
- * MinaNetwork is the data structure for a Mina network, keeping track of the mina and archive endpoints, chain id, name, account manager, explorer account url, explorer transaction url, and faucet
- * @param mina the mina endpoints
- * @param archive the archive endpoints
- * @param chainId the chain id
- * @param name the name of the network
- * @param accountManager the account manager for Lightnet
- * @param explorerAccountUrl the explorer account url
- * @param explorerTransactionUrl the explorer transaction url
- * @param faucet the faucet url
+ * MinaNetwork is the data structure for a Mina network, keeping track of the Mina and archive endpoints, chain ID, name, account manager, explorer account URL, explorer transaction URL, and faucet.
  */
 interface MinaNetwork {
+    /** The Mina endpoints */
     mina: string[];
+    /** The archive endpoints */
     archive: string[];
+    /** The chain ID */
     chainId: blockchain;
+    /** The name of the network (optional) */
     name?: string;
+    /** The account manager for Lightnet (optional) */
     accountManager?: string;
+    /** The explorer account URL (optional) */
     explorerAccountUrl?: string;
+    /** The explorer transaction URL (optional) */
     explorerTransactionUrl?: string;
+    /** The faucet URL (optional) */
     faucet?: string;
 }
 declare const Mainnet: MinaNetwork;

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

@@ -1,28 +1,30 @@
 /// <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
- * Devnet and Zeko are supported
- * @param publicKey: the public key of the deployer
- * @param privateKey: the private key of the deployer
+ * Used to get the public and private keys of the deployer for test networks only.
+ * Devnet and Zeko are supported.
  */
 export interface DeployerKeyPair {
+    /** The public key of the deployer */
     publicKey: string;
+    /** The private key of the deployer */
     privateKey: string;
 }
 /**
  * Interface for the cloud transaction
  * Used to get the transaction id, the transaction, and the time received
- * @param txId: the transaction id
- * @param transaction: the transaction
- * @param timeReceived: the time received
  */
 export interface CloudTransaction {
+    /** The transaction id */
     txId: string;
+    /** The transaction */
     transaction: string;
+    /** The time received */
     timeReceived: number;
+    /** The status of the transaction */
     status: string;
 }
 export declare abstract class Cloud {
@@ -190,6 +192,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 +225,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/job.d.ts

@@ -1,85 +1,87 @@
 import { blockchain } from "../networks";
 export type JobStatus = "created" | "started" | "finished" | "failed" | "used" | "restarted";
 /**
- * LogStream is a subset of the log stream data returned by AWS CloudWatch Logs when running the worker
- * https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/cloudwatch-logs/command/GetLogEventsCommand/
- * example:
+ * LogStream is a subset of the log stream data returned by AWS CloudWatch Logs when running the worker.
+ * @see {@link https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/cloudwatch-logs/command/GetLogEventsCommand/}
+ *
+ * Example:
+ * ```
  * {
- * logGroupName: '/aws/lambda/zkcloudworker-dev-test',
- * logStreamName: '2024/05/09/[$LATEST]52d048f64e894d2e8ba2800df93629c5'
- * awsRequestId: '581d0d45-9165-47e8-84d9-678599938811',
+ *   logGroupName: '/aws/lambda/zkcloudworker-dev-test',
+ *   logStreamName: '2024/05/09/[$LATEST]52d048f64e894d2e8ba2800df93629c5',
+ *   awsRequestId: '581d0d45-9165-47e8-84d9-678599938811'
  * }
- * @param logGroupName the log group name
- * @param logStreamName the log stream name
- * @param awsRequestId the AWS request ID
+ * ```
  */
 export interface LogStream {
+    /** The log group name */
     logGroupName: string;
+    /** The log stream name */
     logStreamName: string;
+    /** The AWS request ID */
     awsRequestId: string;
 }
 /**
- * JobData is the data structure for a job, keeping track of the job status, result, logs, and metadata
- * @param id the id of the user
- * @param jobId the id of the job
- * @param taskId the id of the task
- *
- * @param developer the developer of the repo executing the job
- * @param repo the repo executing the job
- *
- * @param task the task to execute
- * @param userId the id of the user
- * @param args the arguments for the job
- * @param metadata the metadata for the job
- * @param chain the blockchain to execute the job on
- * @param filename the filename where transactions data is stored
- * @param txNumber the number of transactions
- * @param timeCreated the time the job was created
- * @param timeStarted the time the job was started
- * @param timeFinished the time the job was finished
- * @param timeFailed the time the job failed
- * @param timeUsed the time the job result was used
- * @param jobStatus the status of the job
- * @param billedDuration the duration the job was billed for in ms
- * @param logStreams the log streams of the job
- * @param logs the logs of the job
- * @param isFullLog whether the logs are full
+ * JobData is the data structure for a job, keeping track of the job status, result, logs, and metadata.
  */
 export interface JobData {
+    /** The ID of the user */
     id: string;
+    /** The ID of the job */
     jobId: string;
+    /** The ID of the task (optional) */
     taskId?: string;
+    /** The developer of the repo executing the job */
     developer: string;
+    /** The repo executing the job */
     repo: string;
+    /** The task to execute (optional) */
     task?: string;
+    /** The ID of the user (optional) */
     userId?: string;
+    /** The arguments for the job (optional) */
     args?: string;
+    /** The metadata for the job (optional) */
     metadata?: string;
+    /** The blockchain to execute the job on */
     chain: blockchain;
+    /** The filename where transactions data is stored (optional) */
     filename?: string;
+    /** The number of transactions */
     txNumber: number;
+    /** The time the job was created */
     timeCreated: number;
+    /** The time the job was started (optional) */
     timeStarted?: number;
+    /** The time the job was finished (optional) */
     timeFinished?: number;
+    /** The time the job failed (optional) */
     timeFailed?: number;
+    /** The time the job result was used (optional) */
     timeUsed?: number;
+    /** The status of the job */
     jobStatus: JobStatus;
+    /** The duration the job was billed for in ms (optional) */
     billedDuration?: number;
+    /** The result of the job (optional) */
     result?: string;
+    /** The log streams of the job (optional) */
     logStreams?: LogStream[];
+    /** The logs of the job (optional) */
     logs?: string[];
+    /** Whether the logs are full (optional) */
     isFullLog?: boolean;
 }
 /**
- * JobData is the data structure for a job, keeping track of the job status, result, logs, and metadata
- * @param jobId the id of the job
- * @param eventTime the time the event occurred
- * @param jobStatus the status of the job
- * @param result the result of the job
+ * JobEvent is the data structure for a job events, keeping track of the job status changes.
  */
 export interface JobEvent {
+    /** The ID of the job */
     jobId: string;
+    /** The time the event occurred */
     eventTime: number;
+    /** The status of the job */
     jobStatus: JobStatus;
+    /** The result of the job (optional) */
     result?: string;
 }

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

@@ -1,34 +1,32 @@
 import { blockchain } from "../networks";
 /**
- * TaskData is the data structure for a task, keeping track of the task status, result, logs, and metadata
- * @param id the id of the user
- * @param taskId the id of the task
- *
- * @param startTime the time the task was started
- * @param timeCreated the time the task was created
- * @param maxAttempts the maximum number of attempts
- * @param attempts the number of attempts
- *
- * @param developer the developer of the repo executing the task
- * @param repo the repo executing the task
- * @param task the task to execute
- * @param userId the id of the user
- * @param args the arguments for the task
- * @param metadata the metadata for the task
- * @param chain the blockchain to execute the task on
+ * TaskData is the data structure for a task, keeping track of the task status, result, logs, and metadata.
  */
 export interface TaskData {
+    /** The ID of the user */
     id: string;
+    /** The ID of the task */
     taskId: string;
+    /** The time the task was started (optional) */
     startTime?: number;
+    /** The time the task was created */
     timeCreated: number;
+    /** The maximum number of attempts (default is 5) (optional) */
     maxAttempts?: number;
+    /** The number of attempts */
     attempts: number;
+    /** The developer of the repo executing the task */
     developer: string;
+    /** The repo executing the task */
     repo: string;
+    /** The task to execute */
     task: string;
+    /** The ID of the user (optional) */
     userId?: string;
+    /** The arguments for the task (optional) */
     args?: string;
+    /** The metadata for the task (optional) */
     metadata?: string;
+    /** The blockchain to execute the task on */
     chain: blockchain;
 }

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
+ */
+export declare abstract class zkCloudWorker {
+    /**  cloud: the cloud instance */
+    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,56 @@
+"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
+ */
+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
@@ -217,41 +223,45 @@ export declare class LocalCloud extends Cloud {
     forceWorkerRestart(): Promise<void>;
 }
 /**
- * LocalStorage is a local storage for the local cloud
- * It stores jobs, tasks, transactions, and data
- * It can be used to test the cloud functionality without deploying to the cloud
- * @param jobs the jobs
- * @param data the data
- * @param transactions the transactions
- * @param tasks the tasks
+ * LocalStorage is a local storage for the local cloud.
+ * It stores jobs, tasks, transactions, and data.
+ * It can be used to test the cloud functionality without deploying to the cloud.
  */
 export declare class LocalStorage {
+    /** The jobs */
     static jobs: {
         [key: string]: JobData;
     };
+    /** The job events */
     static jobEvents: {
         [key: string]: JobEvent;
     };
+    /** The data */
     static data: {
         [key: string]: string;
     };
+    /** The files */
     static files: {
         [key: string]: Buffer;
     };
+    /** The transactions */
     static transactions: {
         [key: string]: CloudTransaction;
     };
+    /** The tasks */
     static tasks: {
         [key: string]: TaskData;
     };
     /**
-     * Saves the data
-     * @param name the name to save the data
+     * Saves the data.
+     * @param name The name to save the data under.
+     * @throws Error Method not implemented to keep web compatibility.
      */
     static saveData(name: string): Promise<void>;
     /**
-     * Loads the data
-     * @param name the name to load the data
+     * Loads the data.
+     * @param name The name to load the data from.
+     * @throws Error Method not implemented to keep web compatibility.
      */
     static loadData(name: string): Promise<void>;
 }