Interface iFetchDoc<T>

interface iFetchDoc<T> {
    _docId: string;
    _id?: string;
    content?:
        | iApprovalInfoDetails
        | iMetadata<T>
        | iOffChainBalancesMap<T>
        | iChallengeDetails<T>;
    db:
        | "ApprovalInfo"
        | "Metadata"
        | "Balances"
        | "ChallengeInfo";
    fetchedAt: T;
    fetchedAtBlock: T;
    isPermanent: boolean;
}

Type Parameters

Hierarchy (view full)

Implemented by

Properties

_docId: string

A unique stringified document ID

_id?: string

A unique document ID (Mongo DB ObjectID)

content?:
    | iApprovalInfoDetails
    | iMetadata<T>
    | iOffChainBalancesMap<T>
    | iChallengeDetails<T>

The content of the fetch document. Note that we store balances in BALANCES_DB and not here to avoid double storage.

db:
    | "ApprovalInfo"
    | "Metadata"
    | "Balances"
    | "ChallengeInfo"

The type of content fetched. This is used for querying purposes

fetchedAt: T

The time the document was fetched

fetchedAtBlock: T

The block the document was fetched

isPermanent: boolean

True if the document is permanent (i.e. fetched from a permanent URI like IPFS)