zkcloudworker 0.7.3 → 0.7.4

package/lib/ts/src/api/api.d.ts

@@ -28,10 +28,11 @@ export declare class zkCloudWorkerClient {
     readonly localWorker?: (cloud: Cloud) => Promise<zkCloudWorker>;
     /**
      * Constructor for the API class
-     * @param jwt The jwt token for authentication, get it at https://t.me/minanft_bot?start=auth
-     * @param zkcloudworker The local worker for the serverless api to test the code locally
-     * @param chain The blockchain network to use
-     * @param webhook The webhook for the serverless api to get the results
+     * @param params the parameters for the API class
+     * @param params.jwt The jwt token for authentication, get it at https://t.me/minanft_bot?start=auth
+     * @param params.zkcloudworker The local worker for the serverless api to test the code locally
+     * @param params.chain The blockchain network to use
+     * @param params.webhook The webhook for the serverless api to get the results
      */
     constructor(params: {
         jwt: string;

package/lib/ts/src/api/api.js

@@ -21,10 +21,11 @@ const { ZKCLOUDWORKER_AUTH, ZKCLOUDWORKER_API } = config_1.default;
 class zkCloudWorkerClient {
     /**
      * Constructor for the API class
-     * @param jwt The jwt token for authentication, get it at https://t.me/minanft_bot?start=auth
-     * @param zkcloudworker The local worker for the serverless api to test the code locally
-     * @param chain The blockchain network to use
-     * @param webhook The webhook for the serverless api to get the results
+     * @param params the parameters for the API class
+     * @param params.jwt The jwt token for authentication, get it at https://t.me/minanft_bot?start=auth
+     * @param params.zkcloudworker The local worker for the serverless api to test the code locally
+     * @param params.chain The blockchain network to use
+     * @param params.webhook The webhook for the serverless api to get the results
      */
     constructor(params) {
         const { jwt, zkcloudworker, chain, webhook } = params;

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

@@ -60,19 +60,20 @@ export declare abstract class Cloud {
     readonly isLocalCloud: boolean;
     /**
      * Constructor for the Cloud class
-     * @param id: the id of the user
-     * @param jobId: the job id
-     * @param stepId: the step id
-     * @param taskId: the task id
-     * @param cache: the cache folder. Use it to get the Cache object: cache = Cache.FileSystem(this.cloud.cache);
-     * @param developer: the developer id
-     * @param repo: the repo id
-     * @param task: the task id
-     * @param userId: the user id
-     * @param args: the arguments, should be a string or serialized JSON
-     * @param metadata: the metadata, should be a string or serialized JSON
-     * @param chain: the blockchain network
-     * @param isLocalCloud: a boolean to check if the cloud is local or not
+     * @param params the parameters for the Cloud class
+     * @param params.id the id of the user
+     * @param params.jobId the job id
+     * @param params.stepId the step id
+     * @param params.taskId the task id
+     * @param params.cache the cache folder. Use it to get the Cache object: cache = Cache.FileSystem(this.cloud.cache);
+     * @param params.developer the developer id
+     * @param params.repo the repo id
+     * @param params.task the task id
+     * @param params.userId the user id
+     * @param params.args the arguments, should be a string or serialized JSON
+     * @param params.metadata the metadata, should be a string or serialized JSON
+     * @param params.chain the blockchain network
+     * @param params.isLocalCloud a boolean to check if the cloud is local or not
      */
     constructor(params: {
         id: string;
@@ -98,10 +99,10 @@ export declare abstract class Cloud {
     abstract getDeployer(): Promise<DeployerKeyPair | undefined>;
     /**
      * Abstract method to release the deployer
-     * @param params: the public key of the deployer and the transactions hashes
+     * @param params the public key of the deployer and the transactions hashes
      * Used to release the deployer after the transactions are sent to the blockchain
-     * @param publicKey: the public key of the deployer
-     * @param txsHashes: the transactions hashes
+     * @param params.publicKey the public key of the deployer
+     * @param params.txsHashes the transactions hashes
      */
     abstract releaseDeployer(params: {
         publicKey: string;
@@ -110,46 +111,46 @@ export declare abstract class Cloud {
     /**
      * Abstract method to get the data by key
      * Used to get the data by key from the cloud storage
-     * @param key: the key
+     * @param key the key
      * @returns the value of the key
      */
     abstract getDataByKey(key: string): Promise<string | undefined>;
     /**
      * Abstract method to save the data by key
      * Used to save the data by key to the cloud storage
-     * @param key: the key
-     * @param value: the value
+     * @param key the key
+     * @param value the value
      */
     abstract saveDataByKey(key: string, value: string | undefined): Promise<void>;
     /**
      * Abstract method to save the file
      * Used to save the file to the cloud storage
-     * @param filename: the filename
-     * @param value: the value
+     * @param filename the filename
+     * @param value the value
      */
     abstract saveFile(filename: string, value: Buffer): Promise<void>;
     /**
      * Abstract method to load the file
      * Used to load the file from the cloud storage
-     * @param filename: the filename
+     * @param filename the filename
      * @returns the value of the file
      */
     abstract loadFile(filename: string): Promise<Buffer | undefined>;
     /**
      * Abstract method to load the environment
      * Used to load the environment from the cloud storage
-     * @param password: the password
+     * @param password the password
      */
     abstract loadEnvironment(password: string): Promise<void>;
     /**
      * Abstract method to calculate the recursive proof
      * Used to calculate the recursive proof
-     * @param data: the data
-     * @param data.transactions: the transactions
-     * @param data.task: the task
-     * @param data.userId: the user id
-     * @param data.args: the arguments
-     * @param data.metadata: the metadata
+     * @param data the data
+     * @param data.transactions the transactions
+     * @param data.task the task
+     * @param data.userId the user id
+     * @param data.args the arguments
+     * @param data.metadata the metadata
      * @returns the proof
      */
     abstract recursiveProof(data: {
@@ -162,12 +163,12 @@ export declare abstract class Cloud {
     /**
      * Abstract method to execute the transactions
      * Used to execute the transactions
-     * @param data: the data
-     * @param data.transactions: the transactions
-     * @param data.task: the task
-     * @param data.userId: the user id
-     * @param data.args: the arguments
-     * @param data.metadata: the metadata
+     * @param data the data
+     * @param data.transactions the transactions
+     * @param data.task the task
+     * @param data.userId the user id
+     * @param data.args the arguments
+     * @param data.metadata the metadata
      * @returns the result
      */
     abstract execute(data: {
@@ -180,13 +181,13 @@ export declare abstract class Cloud {
     /**
      * Abstract method to add the task
      * Used to add the task
-     * @param data: the data
-     * @param data.task: the task
-     * @param data.startTime: the start time
-     * @param data.userId: the user id
-     * @param data.args: the arguments
-     * @param data.metadata: the metadata
-     * @param data.maxAttempts: the maximum attempts
+     * @param data the data
+     * @param data.task the task
+     * @param data.startTime the start time
+     * @param data.userId the user id
+     * @param data.args the arguments
+     * @param data.metadata the metadata
+     * @param data.maxAttempts the maximum attempts
      * @returns the task id
      */
     abstract addTask(data: {
@@ -200,7 +201,7 @@ export declare abstract class Cloud {
     /**
      * Abstract method to delete the transaction
      * Used to delete the transaction
-     * @param txId: the transaction id
+     * @param txId the transaction id
      */
     abstract deleteTransaction(txId: string): Promise<void>;
     /**
@@ -212,7 +213,7 @@ export declare abstract class Cloud {
     /**
      * Abstract method to delete the task
      * Used to delete the task
-     * @param taskId: the task id
+     * @param taskId the task id
      */
     abstract deleteTask(taskId: string): Promise<void>;
     /**
@@ -222,7 +223,7 @@ export declare abstract class Cloud {
     /**
      * Abstract method to get the job result
      * Used to get the job result
-     * @param jobId: the job id
+     * @param jobId the job id
      * @returns the job result
      */
     abstract jobResult(jobId: string): Promise<JobData | undefined>;
@@ -237,7 +238,7 @@ 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
+     * @param cloud the cloud instance provided by the zkCloudWorker in the local environment or in the cloud
      */
     constructor(cloud: Cloud);
     /**
@@ -247,20 +248,20 @@ export declare abstract class zkCloudWorker {
     deployedContracts(): Promise<DeployedSmartContract[]>;
     /**
      * Creates a new proof from a transaction
-     * @param transaction: the 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
+     * @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
+     * @param transactions the transactions, can be empty list
      * @returns the result
      */
     execute(transactions: string[]): Promise<string | undefined>;

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

@@ -2,39 +2,40 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.zkCloudWorker = exports.Cloud = void 0;
 /*
- * Abstract class for the cloud
+ * Abstract class for the cloud service
  * Used to define the cloud methods and properties
  * Should be implemented by for local testing and for the zkCloudWorker in the cloud
- * @param id: the id of the user
- * @param jobId: the job id
- * @param stepId: the step id
- * @param taskId: the task id
- * @param cache: the cache folder. Use it to get the Cache object: cache = Cache.FileSystem(this.cloud.cache);
- * @param developer: the developer id
- * @param repo: the repo id
- * @param task: the task id
- * @param userId: the user id
- * @param args: the arguments, should be a string or serialized JSON
- * @param metadata: the metadata, should be a string or serialized JSON
- * @param chain: the blockchain network
- * @param isLocalCloud: a boolean to check if the cloud is local or not
+ * @param id the id of the user
+ * @param jobId the job id
+ * @param stepId the step id
+ * @param taskId the task id
+ * @param cache the cache folder. Use it to get the Cache object: cache = Cache.FileSystem(this.cloud.cache);
+ * @param developer the developer id
+ * @param repo the repo id
+ * @param task the task id
+ * @param userId the user id
+ * @param args the arguments, should be a string or serialized JSON
+ * @param metadata the metadata, should be a string or serialized JSON
+ * @param chain the blockchain network
+ * @param isLocalCloud a boolean to check if the cloud is local or not
  */
 class Cloud {
     /**
      * Constructor for the Cloud class
-     * @param id: the id of the user
-     * @param jobId: the job id
-     * @param stepId: the step id
-     * @param taskId: the task id
-     * @param cache: the cache folder. Use it to get the Cache object: cache = Cache.FileSystem(this.cloud.cache);
-     * @param developer: the developer id
-     * @param repo: the repo id
-     * @param task: the task id
-     * @param userId: the user id
-     * @param args: the arguments, should be a string or serialized JSON
-     * @param metadata: the metadata, should be a string or serialized JSON
-     * @param chain: the blockchain network
-     * @param isLocalCloud: a boolean to check if the cloud is local or not
+     * @param params the parameters for the Cloud class
+     * @param params.id the id of the user
+     * @param params.jobId the job id
+     * @param params.stepId the step id
+     * @param params.taskId the task id
+     * @param params.cache the cache folder. Use it to get the Cache object: cache = Cache.FileSystem(this.cloud.cache);
+     * @param params.developer the developer id
+     * @param params.repo the repo id
+     * @param params.task the task id
+     * @param params.userId the user id
+     * @param params.args the arguments, should be a string or serialized JSON
+     * @param params.metadata the metadata, should be a string or serialized JSON
+     * @param params.chain the blockchain network
+     * @param params.isLocalCloud a boolean to check if the cloud is local or not
      */
     constructor(params) {
         const { id, jobId, stepId, taskId, cache, developer, repo, task, userId, args, metadata, isLocalCloud, chain, } = params;
@@ -63,7 +64,7 @@ exports.Cloud = 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
+     * @param cloud the cloud instance provided by the zkCloudWorker in the local environment or in the cloud
      */
     constructor(cloud) {
         this.cloud = cloud;
@@ -78,7 +79,7 @@ class zkCloudWorker {
     // Those methods should be implemented for recursive proofs calculations
     /**
      * Creates a new proof from a transaction
-     * @param transaction: the transaction
+     * @param transaction the transaction
      * @returns the serialized proof
      */
     async create(transaction) {
@@ -86,8 +87,8 @@ class zkCloudWorker {
     }
     /**
      * Merges two proofs
-     * @param proof1: the first proof
-     * @param proof2: the second proof
+     * @param proof1 the first proof
+     * @param proof2 the second proof
      * @returns the merged proof
      */
     async merge(proof1, proof2) {
@@ -96,7 +97,7 @@ class zkCloudWorker {
     // Those methods should be implemented for anything except for recursive proofs
     /**
      * Executes the transactions
-     * @param transactions: the transactions, can be empty list
+     * @param transactions the transactions, can be empty list
      * @returns the result
      */
     async execute(transactions) {

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

@@ -17,11 +17,11 @@ export declare class LocalCloud extends Cloud {
     /**
      * Constructor for LocalCloud
      * @param params the parameters to create the LocalCloud
-     * @param job the job data
-     * @param chain the blockchain to execute the job on, can be any blockchain, not only local
-     * @param cache the cache folder
-     * @param stepId the step id
-     * @param localWorker the worker to execute the tasks
+     * @param params.job the job data
+     * @param params.chain the blockchain to execute the job on, can be any blockchain, not only local
+     * @param params.cache the cache folder
+     * @param params.stepId the step id
+     * @param params.localWorker the worker to execute the tasks
      */
     constructor(params: {
         job: JobData;

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

@@ -15,11 +15,11 @@ class LocalCloud extends cloud_1.Cloud {
     /**
      * Constructor for LocalCloud
      * @param params the parameters to create the LocalCloud
-     * @param job the job data
-     * @param chain the blockchain to execute the job on, can be any blockchain, not only local
-     * @param cache the cache folder
-     * @param stepId the step id
-     * @param localWorker the worker to execute the tasks
+     * @param params.job the job data
+     * @param params.chain the blockchain to execute the job on, can be any blockchain, not only local
+     * @param params.cache the cache folder
+     * @param params.stepId the step id
+     * @param params.localWorker the worker to execute the tasks
      */
     constructor(params) {
         const { job, chain, cache, stepId, localWorker } = params;