zkcloudworker 0.1.0 → 0.1.2

package/lib/web/src/api/api.js

@@ -74,6 +74,33 @@ export class zkCloudWorker {
                 };
         });
     }
+    /**
+     * Gets the result of the job using serverless api call
+     * @param data the data for the deploy call
+     * @param data.packageName the name of the zip file with the code to be deployed
+     * @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
+     */
+    deploy(data) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const result = yield this.apiHub("deploy", data);
+            if (result.data === "error")
+                return {
+                    success: false,
+                    error: result.error,
+                };
+            else
+                return {
+                    success: result.success,
+                    jobId: result.data,
+                    error: result.error,
+                };
+        });
+    }
     /**
      * Gets the billing report for the jobs sent using JWT
      * @returns { success: boolean, error?: string, result?: any }

package/lib/web/src/api/api.js.map

@@ -1 +1 @@
-{"version":3,"file":"api.js","sourceRoot":"","sources":["../../../../../src/api/api.ts"],"names":[],"mappings":";AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAChC,OAAO,MAAM,MAAM,WAAW,CAAC;AAC/B,MAAM,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,GAAG,MAAM,CAAC;AAEzD;;;;GAIG;AACH,MAAM,OAAO,aAAa;IAIxB;;;OAGG;IACH,YAAY,GAAW;QACrB,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,QAAQ,GAAG,iBAAiB,CAAC;IACpC,CAAC;IAED;;;;;;;;;;;;OAYG;IACU,SAAS,CAAC,IAMtB;;YAKC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;YACpD,IAAI,MAAM,CAAC,IAAI,KAAK,OAAO;gBACzB,OAAO;oBACL,OAAO,EAAE,KAAK;oBACd,KAAK,EAAE,MAAM,CAAC,KAAK;iBACpB,CAAC;;gBAEF,OAAO;oBACL,OAAO,EAAE,MAAM,CAAC,OAAO;oBACvB,KAAK,EAAE,MAAM,CAAC,IAAI;oBAClB,KAAK,EAAE,MAAM,CAAC,KAAK;iBACpB,CAAC;QACN,CAAC;KAAA;IAED;;;;;;;;;;OAUG;IACU,SAAS,CAAC,IAAuB;;YAM5C,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;YACpD,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC;gBAC3B,OAAO;oBACL,OAAO,EAAE,KAAK;oBACd,KAAK,EAAE,MAAM,CAAC,KAAK;oBACnB,MAAM,EAAE,MAAM,CAAC,IAAI;iBACpB,CAAC;;gBAEF,OAAO;oBACL,OAAO,EAAE,MAAM,CAAC,OAAO;oBACvB,KAAK,EAAE,MAAM,CAAC,KAAK;oBACnB,MAAM,EAAE,MAAM,CAAC,IAAI;iBACpB,CAAC;QACN,CAAC;KAAA;IAED;;;;OAIG;IACU,YAAY;;YAMvB,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC;YACrD,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC;gBAC3B,OAAO;oBACL,OAAO,EAAE,KAAK;oBACd,KAAK,EAAE,MAAM,CAAC,KAAK;oBACnB,MAAM,EAAE,MAAM,CAAC,IAAI;iBACpB,CAAC;;gBAEF,OAAO;oBACL,OAAO,EAAE,MAAM,CAAC,OAAO;oBACvB,KAAK,EAAE,MAAM,CAAC,KAAK;oBACnB,MAAM,EAAE,MAAM,CAAC,IAAI;iBACpB,CAAC;QACN,CAAC;KAAA;IAED;;;;;;;;;OASG;IACU,gBAAgB,CAAC,IAK7B;;;YAMC,MAAM,WAAW,GAAG,MAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,WAAW,mCAAI,GAAG,CAAC,CAAC,UAAU;YACxD,MAAM,QAAQ,GAAG,MAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,QAAQ,mCAAI,KAAK,CAAC;YACzC,MAAM,SAAS,GAAG,MAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,SAAS,mCAAI,EAAE,CAAC;YACxC,MAAM,UAAU,GAAG,KAAK,CAAC,CAAC,aAAa;YACvC,IAAI,QAAQ,GAAG,CAAC,CAAC;YACjB,IAAI,MAAM,GAAG,CAAC,CAAC;YACf,OAAO,QAAQ,GAAG,WAAW,EAAE,CAAC;gBAC9B,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;gBACpD,IAAI,MAAM,CAAC,OAAO,KAAK,KAAK,EAAE,CAAC;oBAC7B,MAAM,EAAE,CAAC;oBACT,IAAI,MAAM,GAAG,SAAS,EAAE,CAAC;wBACvB,OAAO;4BACL,OAAO,EAAE,KAAK;4BACd,KAAK,EAAE,yBAAyB;4BAChC,MAAM,EAAE,SAAS;yBAClB,CAAC;oBACJ,CAAC;oBACD,MAAM,KAAK,CAAC,UAAU,GAAG,MAAM,CAAC,CAAC;gBACnC,CAAC;qBAAM,CAAC;oBACN,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC;wBAC3B,OAAO;4BACL,OAAO,EAAE,KAAK;4BACd,KAAK,EAAE,MAAM,CAAC,KAAK;4BACnB,MAAM,EAAE,MAAM,CAAC,IAAI;yBACpB,CAAC;yBACC,IAAI,CAAA,MAAA,MAAM,CAAC,IAAI,0CAAE,MAAM,MAAK,SAAS,EAAE,CAAC;wBAC3C,OAAO;4BACL,OAAO,EAAE,MAAM,CAAC,OAAO;4BACvB,KAAK,EAAE,MAAM,CAAC,KAAK;4BACnB,MAAM,EAAE,MAAM,CAAC,IAAI;yBACpB,CAAC;oBACJ,CAAC;oBACD,MAAM,KAAK,CAAC,QAAQ,CAAC,CAAC;gBACxB,CAAC;gBACD,QAAQ,EAAE,CAAC;YACb,CAAC;YACD,OAAO;gBACL,OAAO,EAAE,KAAK;gBACd,KAAK,EAAE,SAAS;gBAChB,MAAM,EAAE,SAAS;aAClB,CAAC;;KACH;IAED;;;;SAIK;IACS,MAAM,CAClB,OAAe;IACf,8DAA8D;IAC9D,IAAS;IACT,8DAA8D;;;YAE9D,MAAM,OAAO,GAAG;gBACd,IAAI,EAAE,kBAAkB;gBACxB,OAAO,EAAE,OAAO;gBAChB,QAAQ,EAAE,IAAI,CAAC,GAAG;gBAClB,IAAI,EAAE,IAAI;aACX,CAAC;YAEF,IAAI,CAAC;gBACH,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;gBAC1D,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,CAAC,IAAI,EAAE,CAAC;YAChD,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,OAAO,CAAC,KAAK,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;gBAClC,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC;YAC1C,CAAC;QACH,CAAC;KAAA;IAED,8DAA8D;IACtD,OAAO,CAAC,IAAS;QACvB,IAAI,IAAI,KAAK,OAAO;YAAE,OAAO,IAAI,CAAC;QAClC,IAAI,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,SAAS,MAAK,QAAQ;YAAE,OAAO,IAAI,CAAC;QAC9C,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC;YACpE,OAAO,IAAI,CAAC;QACd,OAAO,KAAK,CAAC;IACf,CAAC;CACF"}
+{"version":3,"file":"api.js","sourceRoot":"","sources":["../../../../../src/api/api.ts"],"names":[],"mappings":";AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAChC,OAAO,MAAM,MAAM,WAAW,CAAC;AAC/B,MAAM,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,GAAG,MAAM,CAAC;AAEzD;;;;GAIG;AACH,MAAM,OAAO,aAAa;IAIxB;;;OAGG;IACH,YAAY,GAAW;QACrB,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,QAAQ,GAAG,iBAAiB,CAAC;IACpC,CAAC;IAED;;;;;;;;;;;;OAYG;IACU,SAAS,CAAC,IAMtB;;YAKC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;YACpD,IAAI,MAAM,CAAC,IAAI,KAAK,OAAO;gBACzB,OAAO;oBACL,OAAO,EAAE,KAAK;oBACd,KAAK,EAAE,MAAM,CAAC,KAAK;iBACpB,CAAC;;gBAEF,OAAO;oBACL,OAAO,EAAE,MAAM,CAAC,OAAO;oBACvB,KAAK,EAAE,MAAM,CAAC,IAAI;oBAClB,KAAK,EAAE,MAAM,CAAC,KAAK;iBACpB,CAAC;QACN,CAAC;KAAA;IAED;;;;;;;;;;OAUG;IACU,SAAS,CAAC,IAAuB;;YAM5C,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;YACpD,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC;gBAC3B,OAAO;oBACL,OAAO,EAAE,KAAK;oBACd,KAAK,EAAE,MAAM,CAAC,KAAK;oBACnB,MAAM,EAAE,MAAM,CAAC,IAAI;iBACpB,CAAC;;gBAEF,OAAO;oBACL,OAAO,EAAE,MAAM,CAAC,OAAO;oBACvB,KAAK,EAAE,MAAM,CAAC,KAAK;oBACnB,MAAM,EAAE,MAAM,CAAC,IAAI;iBACpB,CAAC;QACN,CAAC;KAAA;IAED;;;;;;;;;;OAUG;IACU,MAAM,CAAC,IAA6B;;YAK/C,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;YACjD,IAAI,MAAM,CAAC,IAAI,KAAK,OAAO;gBACzB,OAAO;oBACL,OAAO,EAAE,KAAK;oBACd,KAAK,EAAE,MAAM,CAAC,KAAK;iBACpB,CAAC;;gBAEF,OAAO;oBACL,OAAO,EAAE,MAAM,CAAC,OAAO;oBACvB,KAAK,EAAE,MAAM,CAAC,IAAI;oBAClB,KAAK,EAAE,MAAM,CAAC,KAAK;iBACpB,CAAC;QACN,CAAC;KAAA;IAED;;;;OAIG;IACU,YAAY;;YAMvB,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC;YACrD,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC;gBAC3B,OAAO;oBACL,OAAO,EAAE,KAAK;oBACd,KAAK,EAAE,MAAM,CAAC,KAAK;oBACnB,MAAM,EAAE,MAAM,CAAC,IAAI;iBACpB,CAAC;;gBAEF,OAAO;oBACL,OAAO,EAAE,MAAM,CAAC,OAAO;oBACvB,KAAK,EAAE,MAAM,CAAC,KAAK;oBACnB,MAAM,EAAE,MAAM,CAAC,IAAI;iBACpB,CAAC;QACN,CAAC;KAAA;IAED;;;;;;;;;OASG;IACU,gBAAgB,CAAC,IAK7B;;;YAMC,MAAM,WAAW,GAAG,MAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,WAAW,mCAAI,GAAG,CAAC,CAAC,UAAU;YACxD,MAAM,QAAQ,GAAG,MAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,QAAQ,mCAAI,KAAK,CAAC;YACzC,MAAM,SAAS,GAAG,MAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,SAAS,mCAAI,EAAE,CAAC;YACxC,MAAM,UAAU,GAAG,KAAK,CAAC,CAAC,aAAa;YACvC,IAAI,QAAQ,GAAG,CAAC,CAAC;YACjB,IAAI,MAAM,GAAG,CAAC,CAAC;YACf,OAAO,QAAQ,GAAG,WAAW,EAAE,CAAC;gBAC9B,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;gBACpD,IAAI,MAAM,CAAC,OAAO,KAAK,KAAK,EAAE,CAAC;oBAC7B,MAAM,EAAE,CAAC;oBACT,IAAI,MAAM,GAAG,SAAS,EAAE,CAAC;wBACvB,OAAO;4BACL,OAAO,EAAE,KAAK;4BACd,KAAK,EAAE,yBAAyB;4BAChC,MAAM,EAAE,SAAS;yBAClB,CAAC;oBACJ,CAAC;oBACD,MAAM,KAAK,CAAC,UAAU,GAAG,MAAM,CAAC,CAAC;gBACnC,CAAC;qBAAM,CAAC;oBACN,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC;wBAC3B,OAAO;4BACL,OAAO,EAAE,KAAK;4BACd,KAAK,EAAE,MAAM,CAAC,KAAK;4BACnB,MAAM,EAAE,MAAM,CAAC,IAAI;yBACpB,CAAC;yBACC,IAAI,CAAA,MAAA,MAAM,CAAC,IAAI,0CAAE,MAAM,MAAK,SAAS,EAAE,CAAC;wBAC3C,OAAO;4BACL,OAAO,EAAE,MAAM,CAAC,OAAO;4BACvB,KAAK,EAAE,MAAM,CAAC,KAAK;4BACnB,MAAM,EAAE,MAAM,CAAC,IAAI;yBACpB,CAAC;oBACJ,CAAC;oBACD,MAAM,KAAK,CAAC,QAAQ,CAAC,CAAC;gBACxB,CAAC;gBACD,QAAQ,EAAE,CAAC;YACb,CAAC;YACD,OAAO;gBACL,OAAO,EAAE,KAAK;gBACd,KAAK,EAAE,SAAS;gBAChB,MAAM,EAAE,SAAS;aAClB,CAAC;;KACH;IAED;;;;SAIK;IACS,MAAM,CAClB,OAAe;IACf,8DAA8D;IAC9D,IAAS;IACT,8DAA8D;;;YAE9D,MAAM,OAAO,GAAG;gBACd,IAAI,EAAE,kBAAkB;gBACxB,OAAO,EAAE,OAAO;gBAChB,QAAQ,EAAE,IAAI,CAAC,GAAG;gBAClB,IAAI,EAAE,IAAI;aACX,CAAC;YAEF,IAAI,CAAC;gBACH,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;gBAC1D,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,CAAC,IAAI,EAAE,CAAC;YAChD,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,OAAO,CAAC,KAAK,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;gBAClC,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC;YAC1C,CAAC;QACH,CAAC;KAAA;IAED,8DAA8D;IACtD,OAAO,CAAC,IAAS;QACvB,IAAI,IAAI,KAAK,OAAO;YAAE,OAAO,IAAI,CAAC;QAClC,IAAI,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,SAAS,MAAK,QAAQ;YAAE,OAAO,IAAI,CAAC;QAC9C,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC;YACpE,OAAO,IAAI,CAAC;QACd,OAAO,KAAK,CAAC;IACf,CAAC;CACF"}

package/lib/web/src/api/client-api.d.ts

@@ -0,0 +1,147 @@
+/**
+ * Client API for calling the zkCloudWorker
+ */
+export { TxnPayload, IsError, SerializedTxn, SignedSerializedTxn, TxnResult, JobPayload, JobResult, zkCloudWorkerAPI, };
+interface TxnPayload {
+    data: object;
+    options?: object;
+}
+interface IsError {
+    code: number;
+    message: string;
+    exception: any;
+}
+interface SerializedTxn {
+    hash: string | null;
+    transaction: any | null;
+    error: IsError | null;
+}
+interface SignedSerializedTxn {
+    hash: string | null;
+    transaction: any | null;
+    error: IsError | null;
+}
+interface TxnResult {
+    hash: string | null;
+    data: any | null;
+    error: IsError | null;
+}
+interface JobPayload {
+    data: object;
+    options?: object;
+}
+interface JobResult {
+    data: any | null;
+    error: IsError | null;
+}
+declare class zkCloudWorkerAPI {
+    private API_KEY;
+    constructor(apiKey: string);
+    /**
+     * prove() sign() and send()
+     *
+     * The called cloud worker is expected to compile the needed Contract,
+     * create the transaction, prove it and send it back serialized.
+     *
+     * Then the serialized transaction can be signed locally using AuroWallet
+     * and finally send it to MINA using the cloud worker.
+     *
+     * IMPORTANT: the transaction fee  will be paid by the local sender, using
+     * the Auro Wallet at the moment of signing the serialized transaction.
+     *
+     * We only need the sender public key to create and prove the transaction.
+     * The sender private key NEVER leaves the local wallet.
+     *
+     * Example:
+     * ~~~
+     *  let zkWorker = new ZKRunner(API_KEY);
+     *
+     *  let serializedTxn = await zkWorker.prove('batch-voting-...', {
+     *    data: {
+     *      claimUid: '012345...789',
+     *      // ...
+     *    },
+     *    options: {
+     *      senderAddress: 'B62...',
+     *      fee: MIN_FEE // MAX_FEE | AUTO_FEE | number
+     *    }
+     *  });
+     *  if (serializedTxn.error)
+     *    // treat error here
+     *
+     *  let signedTxn = await zkWorker.sign(signerAddress, serializedTxn);
+     *  if (signedTxn.error)
+     *    // treat error here
+     *
+     *  let txnResult = await zkWorker.send(signedTxn) ;
+     *  if (txnResult.error)
+     *    // treat error here
+     * ~~~
+     */
+    prove(jobName: string, payload: TxnPayload): Promise<void>;
+    sign(signerAddress: string, serializedTxn: SerializedTxn): Promise<void>;
+    send(txn: SignedSerializedTxn): Promise<void>;
+    /**
+     * proveAndSend()
+     *
+     * The called cloud worker is expected to do all: compile the needed Contract,
+     * create the transaction, prove it, sign it using one of the available
+     * fee payers, and finally send it to MINA.
+     *
+     * IMPORTANT: the transaction fee  will be paid by the first fee payer
+     * available from the list of fee payers provided by the ZKRunner service.
+     * Also the fee will be set by the cloud worker using some optimal algorithm
+     * that minimizes fees.
+     *
+     * In this case the sender public key to create and prove the transaction
+     * will be the selected ZKRunner fee payer previously mentioned.
+     *
+     * Example:
+     * ~~~
+     *  let zkWorker = new ZKRunner(API_KEY);
+     *
+     *  let txnResult = await zkWorker.proveAndSend('batch-voting-...', {
+     *    data: {
+     *      claimUid: '012345...789',
+     *      // ...
+     *    }
+     *  });
+     *
+     *  if (txnResult.error)
+     *    // treat error here
+     * ~~~
+     */
+    proveAndSend(jobName: string, payload: TxnPayload): Promise<void>;
+    /**
+     * runJob()
+     *
+     * The called cloud worker can also be used to easily run jobs not related to
+     * a MINA transaction, and will act just like any serverless function.
+     *
+     * This "generic" job can benefit from the easy to use deploy and call service
+     * already implemented for cloud proving without no extra costs.
+     *
+     * IMPORTANT: there will be a small fee that needs to be paid for service usage,
+     * but no MINA fees need to be paid.
+     *
+     * Example:
+     * ~~~
+     *  let zkWorker = new ZKRunner(API_KEY);
+     *
+     *  let jobResult = await zkWorker.runJob('send-email-to-judges', {
+     *    data: {
+     *      judges: [
+     *        // ...
+     *      ],
+     *    },
+     *    options: {
+     *      // ...
+     *    }
+     *  });
+     *
+     *  if (txnResult.error)
+     *    // treat error here
+     * ~~~
+     */
+    runJob(jobName: string, payload: JobPayload): Promise<void>;
+}

