@silvana-one/mina-prover 0.2.0

package/dist/node/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./api/api.js";
+export * from "./local/local.js";
+export * from "./verification/index.js";
+export * from "./tokens/index.js";

package/dist/node/index.js

@@ -0,0 +1,5 @@
+export * from "./api/api.js";
+export * from "./local/local.js";
+export * from "./verification/index.js";
+export * from "./tokens/index.js";
+//# sourceMappingURL=index.js.map

package/dist/node/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC;AAC7B,cAAc,kBAAkB,CAAC;AACjC,cAAc,yBAAyB,CAAC;AACxC,cAAc,mBAAmB,CAAC"}

package/dist/node/local/local.d.ts

@@ -0,0 +1,292 @@
+import { CloudTransaction, DeployerKeyPair, Cloud, JobData, JobEvent, TaskData, zkCloudWorker, TransactionMetadata, blockchain } from "@silvana-one/prover";
+import { ApiCommand } from "../api/api.js";
+/**
+ * LocalCloud is a cloud that runs on the local machine for testing and development
+ * It uses LocalStorage to store jobs, tasks, transactions, and data
+ * It uses a localWorker to execute the tasks
+ * It can be used to test the cloud functionality without deploying to the cloud
+ * @param localWorker the worker to execute the tasks
+ */
+export declare class LocalCloud extends Cloud {
+    readonly localWorker: (cloud: Cloud) => Promise<zkCloudWorker>;
+    /**
+     * Constructor for LocalCloud
+     * @param params the parameters to create the LocalCloud
+     * @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;
+        chain: blockchain;
+        cache?: string;
+        stepId?: string;
+        localWorker: (cloud: Cloud) => Promise<zkCloudWorker>;
+    });
+    /**
+     * Provides the deployer key pair for testing and development
+     * @returns the deployer key pair
+     */
+    getDeployer(): Promise<DeployerKeyPair | undefined>;
+    /**
+     * Releases the deployer key pair
+     */
+    releaseDeployer(params: {
+        publicKey: string;
+        txsHashes: string[];
+    }): Promise<void>;
+    /**
+     * Gets the data by key
+     * @param key the key to get the data
+     * @returns the data
+     */
+    getDataByKey(key: string): Promise<string | undefined>;
+    /**
+     * Saves the data by key
+     * @param key the key to save the data
+     * @param value the value to save
+     */
+    saveDataByKey(key: string, value: string | undefined): Promise<void>;
+    /**
+     * Saves the file
+     * @param filename the filename to save
+     * @param value the value to save
+     */
+    saveFile(filename: string, value: Buffer): Promise<void>;
+    /**
+     * Loads the file
+     * @param filename
+     * @returns the file data
+     */
+    loadFile(filename: string): Promise<Buffer | undefined>;
+    /**
+     * Encrypts the data
+     * @param params
+     * @param params.data the data
+     * @param params.context the context
+     * @param params.keyId the key id, optional
+     * @returns encrypted data
+     */
+    encrypt(params: {
+        data: string;
+        context: string;
+        keyId?: string;
+    }): Promise<string | undefined>;
+    /**
+     * Decrypts the data
+     * @param params
+     * @param params.data the data
+     * @param params.context the context
+     * @param params.keyId the key id, optional
+     * @returns
+     */
+    decrypt(params: {
+        data: string;
+        context: string;
+        keyId?: string;
+    }): Promise<string | undefined>;
+    /**
+     * Generates an id for local cloud
+     * @returns generated unique id
+     */
+    private static generateId;
+    /**
+     * Send transactions to the local cloud
+     * @param transactions the transactions to add
+     * @returns the transaction ids
+     */
+    sendTransactions(transactions: string[]): Promise<CloudTransaction[]>;
+    /**
+     * Adds transactions to the local cloud
+     * @param transactions the transactions to add
+     * @returns the transaction ids
+     */
+    static addTransactions(transactions: string[] | CloudTransaction[]): Promise<CloudTransaction[]>;
+    /**
+     * Deletes a transaction from the local cloud
+     * @param txId the transaction id to delete
+     */
+    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
+     * @param params.command the command to run
+     * @param params.data the data to use
+     * @param params.chain the blockchain to execute the job on
+     * @param params.localWorker the worker to execute the tasks
+     * @returns the job id
+     */
+    static run(params: {
+        command: ApiCommand;
+        data: {
+            developer: string;
+            repo: string;
+            transactions: string[];
+            task: string;
+            userId?: string;
+            args?: string;
+            metadata?: string;
+        };
+        chain: blockchain;
+        localWorker: (cloud: Cloud) => Promise<zkCloudWorker>;
+    }): Promise<string>;
+    /**
+     * Runs the recursive proof in the local cloud
+     * @param data the data to use
+     * @param data.transactions the transactions to process
+     * @param data.task the task to execute
+     * @param data.userId the user id
+     * @param data.args the arguments for the job
+     * @param data.metadata the metadata for the job
+     * @returns the job id
+     */
+    recursiveProof(data: {
+        transactions: string[];
+        task?: string;
+        userId?: string;
+        args?: string;
+        metadata?: string;
+    }): Promise<string>;
+    /**
+     * Executes the task in the local cloud
+     * @param data the data to use
+     * @param data.transactions the transactions to process
+     * @param data.task the task to execute
+     * @param data.userId the user id
+     * @param data.args the arguments for the job
+     * @param data.metadata the metadata for the job
+     * @returns the job id
+     */
+    execute(data: {
+        transactions: string[];
+        task: string;
+        userId?: string;
+        args?: string;
+        metadata?: string;
+    }): Promise<string>;
+    /**
+     * Gets the job result
+     * @param jobId the job id
+     * @returns the job data
+     */
+    jobResult(jobId: string): Promise<JobData | undefined>;
+    /**
+     * Adds a task to the local cloud
+     * @param data the data to use
+     * @param data.task the task to execute
+     * @param data.startTime the start time for the task
+     * @param data.userId the user id
+     * @param data.args the arguments for the job
+     * @param data.metadata the metadata for the job
+     * @returns the task id
+     */
+    addTask(data: {
+        task: string;
+        startTime?: number;
+        userId?: string;
+        args?: string;
+        metadata?: string;
+    }): Promise<string>;
+    /**
+     * Deletes a task from the local cloud
+     * @param taskId the task id to delete
+     */
+    deleteTask(taskId: string): Promise<void>;
+    /**
+     * Processes the tasks in the local cloud
+     */
+    processTasks(): Promise<void>;
+    /**
+     * Processes the local tasks
+     * @param params the parameters to process the local tasks
+     * @param params.developer the developer of the repo
+     * @param params.repo the repo
+     * @param params.localWorker the worker to execute the tasks
+     * @param params.chain the blockchain to execute the job on
+     */
+    static processLocalTasks(params: {
+        developer: string;
+        repo: string;
+        localWorker: (cloud: Cloud) => Promise<zkCloudWorker>;
+        chain: blockchain;
+    }): Promise<number>;
+    /**
+     * Runs the sequencer in the local cloud
+     * @param params the parameters to run the sequencer
+     * @param params.worker the worker to execute the tasks
+     * @param params.data the data to use
+     * @returns the proof
+     */
+    static sequencer(params: {
+        worker: zkCloudWorker;
+        data: {
+            developer: string;
+            repo: string;
+            transactions: string[];
+            task?: string;
+            userId?: string;
+            args?: string;
+            metadata?: string;
+        };
+    }): Promise<string>;
+    /**
+     * forces the worker to restart
+     */
+    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.
+ */
+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 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 from.
+     * @throws Error Method not implemented to keep web compatibility.
+     */
+    static loadData(name: string): Promise<void>;
+}