@silvana-one/prover

import { blockchain } from "../networks.js"; import { JobData } from "./job.js"; import { TransactionMetadata } from "./transaction.js"; /** * 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. */ 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 */ 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 { readonly id: string; readonly jobId: string; readonly stepId: string; readonly taskId: string; readonly cache: string; readonly developer: string; readonly repo: string; readonly task?: string; readonly userId?: string; readonly args?: string; readonly metadata?: string; readonly chain: blockchain; readonly isLocalCloud: boolean; /** * Constructor for the Cloud class * @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; jobId: string; stepId: string; taskId: string; cache: string; developer: string; repo: string; task?: string; userId?: string; args?: string; metadata?: string; isLocalCloud?: boolean; chain: blockchain; }); /** * Abstract method to get the deployer key pair * Used to get the public and private keys of the deployer for test networks only * Devnet and Zeko are supported * @returns the deployer key pair */ abstract getDeployer(): Promise<DeployerKeyPair | undefined>; /** * Abstract method to release the deployer * @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 params.publicKey the public key of the deployer * @param params.txsHashes the transactions hashes */ abstract releaseDeployer(params: { publicKey: string; txsHashes: string[]; }): Promise<void>; /** * Abstract method to get the data by key * Used to get the data by key from the cloud storage * @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 */ 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 */ 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 * @returns the value of the file */ abstract loadFile(filename: string): Promise<Buffer | undefined>; /** * Abstract method to encrypt the data * @param params * @param params.data the data * @param params.context the context * @param params.keyId the key id, optional */ abstract encrypt(params: { data: string; context: string; keyId?: string; }): Promise<string | undefined>; /** * Abstract method to decrypt the data * @param params * @param params.data the data * @param params.context the context * @param params.keyId the key id, optional */ abstract decrypt(params: { data: string; context: string; keyId?: string; }): Promise<string | undefined>; /** * 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 * @returns the proof */ abstract recursiveProof(data: { transactions: string[]; task?: string; userId?: string; args?: string; metadata?: string; }): Promise<string>; /** * 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 * @returns the result */ abstract execute(data: { transactions: string[]; task: string; userId?: string; args?: string; metadata?: string; }): Promise<string>; /** * 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 * @returns the task id */ abstract addTask(data: { task: string; startTime?: number; userId?: string; args?: string; metadata?: string; maxAttempts?: number; }): Promise<string>; /** * Abstract method to send the transactions * @param transactions */ abstract sendTransactions(transactions: string[] | CloudTransaction[]): Promise<CloudTransaction[]>; /** * Abstract method to delete the transaction * Used to delete the transaction * @param txId the transaction id */ abstract deleteTransaction(txId: string): Promise<void>; /** * Abstract method to get the transactions * Used to get the transactions * @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 * @param taskId the task id */ abstract deleteTask(taskId: string): Promise<void>; /** * Abstract method to process the tasks */ abstract processTasks(): Promise<void>; /** * Abstract method to get the job result * Used to get the job result * @param jobId the job id * @returns the job result */ abstract jobResult(jobId: string): Promise<JobData | undefined>; /** * forces the worker to restart the AWS lambda container * See https://github.com/o1-labs/o1js/issues/1651 */ abstract forceWorkerRestart(): Promise<void>; }