package/lib/web/src/api/client-api.js

@@ -0,0 +1,134 @@
+import { __awaiter } from "tslib";
+/**
+ * Client API for calling the zkCloudWorker
+ */
+export { zkCloudWorkerAPI, };
+class zkCloudWorkerAPI {
+    constructor(apiKey) {
+        this.API_KEY = "";
+        this.API_KEY = apiKey;
+    }
+    /**
+     * prove() sign() and send()
+     *
+     * The called cloud worker is expected to compile the needed Contract,
+     * create the transaction, prove it and send it back serialized.
+     *
+     * Then the serialized transaction can be signed locally using AuroWallet
+     * and finally send it to MINA using the cloud worker.
+     *
+     * IMPORTANT: the transaction fee  will be paid by the local sender, using
+     * the Auro Wallet at the moment of signing the serialized transaction.
+     *
+     * We only need the sender public key to create and prove the transaction.
+     * The sender private key NEVER leaves the local wallet.
+     *
+     * Example:
+     * ~~~
+     *  let zkWorker = new ZKRunner(API_KEY);
+     *
+     *  let serializedTxn = await zkWorker.prove('batch-voting-...', {
+     *    data: {
+     *      claimUid: '012345...789',
+     *      // ...
+     *    },
+     *    options: {
+     *      senderAddress: 'B62...',
+     *      fee: MIN_FEE // MAX_FEE | AUTO_FEE | number
+     *    }
+     *  });
+     *  if (serializedTxn.error)
+     *    // treat error here
+     *
+     *  let signedTxn = await zkWorker.sign(signerAddress, serializedTxn);
+     *  if (signedTxn.error)
+     *    // treat error here
+     *
+     *  let txnResult = await zkWorker.send(signedTxn) ;
+     *  if (txnResult.error)
+     *    // treat error here
+     * ~~~
+     */
+    prove(jobName, payload //: Promise < SerializedTxn > {
+    ) {
+        return __awaiter(this, void 0, void 0, function* () { });
+    }
+    sign(signerAddress, serializedTxn //: Promise<SignedSerializedTxn> {
+    ) {
+        return __awaiter(this, void 0, void 0, function* () { });
+    }
+    send(txn //: Promise<TxnResult> {
+    ) {
+        return __awaiter(this, void 0, void 0, function* () { });
+    }
+    /**
+     * proveAndSend()
+     *
+     * The called cloud worker is expected to do all: compile the needed Contract,
+     * create the transaction, prove it, sign it using one of the available
+     * fee payers, and finally send it to MINA.
+     *
+     * IMPORTANT: the transaction fee  will be paid by the first fee payer
+     * available from the list of fee payers provided by the ZKRunner service.
+     * Also the fee will be set by the cloud worker using some optimal algorithm
+     * that minimizes fees.
+     *
+     * In this case the sender public key to create and prove the transaction
+     * will be the selected ZKRunner fee payer previously mentioned.
+     *
+     * Example:
+     * ~~~
+     *  let zkWorker = new ZKRunner(API_KEY);
+     *
+     *  let txnResult = await zkWorker.proveAndSend('batch-voting-...', {
+     *    data: {
+     *      claimUid: '012345...789',
+     *      // ...
+     *    }
+     *  });
+     *
+     *  if (txnResult.error)
+     *    // treat error here
+     * ~~~
+     */
+    proveAndSend(jobName, payload //: Promise<TxnResult> {
+    ) {
+        return __awaiter(this, void 0, void 0, function* () { });
+    }
+    /**
+     * runJob()
+     *
+     * The called cloud worker can also be used to easily run jobs not related to
+     * a MINA transaction, and will act just like any serverless function.
+     *
+     * This "generic" job can benefit from the easy to use deploy and call service
+     * already implemented for cloud proving without no extra costs.
+     *
+     * IMPORTANT: there will be a small fee that needs to be paid for service usage,
+     * but no MINA fees need to be paid.
+     *
+     * Example:
+     * ~~~
+     *  let zkWorker = new ZKRunner(API_KEY);
+     *
+     *  let jobResult = await zkWorker.runJob('send-email-to-judges', {
+     *    data: {
+     *      judges: [
+     *        // ...
+     *      ],
+     *    },
+     *    options: {
+     *      // ...
+     *    }
+     *  });
+     *
+     *  if (txnResult.error)
+     *    // treat error here
+     * ~~~
+     */
+    runJob(jobName, payload //: Promise<JobResult> {
+    ) {
+        return __awaiter(this, void 0, void 0, function* () { });
+    }
+}
+//# sourceMappingURL=client-api.js.map

