zkcloudworker 0.5.2 → 0.5.4

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

@@ -1,122 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.zkCloudWorkerAPI = void 0;
-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
-     * ~~~
-     */
-    async prove(jobName, payload //: Promise < SerializedTxn > {
-    ) { }
-    async sign(signerAddress, serializedTxn //: Promise<SignedSerializedTxn> {
-    ) { }
-    async send(txn //: Promise<TxnResult> {
-    ) { }
-    /**
-     * 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
-     * ~~~
-     */
-    async proveAndSend(jobName, payload //: Promise<TxnResult> {
-    ) { }
-    /**
-     * 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
-     * ~~~
-     */
-    async runJob(jobName, payload //: Promise<JobResult> {
-    ) { }
-}
-exports.zkCloudWorkerAPI = zkCloudWorkerAPI;

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

@@ -1,147 +0,0 @@
-/**
- * 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

@@ -1,134 +0,0 @@
-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

@@ -1 +0,0 @@
-{"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/fetch.js

@@ -1,68 +0,0 @@
-import { __awaiter } from "tslib";
-import { Mina, fetchAccount, checkZkappTransaction, } from "o1js";
-import { sleep } from "./mina";
-export function fetchMinaAccount(params) {
-    return __awaiter(this, void 0, void 0, function* () {
-        const { publicKey, tokenId, force } = params;
-        const timeout = 1000 * 60 * 10; // 10 minutes
-        const startTime = Date.now();
-        let result = { account: undefined };
-        while (Date.now() - startTime < timeout) {
-            try {
-                const result = yield fetchAccount({
-                    publicKey,
-                    tokenId,
-                });
-                return result;
-            }
-            catch (error) {
-                if (force === true)
-                    console.log("Error in fetchAccount:", error);
-                else {
-                    console.log("fetchMinaAccount error", typeof publicKey === "string" ? publicKey : publicKey.toBase58(), tokenId === null || tokenId === void 0 ? void 0 : tokenId.toString(), force, error);
-                    return result;
-                }
-            }
-            yield sleep(1000 * 10);
-        }
-        console.log("fetchMinaAccount timeout", typeof publicKey === "string" ? publicKey : publicKey.toBase58(), tokenId === null || tokenId === void 0 ? void 0 : tokenId.toString(), force);
-        return result;
-    });
-}
-export function fetchMinaActions(publicKey, fromActionState, endActionState) {
-    return __awaiter(this, void 0, void 0, function* () {
-        const timeout = 1000 * 60 * 600; // 10 hours
-        const startTime = Date.now();
-        while (Date.now() - startTime < timeout) {
-            try {
-                let actions = yield Mina.fetchActions(publicKey, {
-                    fromActionState,
-                    endActionState,
-                });
-                if (Array.isArray(actions))
-                    return actions;
-                else
-                    console.log("Cannot fetch actions - wrong format");
-            }
-            catch (error) {
-                console.log("Error in fetchMinaActions", error.toString().substring(0, 300));
-            }
-            yield sleep(1000 * 60 * 2);
-        }
-        console.log("Timeout in fetchMinaActions");
-        return undefined;
-    });
-}
-export function checkMinaZkappTransaction(hash) {
-    return __awaiter(this, void 0, void 0, function* () {
-        try {
-            const result = yield checkZkappTransaction(hash);
-            return result;
-        }
-        catch (error) {
-            console.error("Error in checkZkappTransaction:", error);
-            return { success: false };
-        }
-    });
-}
-//# sourceMappingURL=fetch.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"fetch.js","sourceRoot":"","sources":["../../../../src/fetch.ts"],"names":[],"mappings":";AAAA,OAAO,EAGL,IAAI,EACJ,YAAY,EACZ,qBAAqB,GACtB,MAAM,MAAM,CAAC;AACd,OAAO,EAAE,KAAK,EAAE,MAAM,QAAQ,CAAC;AAE/B,MAAM,UAAgB,gBAAgB,CAAC,MAItC;;QACC,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,MAAM,CAAC;QAC7C,MAAM,OAAO,GAAG,IAAI,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC,aAAa;QAC7C,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAC7B,IAAI,MAAM,GAAG,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC;QACpC,OAAO,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,GAAG,OAAO,EAAE,CAAC;YACxC,IAAI,CAAC;gBACH,MAAM,MAAM,GAAG,MAAM,YAAY,CAAC;oBAChC,SAAS;oBACT,OAAO;iBACR,CAAC,CAAC;gBACH,OAAO,MAAM,CAAC;YAChB,CAAC;YAAC,OAAO,KAAU,EAAE,CAAC;gBACpB,IAAI,KAAK,KAAK,IAAI;oBAAE,OAAO,CAAC,GAAG,CAAC,wBAAwB,EAAE,KAAK,CAAC,CAAC;qBAC5D,CAAC;oBACJ,OAAO,CAAC,GAAG,CACT,wBAAwB,EACxB,OAAO,SAAS,KAAK,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,QAAQ,EAAE,EAChE,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,QAAQ,EAAE,EACnB,KAAK,EACL,KAAK,CACN,CAAC;oBACF,OAAO,MAAM,CAAC;gBAChB,CAAC;YACH,CAAC;YACD,MAAM,KAAK,CAAC,IAAI,GAAG,EAAE,CAAC,CAAC;QACzB,CAAC;QACD,OAAO,CAAC,GAAG,CACT,0BAA0B,EAC1B,OAAO,SAAS,KAAK,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,QAAQ,EAAE,EAChE,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,QAAQ,EAAE,EACnB,KAAK,CACN,CAAC;QACF,OAAO,MAAM,CAAC;IAChB,CAAC;CAAA;AAED,MAAM,UAAgB,gBAAgB,CACpC,SAAoB,EACpB,eAAsB,EACtB,cAAsB;;QAEtB,MAAM,OAAO,GAAG,IAAI,GAAG,EAAE,GAAG,GAAG,CAAC,CAAC,WAAW;QAC5C,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAC7B,OAAO,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,GAAG,OAAO,EAAE,CAAC;YACxC,IAAI,CAAC;gBACH,IAAI,OAAO,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,SAAS,EAAE;oBAC/C,eAAe;oBACf,cAAc;iBACf,CAAC,CAAC;gBACH,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC;oBAAE,OAAO,OAAO,CAAC;;oBACtC,OAAO,CAAC,GAAG,CAAC,qCAAqC,CAAC,CAAC;YAC1D,CAAC;YAAC,OAAO,KAAU,EAAE,CAAC;gBACpB,OAAO,CAAC,GAAG,CACT,2BAA2B,EAC3B,KAAK,CAAC,QAAQ,EAAE,CAAC,SAAS,CAAC,CAAC,EAAE,GAAG,CAAC,CACnC,CAAC;YACJ,CAAC;YACD,MAAM,KAAK,CAAC,IAAI,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC;QAC7B,CAAC;QACD,OAAO,CAAC,GAAG,CAAC,6BAA6B,CAAC,CAAC;QAC3C,OAAO,SAAS,CAAC;IACnB,CAAC;CAAA;AAED,MAAM,UAAgB,yBAAyB,CAAC,IAAY;;QAC1D,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,qBAAqB,CAAC,IAAI,CAAC,CAAC;YACjD,OAAO,MAAM,CAAC;QAChB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,KAAK,CAAC,iCAAiC,EAAE,KAAK,CAAC,CAAC;YACxD,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;QAC5B,CAAC;IACH,CAAC;CAAA"}