Interface JobsClient

Builder operations exposed by createJobsClient.

interface JobsClient {
    submitRawRead(params: SubmitRawReadParams): Promise<SubmitRawReadResult>;
    quoteJob(): Promise<JobQuote>;
    getJob(jobId: string): Promise<JobStatus>;
    waitForJob(jobId: string, options?: WaitForJobOptions): Promise<JobStatus>;
    openResult(
        handle: ResultHandle,
        options: OpenJobResultOptions,
    ): Promise<JobResult>;
    readRaw(params: ReadRawParams): Promise<JobResult>;
}

Index

Methods

submitRawRead quoteJob getJob waitForJob openResult readRaw

Methods

submitRawRead

submitRawRead(params: SubmitRawReadParams): Promise<SubmitRawReadResult>
Encrypt and submit a raw-read job.
Parameters
- params: SubmitRawReadParams
  Owner, grant, scope, deadline, and inline-wait controls.
Returns Promise<SubmitRawReadResult>
The job id and current state, plus inline status on HTTP 200.

Throws
When the owner identity is not sealed.

Throws
When the Gateway or transport rejects the call.
- Defined in protocol/jobs-client.ts:221

quoteJob

quoteJob(): Promise<JobQuote>
Ask what one read costs on this chain before committing to it.

Returns Promise<JobQuote>
The chain's data_access fee, its asset, and whether the Gateway enforces it today.

Throws
When the Gateway or transport rejects the call.

Remarks
Optional: JobsClient.submitRawRead signs the quote the Gateway returns with its 402, so a builder that does not care about the price ahead of time never needs this call.
- Defined in protocol/jobs-client.ts:235

getJob

getJob(jobId: string): Promise<JobStatus>
Read one builder-visible job status.
Parameters
- jobId: string
  Client-generated job UUID.
Returns Promise<JobStatus>
The current job status.

Throws
When the job is absent or belongs to another builder.

Throws
For other Gateway or transport failures.
- Defined in protocol/jobs-client.ts:245

waitForJob

waitForJob(jobId: string, options?: WaitForJobOptions): Promise<JobStatus>
Poll until a job completes, fails, expires, or is cancelled.
Parameters
- jobId: string
  Job UUID to poll.
- Optionaloptions: WaitForJobOptions
  Timeout and poll cadence.
Returns Promise<JobStatus>
The terminal job status.

Throws
When the caller or job deadline is exhausted.
- Defined in protocol/jobs-client.ts:255

openResult

openResult(
handle: ResultHandle,
options: OpenJobResultOptions,
): Promise<JobResult>
Fetch, decrypt, and validate a job result from object storage.
Parameters
- handle: ResultHandle
  Object-storage location and integrity metadata.
- options: OpenJobResultOptions
  Expected plaintext job, scope, and version bindings.
Returns Promise<JobResult>
The validated plaintext job result.

Remarks
Decryption requires builderPrivateKey; builderAccount alone only supports submission, status reads, and waiting.

Throws
When a raw private key is unavailable.

Throws
When fetching the result object fails.

Throws
When the fetched bytes mismatch the handle.

Throws
When decrypted protocol fields or bindings differ.
- Defined in protocol/jobs-client.ts:270

readRaw

readRaw(params: ReadRawParams): Promise<JobResult>
Submit, wait for, and decrypt one raw read.
Parameters
- params: ReadRawParams
  Raw-read request plus polling controls.
Returns Promise<JobResult>
The decrypted, binding-checked job result.
Remarks
This convenience flow decrypts the result and therefore requires builderPrivateKey; a client configured only with builderAccount cannot call readRaw.

Throws
When submission, polling, or decryption setup fails.

Throws
When decrypted result bindings differ.
Example
```
const result = await client.readRaw({
  owner,
  grantId,
  scope: "profile.email",
  wait: 25,
});
```
- Defined in protocol/jobs-client.ts:296