package/lib/web/src/api/client-api.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client-api.js","sourceRoot":"","sources":["../../../../../src/api/client-api.ts"],"names":[],"mappings":";AAAA;;GAEG;AACH,OAAO,EAQL,gBAAgB,GACjB,CAAC;AAyCF,MAAM,gBAAgB;IAGpB,YAAY,MAAc;QAFlB,YAAO,GAAW,EAAE,CAAC;QAG3B,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;IACxB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAwCG;IACG,KAAK,CACT,OAAe,EACf,OAAmB,CAAC,+BAA+B;;8DAClD,CAAC;KAAA;IAEE,IAAI,CACR,aAAqB,EACrB,aAA4B,CAAC,kCAAkC;;8DAC9D,CAAC;KAAA;IAEE,IAAI,CACR,GAAwB,CAAC,wBAAwB;;8DAChD,CAAC;KAAA;IAEJ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACG,YAAY,CAChB,OAAe,EACf,OAAmB,CAAC,wBAAwB;;8DAC3C,CAAC;KAAA;IAEJ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACG,MAAM,CACV,OAAe,EACf,OAAmB,CAAC,wBAAwB;;8DAC3C,CAAC;KAAA;CACL"}

package/lib/web/src/cloud/cloud.js.map

@@ -1 +1 @@
-{"version":3,"file":"cloud.js","sourceRoot":"","sources":["../../../../../src/cloud/cloud.ts"],"names":[],"mappings":"AAEA,MAAM,OAAgB,KAAK;IAEzB,YAAY,KAAY;QACtB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;CAGF"}
+{"version":3,"file":"cloud.js","sourceRoot":"","sources":["../../../../../src/cloud/cloud.ts"],"names":[],"mappings":"AAEA,MAAM,OAAgB,KAAK;IAEzB,YAAY,KAAY;QACtB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;CASF"}

