Vana SDK - v4.1.0
    Preparing search index...

    Interface ReadRawParams

    Parameters for the submit, wait, and decrypt convenience flow.

    interface ReadRawParams {
        owner: `0x${string}`;
        grantId: `0x${string}`;
        scope: string;
        pinnedVersion?: string | null;
        deadlineSeconds?: number;
        wait?: number;
        maxPrice?: string;
        jobId?: string;
        timeoutMs?: number;
        pollMs?: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    owner grantId scope pinnedVersion? deadlineSeconds? wait? maxPrice? jobId? timeoutMs? pollMs?

    Properties

    owner: `0x${string}`

    Owner whose enclave executes the read.

    grantId: `0x${string}`

    Owner-issued builder grant.

    scope: string

    Data scope to read.

    pinnedVersion?: string | null

    Exact record version to require, or null for an unpinned read.

    deadlineSeconds?: number

    Requested deadline offset, clamped to the protocol maximum.

    wait?: number

    Gateway inline-wait seconds, clamped to 0..MAX_WAIT_SECONDS.

    maxPrice?: string

    The most this read may cost, uint256 decimal. A quote above it is refused before anything is signed. Omit to accept whatever the chain's FeeRegistry says at submission time.

    jobId?: string

    Reuse a job id across attempts instead of minting one.

    A charged read reserves escrow when the Gateway first accepts the job, so a response lost in transit is ambiguous: retrying with a fresh id would reserve a second time. Supply the id (and idempotencyKey) from durable storage and a resubmission replays the original job and reserves nothing. JobTransportError.details carries both back when a submission fails mid-flight.

    timeoutMs?: number

    Total polling budget in milliseconds.

    pollMs?: number

    Delay between reads; values below CLAIM_POLL_FLOOR_MS are raised.

    Settings

    Member Visibility

    On This Page

    Properties