@silvana-one/prover 0.2.0

package/dist/node/worker/cloud.d.ts

@@ -0,0 +1,250 @@
+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>;
+}

package/dist/node/worker/cloud.js

@@ -0,0 +1,54 @@
+/*
+ * 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
+ */
+export class Cloud {
+    /**
+     * 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) {
+        const { id, jobId, stepId, taskId, cache, developer, repo, task, userId, args, metadata, isLocalCloud, chain, } = params;
+        this.id = id;
+        this.jobId = jobId;
+        this.stepId = stepId;
+        this.taskId = taskId;
+        this.cache = cache;
+        this.developer = developer;
+        this.repo = repo;
+        this.task = task;
+        this.userId = userId;
+        this.args = args;
+        this.metadata = metadata;
+        this.isLocalCloud = isLocalCloud ?? false;
+        this.chain = chain;
+    }
+}
+//# sourceMappingURL=cloud.js.map

package/dist/node/worker/cloud.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cloud.js","sourceRoot":"","sources":["../../../src/worker/cloud.ts"],"names":[],"mappings":"AAmCA;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,OAAgB,KAAK;IAezB;;;;;;;;;;;;;;;;OAgBG;IACH,YAAY,MAcX;QACC,MAAM,EACJ,EAAE,EACF,KAAK,EACL,MAAM,EACN,MAAM,EACN,KAAK,EACL,SAAS,EACT,IAAI,EACJ,IAAI,EACJ,MAAM,EACN,IAAI,EACJ,QAAQ,EACR,YAAY,EACZ,KAAK,GACN,GAAG,MAAM,CAAC;QACX,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC;QACb,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,YAAY,GAAG,YAAY,IAAI,KAAK,CAAC;QAC1C,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;CAqMF"}

package/dist/node/worker/index.d.ts

@@ -0,0 +1,5 @@
+export * from "./cloud.js";
+export * from "./job.js";
+export * from "./task.js";
+export * from "./transaction.js";
+export * from "./worker.js";

package/dist/node/worker/index.js

@@ -0,0 +1,6 @@
+export * from "./cloud.js";
+export * from "./job.js";
+export * from "./task.js";
+export * from "./transaction.js";
+export * from "./worker.js";
+//# sourceMappingURL=index.js.map

package/dist/node/worker/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/worker/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC;AAC1B,cAAc,kBAAkB,CAAC;AACjC,cAAc,aAAa,CAAC"}

package/dist/node/worker/job.d.ts

@@ -0,0 +1,87 @@
+import { blockchain } from "../networks.js";
+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.
+ * @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'
+ * }
+ * ```
+ */
+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.
+ */
+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;
+}
+/**
+ * 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/dist/node/worker/job.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=job.js.map

package/dist/node/worker/job.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"job.js","sourceRoot":"","sources":["../../../src/worker/job.ts"],"names":[],"mappings":""}

package/dist/node/worker/task.d.ts

@@ -0,0 +1,32 @@
+import { blockchain } from "../networks.js";
+/**
+ * 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/dist/node/worker/task.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=task.js.map

package/dist/node/worker/task.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"task.js","sourceRoot":"","sources":["../../../src/worker/task.ts"],"names":[],"mappings":""}

package/dist/node/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/dist/node/worker/transaction.js

@@ -0,0 +1,8 @@
+/**
+ * Human-readable transaction metadata
+ * events: the events
+ * actions: the actions
+ * custom: the custom metadata defined by the developer
+ */
+export {};
+//# sourceMappingURL=transaction.js.map

package/dist/node/worker/transaction.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"transaction.js","sourceRoot":"","sources":["../../../src/worker/transaction.ts"],"names":[],"mappings":"AAAA;;;;;GAKG"}

package/dist/node/worker/worker.d.ts

@@ -0,0 +1,40 @@
+import { Cloud, CloudTransaction } from "./cloud.js";
+/**
+ * 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/dist/node/worker/worker.js

@@ -0,0 +1,53 @@
+/**
+ * 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 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;
+    }
+}
+//# sourceMappingURL=worker.js.map

package/dist/node/worker/worker.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"worker.js","sourceRoot":"","sources":["../../../src/worker/worker.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AACH,MAAM,OAAgB,aAAa;IAIjC;;;OAGG;IACH,YAAY,KAAY;QACtB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;IAED,wEAAwE;IACxE;;;;OAIG;IACH,KAAK,CAAC,MAAM,CAAC,WAAmB;QAC9B,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,KAAK,CAAC,MAAc,EAAE,MAAc;QACxC,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,+EAA+E;IAC/E;;;;OAIG;IACH,KAAK,CAAC,OAAO,CAAC,YAAsB;QAClC,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,mBAAmB,CAAC,YAAgC,IAAkB,CAAC;IAE7E;;;OAGG;IACH,KAAK,CAAC,IAAI;QACR,OAAO,SAAS,CAAC;IACnB,CAAC;CACF"}