package/lib/web/src/config.js

@@ -1,7 +1,7 @@
 const config = {
     MINAFEE: "200000000",
-    ZKCLOUDWORKER_AUTH: "AkRjS8yioA7i1CwvB3nOvcyLYh6sNMi4em7C0ybmYy67lhDC2KxEQtm1z45llEAR",
-    ZKCLOUDWORKER_API: "https://n1zjzclr99.execute-api.eu-west-1.amazonaws.com/dev/api",
+    ZKCLOUDWORKER_AUTH: "M6t4jtbBAFFXhLERHQWyEB9JA9xi4cWqmYduaCXtbrFjb7yaY7TyaXDunKDJNiUTBEcyUomNXJgC",
+    ZKCLOUDWORKER_API: "https://n1zjzclr99.execute-api.eu-west-1.amazonaws.com/dev/zkcloudworker",
 };
 export default config;
 //# sourceMappingURL=config.js.map

package/lib/web/src/config.js.map

@@ -1 +1 @@
-{"version":3,"file":"config.js","sourceRoot":"","sources":["../../../../src/config.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,GAAG;IACb,OAAO,EAAE,WAAW;IACpB,kBAAkB,EAChB,kEAAkE;IACpE,iBAAiB,EACf,gEAAgE;CACnE,CAAC;AAEF,eAAe,MAAM,CAAC"}
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../../../../src/config.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,GAAG;IACb,OAAO,EAAE,WAAW;IACpB,kBAAkB,EAChB,8EAA8E;IAChF,iBAAiB,EACf,0EAA0E;CAC7E,CAAC;AAEF,eAAe,MAAM,CAAC"}

package/lib/web/src/index.d.ts

@@ -3,3 +3,4 @@ export { Cloud } from "./cloud/cloud";
 export { blockchain, initBlockchain, Memory, makeString, sleep, accountBalance, accountBalanceMina, formatTime, MinaNetwork, } from "./mina";
 export { fee } from "./fee";
 export { MinaNetworkURL, Berkeley, Lightnet, TestWorld2 } from "./networks";
+export { TxnPayload, IsError, SerializedTxn, SignedSerializedTxn, TxnResult, JobPayload, JobResult, zkCloudWorkerAPI, } from "./api/client-api";

package/lib/web/src/index.js

@@ -3,4 +3,5 @@ export { Cloud } from "./cloud/cloud";
 export { initBlockchain, Memory, makeString, sleep, accountBalance, accountBalanceMina, formatTime, } from "./mina";
 export { fee } from "./fee";
 export { Berkeley, Lightnet, TestWorld2 } from "./networks";
+export { zkCloudWorkerAPI, } from "./api/client-api";
 //# sourceMappingURL=index.js.map

package/lib/web/src/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAC1C,OAAO,EAAE,KAAK,EAAE,MAAM,eAAe,CAAC;AACtC,OAAO,EAEL,cAAc,EACd,MAAM,EACN,UAAU,EACV,KAAK,EACL,cAAc,EACd,kBAAkB,EAClB,UAAU,GAEX,MAAM,QAAQ,CAAC;AAChB,OAAO,EAAE,GAAG,EAAE,MAAM,OAAO,CAAC;AAC5B,OAAO,EAAkB,QAAQ,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAC1C,OAAO,EAAE,KAAK,EAAE,MAAM,eAAe,CAAC;AACtC,OAAO,EAEL,cAAc,EACd,MAAM,EACN,UAAU,EACV,KAAK,EACL,cAAc,EACd,kBAAkB,EAClB,UAAU,GAEX,MAAM,QAAQ,CAAC;AAChB,OAAO,EAAE,GAAG,EAAE,MAAM,OAAO,CAAC;AAC5B,OAAO,EAAkB,QAAQ,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAC5E,OAAO,EAQL,gBAAgB,GACjB,MAAM,kBAAkB,CAAC"}