@silvana-one/mina-prover 0.2.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1 @@
+# Silvana Mina Prover

package/dist/node/api/api.d.ts

@@ -0,0 +1,211 @@
+import { zkCloudWorker, Cloud, JobData, blockchain } from "@silvana-one/prover";
+/**
+ * The APICommand type for interacting with the zkCloudWorker
+ * @typedef { "recursiveProof" | "execute" | "sendTransactions" | "jobResult" | "deploy" | "getBalance" | "queryBilling" } ApiCommand
+ * @property recursiveProof The command for the recursiveProof calculation
+ * @property execute The command for the execute function call (sync or async)
+ * @property sendTransactions The command for sending transactions to the cloud
+ * @property jobResult The command for getting the result of the job
+ * @property deploy The command for deploying the code to the cloud, it is recommended use CLI tools for deployment
+ * @property getBalance The command for getting the balance of the user's account with zkCloudWorker
+ * @property queryBilling The command for getting the billing report of the user's account with zkCloudWorker
+ */
+export type ApiCommand = "recursiveProof" | "execute" | "sendTransactions" | "jobResult" | "deploy" | "getBalance" | "queryBilling";
+/**
+ * API class for interacting with the zkCloudWorker
+ * @property jwt The jwt token for authentication, get it at https://t.me/minanft_bot?start=auth
+ * @property endpoint The endpoint of the serverless api
+ * @property chain The blockchain network to use
+ * @property webhook The webhook for the serverless api to get the results
+ * @property localWorker The local worker for the serverless api to test the code locally
+ */
+export declare class zkCloudWorkerClient {
+    readonly jwt: string;
+    readonly endpoint?: string;
+    readonly chain: blockchain;
+    readonly webhook?: string;
+    readonly localWorker?: (cloud: Cloud) => Promise<zkCloudWorker>;
+    /**
+     * Constructor for the API class
+     * @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;
+        zkcloudworker?: (cloud: Cloud) => Promise<zkCloudWorker>;
+        chain?: blockchain;
+        webhook?: string;
+    });
+    /**
+     * Starts a new job for the proof calculation using serverless api call
+     * @param data the data for the proof call
+     * @param data.developer the developer
+     * @param data.repo the repo to use
+     * @param data.transactions the transactions
+     * @param data.task the task of the job
+     * @param data.userId the userId of the job
+     * @param data.args the arguments of the job, should be serialized JSON or string
+     * @param data.metadata the metadata of the job, should be serialized JSON or string
+     * @param data.webhook the webhook for the job
+     * @returns { success: boolean, error?: string, jobId?: string }
+     * where jonId is the jobId of the job
+     *
+     * The developers repo should provide a zkcloudworker function
+     * that can be called with the given parameters, see the examples
+     */
+    recursiveProof(data: {
+        developer: string;
+        repo: string;
+        transactions: string[];
+        task?: string;
+        userId?: string;
+        args?: string;
+        metadata?: string;
+        webhook?: string;
+    }): Promise<{
+        success: boolean;
+        error?: string;
+        jobId?: string;
+    }>;
+    /**
+     * Starts a new job for the function call using serverless api call
+     * @param data the data for the proof call
+     * @param data.developer the developer
+     * @param data.repo the repo to use
+     * @param data.transactions the transactions
+     * @param data.task the task of the job
+     * @param data.userId the userId of the job
+     * @param data.args the arguments of the job
+     * @param data.metadata the metadata of the job
+     * @param data.mode the mode of the job execution: "sync" will not create a job, it will execute the function synchronously within 30 seconds and with the memory limit of 256 MB
+     * @returns { success: boolean, error?: string, jobId?: string, result?: any }
+     * where jonId is the jobId of the job (for async calls), result is the result of the job (for sync calls)
+     */
+    execute(data: {
+        developer: string;
+        repo: string;
+        transactions: string[];
+        task: string;
+        userId?: string;
+        args?: string;
+        metadata?: string;
+        mode?: string;
+    }): Promise<{
+        success: boolean;
+        error?: string;
+        jobId?: string;
+        result?: any;
+    }>;
+    /**
+     * Sends transactions to the blockchain using serverless api call
+     * @param data the data for the proof call
+     * @param data.developer the developer
+     * @param data.repo the repo to use
+     * @param data.transactions the transactions
+     * @returns { success: boolean, error?: string, txId?: string[] }
+     * where txId is the transaction id of the transaction, in the sequence of the input transactions
+     */
+    sendTransactions(data: {
+        developer: string;
+        repo: string;
+        transactions: string[];
+    }): Promise<{
+        success: boolean;
+        error?: string;
+        txId?: string[];
+    }>;
+    /**
+     * Gets the result of the job using serverless api call
+     * @param data the data for the jobResult call
+     * @param data.jobId the jobId of the job
+     * @param data.includeLogs include logs in the result, default is false
+     * @returns { success: boolean, error?: string, result?: any }
+     * where result is the result of the job
+     * if the job is not finished yet, the result will be undefined
+     * if the job failed, the result will be undefined and error will be set
+     * if the job is finished, the result will be set and error will be undefined
+     * if the job is not found, the result will be undefined and error will be set
+     */
+    jobResult(data: {
+        jobId: string;
+        includeLogs?: boolean;
+    }): Promise<{
+        success: false;
+        error?: string;
+        result?: string;
+    } | {
+        success: true;
+        error?: string;
+        result: JobData;
+    }>;
+    /**
+     * Deploys the code to the cloud using serverless api call
+     * @param data the data for the deploy call
+     * @param data.repo the repo to use
+     * @param data.developer the developer
+     * @param data.packageManager the package manager to use
+     * @returns { success: boolean, error?: string, jobId?: string}
+     * where jobId is the jobId of the job
+     */
+    deploy(data: {
+        repo: string;
+        developer: string;
+        packageManager: string;
+    }): Promise<{
+        success: boolean;
+        error?: string;
+        jobId?: string;
+    }>;
+    /**
+     * Gets the billing report for the jobs sent using JWT
+     * @returns { success: boolean, error?: string, result?: any }
+     * where result is the billing report
+     */
+    queryBilling(): Promise<{
+        success: boolean;
+        error?: string;
+        result?: any;
+    }>;
+    /**
+     * Gets the remaining balance
+     * @returns { success: boolean, error?: string, result?: any }
+     * where result is the balance
+     */
+    getBalance(): Promise<{
+        success: boolean;
+        error?: string;
+        result?: any;
+    }>;
+    /**
+     * Waits for the job to finish
+     * @param data the data for the waitForJobResult call
+     * @param data.jobId the jobId of the job
+     * @param data.maxAttempts the maximum number of attempts, default is 360 (2 hours)
+     * @param data.interval the interval between attempts, default is 20000 (20 seconds)
+     * @param data.maxErrors the maximum number of network errors, default is 10
+     * @param data.printLogs print logs, default is true
+     * @returns { success: boolean, error?: string, result?: any }
+     * where result is the result of the job
+     */
+    waitForJobResult(data: {
+        jobId: string;
+        maxAttempts?: number;
+        interval?: number;
+        maxErrors?: number;
+        printLogs?: boolean;
+    }): Promise<{
+        success: boolean;
+        error?: string;
+        result?: any;
+    }>;
+    /**
+     * Calls the serverless API
+     * @param command the command of the API
+     * @param data the data of the API
+     * */
+    private apiHub;
+    private isError;
+}