Prover Status

Check the current status of prover operations that generate zero-knowledge proofs for database operations.

Definition

await zkdb
  .db(databaseName: string)
  .zkProofState(): Promise<Result<TZkProofStateResponse>>;

Parameters

• None

Returns

• Promise<Result<TZkProofStateResponse>>: Returns a Result containing the current operational state of the zero-knowledge proof generation system.

type TZkProofStateResponse = {
   status: EQueueTaskStatus;
   taskId: string;
 };

enum EQueueTaskStatus {
  Queued = 'Queued',
  Processing = 'Processing',
  Success = 'Success', 
  Failed = 'Failed',
  Unknown = 'Unknown'
}

Status Meanings:

Status	Description
Queued	The proof generation request is in the queue waiting for available prover resources
Processing	The prover is actively generating zero-knowledge proofs for pending operations
Success	All pending operations have been successfully proven and are ready for verification
Failed	Proof generation encountered errors and requires attention or retry
Unknown	Status cannot be determined, possibly due to system unavailability

tip

• Failed status → use proverRetry()
• Processing operations may take several minutes

Example

import { ZkDatabase } from 'zkdb';

const zkdb = new ZkDatabase({
  apiKey: 'zkdb_536aac02a1b7.c001b6b8f...da3aa4185d8d2ad07f0ae94aT',
  // This URL is for test environment
  url: "https://serverless.zkdatabase.org/graphql", 
});
const dbTest = zkdb.db('zkdb_test');
const status = (await dbTest.zkProofState()).unwrap();
console.log('Prover status:', status);

Result:

Prover status: { "status": "Success", "taskId": "..." }