Class GenericPayloadDiviner<TParams, TIn, TOut, TEventData>

Type Parameters

Hierarchy (View Summary)

Constructors

constructor

Properties

_account _cachedManifests _lastError? _started _startPromise eventData indexMaps moduleConfigQueryValidator onArchivistCleared onArchivistDeleted onArchivistInserted payloadsWithMeta supportedQueryValidator allowRandomAccount configSchemas defaultConfigSchema defaultLogger enableLazyLoad globalInstances globalInstancesCountHistory labels privateConstructorKey targetSchema uniqueName useNewResolver

Accessors

account additionalSigners address allowAnonymous allowNameResolution archiving archivist config dead downResolver ephemeralQueryAccountEnabled id indexBatchSize indexes logger maxIndexSize modName moduleIdentifierTransformers params priority privateResolver queries root status timestamp upResolver historyInterval historyTime maxGcFrequency maxHistoryDepth

Methods

_checkDead _getRootFunction _noOverride addParent all archivistInstance bindHashes bindHashesInternal bindQuery bindQueryInternal bindQueryResult busy certifyParents clearIndex clearListeners divine divineHandler divineQuery emit emitSerial generateConfigAndAddress generateDescribe getArchivist isAllowedArchivingQuery listenerCount manifest manifestHandler manifestQuery moduleAddress moduleAddressHandler off offAny on onAny once parents previousHash privateChildren publicChildren query queryable queryHandler removeParent resolve resolveArchivingArchivists resolveIdentifier resolvePrivate sendQuery sendQueryRaw siblings start started startHandler state stateHandler stateQuery stop stopHandler storeToArchivists subscribe subscribeHandler updateIndex validateConfig _getRootFunction _noOverride create determineAccount factory gc instanceCount instanceCounts startHistory stopHistory

Constructors

constructor

  • new GenericPayloadDiviner<
        TParams extends
            PayloadDivinerParams<
                DeepRestrictToStringKeys<
                    {
                        allowedQueries?: string[];
                        archiving?: { archivists?: string[]; queries?: string[] };
                        archivist?: string;
                        consoleLogger?: LogLevel;
                        indexBatchSize?: number;
                        indexes?: string[];
                        labels?: { [key: string]: undefined | string };
                        maxIndexSize?: number;
                        name?: string;
                        paging?: { [key: string]: { size?: number } };
                        retry?: { backoff?: number; interval?: number; retries?: number };
                        schema: "network.xyo.diviner.payload.generic.config";
                        security?: {
                            allowAnonymous?: boolean;
                            allowed?: {
                                [key: string]: (Lowercase<string> | Lowercase<(...)>[])[];
                            };
                            disallowed?: { [key: string]: Lowercase<string>[] };
                        };
                        sign?: boolean;
                        storeQueries?: boolean;
                        timestamp?: boolean;
                    },
                >,
            > = PayloadDivinerParams<
            DeepRestrictToStringKeys<
                {
                    allowedQueries?: string[];
                    archiving?: { archivists?: string[]; queries?: string[] };
                    archivist?: string;
                    consoleLogger?: LogLevel;
                    indexBatchSize?: number;
                    indexes?: string[];
                    labels?: { [key: string]: undefined | string };
                    maxIndexSize?: number;
                    name?: string;
                    paging?: { [key: string]: { size?: number } };
                    retry?: { backoff?: number; interval?: number; retries?: number };
                    schema: "network.xyo.diviner.payload.generic.config";
                    security?: {
                        allowAnonymous?: boolean;
                        allowed?: { [key: string]: (Lowercase<string> | Lowercase<(...)>[])[] };
                        disallowed?: { [key: string]: Lowercase<string>[] };
                    };
                    sign?: boolean;
                    storeQueries?: boolean;
                    timestamp?: boolean;
                },
            >,
        >,
        TIn extends
            DeepRestrictToStringKeys<
                {
                    address?: Lowercase<string>
                    | Lowercase<string>[];
                    budget?: number;
                    cursor?: Lowercase<string>;
                    limit?: number;
                    maxFrequency?:
                        | "once"
                        | "second"
                        | "minute"
                        | "hour"
                        | "day"
                        | "week"
                        | "month"
                        | "year";
                    minBid?: number;
                    order?: Order;
                    schema: "network.xyo.diviner.payload.query";
                    schemas?: string[];
                },
            > = DeepRestrictToStringKeys<
            {
                address?: Lowercase<string>
                | Lowercase<string>[];
                budget?: number;
                cursor?: Lowercase<string>;
                limit?: number;
                maxFrequency?:
                    | "once"
                    | "second"
                    | "minute"
                    | "hour"
                    | "day"
                    | "week"
                    | "month"
                    | "year";
                minBid?: number;
                order?: Order;
                schema: "network.xyo.diviner.payload.query";
                schemas?: string[];
            },
        >,
        TOut extends
            WithStorageMeta<DeepRestrictToStringKeys<{ schema: string }>> = WithStorageMeta<
            DeepRestrictToStringKeys<{ schema: string }>,
        >,
        TEventData extends
            DivinerModuleEventData<DivinerInstance<TParams, TIn, TOut>, TIn, TOut> = DivinerModuleEventData<
            DivinerInstance<TParams, TIn, TOut>,
            TIn,
            TOut,
        >,
    >(
        privateConstructorKey: string,
        params: TParams,
        account: AccountInstance,
    ): GenericPayloadDiviner<TParams, TIn, TOut, TEventData>

  • Type Parameters

    • TParams extends PayloadDivinerParams<
          DeepRestrictToStringKeys<
              {
                  allowedQueries?: string[];
                  archiving?: { archivists?: string[]; queries?: string[] };
                  archivist?: string;
                  consoleLogger?: LogLevel;
                  indexBatchSize?: number;
                  indexes?: string[];
                  labels?: { [key: string]: undefined | string };
                  maxIndexSize?: number;
                  name?: string;
                  paging?: { [key: string]: { size?: number } };
                  retry?: { backoff?: number; interval?: number; retries?: number };
                  schema: "network.xyo.diviner.payload.generic.config";
                  security?: {
                      allowAnonymous?: boolean;
                      allowed?: { [key: string]: (Lowercase<string> | Lowercase<(...)>[])[] };
                      disallowed?: { [key: string]: Lowercase<string>[] };
                  };
                  sign?: boolean;
                  storeQueries?: boolean;
                  timestamp?: boolean;
              },
          >,
      > = PayloadDivinerParams<
          DeepRestrictToStringKeys<
              {
                  allowedQueries?: string[];
                  archiving?: { archivists?: string[]; queries?: string[] };
                  archivist?: string;
                  consoleLogger?: LogLevel;
                  indexBatchSize?: number;
                  indexes?: string[];
                  labels?: { [key: string]: undefined | string };
                  maxIndexSize?: number;
                  name?: string;
                  paging?: { [key: string]: { size?: number } };
                  retry?: { backoff?: number; interval?: number; retries?: number };
                  schema: "network.xyo.diviner.payload.generic.config";
                  security?: {
                      allowAnonymous?: boolean;
                      allowed?: { [key: string]: (Lowercase<string> | Lowercase<(...)>[])[] };
                      disallowed?: { [key: string]: Lowercase<string>[] };
                  };
                  sign?: boolean;
                  storeQueries?: boolean;
                  timestamp?: boolean;
              },
          >,
      >
    • TIn extends DeepRestrictToStringKeys<
          {
              address?: Lowercase<string>
              | Lowercase<string>[];
              budget?: number;
              cursor?: Lowercase<string>;
              limit?: number;
              maxFrequency?:
                  | "once"
                  | "second"
                  | "minute"
                  | "hour"
                  | "day"
                  | "week"
                  | "month"
                  | "year";
              minBid?: number;
              order?: Order;
              schema: "network.xyo.diviner.payload.query";
              schemas?: string[];
          },
      > = DeepRestrictToStringKeys<
          {
              address?: Lowercase<string>
              | Lowercase<string>[];
              budget?: number;
              cursor?: Lowercase<string>;
              limit?: number;
              maxFrequency?:
                  | "once"
                  | "second"
                  | "minute"
                  | "hour"
                  | "day"
                  | "week"
                  | "month"
                  | "year";
              minBid?: number;
              order?: Order;
              schema: "network.xyo.diviner.payload.query";
              schemas?: string[];
          },
      >
    • TOut extends WithStorageMeta<DeepRestrictToStringKeys<{ schema: string }>> = WithStorageMeta<DeepRestrictToStringKeys<{ schema: string }>>
    • TEventData extends DivinerModuleEventData<DivinerInstance<TParams, TIn, TOut>, TIn, TOut> = DivinerModuleEventData<DivinerInstance<TParams, TIn, TOut>, TIn, TOut>

    Parameters

    Returns GenericPayloadDiviner<TParams, TIn, TOut, TEventData>

Properties

Protected_account

_account: AccountInstance

Protected_cachedManifests

_cachedManifests: LRUCache<
    number,
    | DeepRestrictToStringKeys<
        {
            config: {
                accountPath?: string;
                features?: string[];
                labels?: { [x: string]: undefined
                | string };
                language?: string;
                name: string;
                os?: string;
                schema: string;
            };
            description?: string;
            lazyStart?: boolean;
            schema: "network.xyo.module.manifest";
            status?: {
                address: Lowercase<string>;
                children?: { [x: Lowercase<string>]: null | string };
            };
        },
    >
    | DeepRestrictToStringKeys<
        {
            config: {
                accountPath?: string;
                features?: string[];
                labels?: { [x: string]: undefined
                | string };
                language?: string;
                name: string;
                os?: string;
                schema: string;
            };
            description?: string;
            lazyStart?: boolean;
            schema: "network.xyo.node.manifest";
            status?: {
                address: Lowercase<string>;
                children?: { [x: Lowercase<string>]: null | string };
            };
        },
    >,
>

Protected Optional_lastError

_lastError?: ModuleDetailsError

Protected_started

_started: undefined | Promisable<boolean>

Protected_startPromise

_startPromise: undefined | Promisable<boolean>

eventData

eventData: TEventData

ProtectedindexMaps

indexMaps: Record<string, WithStorageMeta<TOut>[]> = {}

Protected ReadonlymoduleConfigQueryValidator

moduleConfigQueryValidator: Queryable<UnsignedQueryBoundWitness>

ProtectedonArchivistCleared

onArchivistCleared: EventListener<{ mod: Module }> = ...

ProtectedonArchivistDeleted

onArchivistDeleted: EventListener<
    { mod: Module } & { hashes: Lowercase<string>[] },
> = ...

ProtectedonArchivistInserted

onArchivistInserted: EventListener<
    { mod: Module } & {
        payloads: DeepRestrictToStringKeys<{ schema: string }>[];
    },
> = ...

ProtectedpayloadsWithMeta

payloadsWithMeta: WithStorageMeta<TOut>[] = []

Protected ReadonlysupportedQueryValidator

supportedQueryValidator: Queryable<UnsignedQueryBoundWitness>

Static ReadonlyallowRandomAccount

allowRandomAccount: boolean

Static ReadonlyconfigSchemas

configSchemas: string[] = ...

Static ReadonlydefaultConfigSchema

defaultConfigSchema: string = GenericPayloadDivinerConfigSchema

StaticdefaultLogger

defaultLogger: Logger

StaticenableLazyLoad

enableLazyLoad: boolean

Static ReadonlyglobalInstances

globalInstances: Record<string, WeakRef<Base<undefined | BaseParamsFields>>[]>

Static ReadonlyglobalInstancesCountHistory

globalInstancesCountHistory: Record<string, number[]>

Static Readonlylabels

labels: Labels

Protected StaticprivateConstructorKey

privateConstructorKey: string

StatictargetSchema

targetSchema: string

Static ReadonlyuniqueName

uniqueName: string

Static ReadonlyuseNewResolver

useNewResolver: false

Accessors

account

  • get account(): AccountInstance

  • Returns AccountInstance

additionalSigners

  • get additionalSigners(): AccountInstance[]

  • Returns AccountInstance[]

address

  • get address(): Lowercase<string>

  • Returns Lowercase<string>

allowAnonymous

  • get allowAnonymous(): boolean

  • Returns boolean

allowNameResolution

  • get allowNameResolution(): boolean

  • Returns boolean

archiving

  • get archiving(): undefined | { archivists?: string[]; queries?: string[] }

  • Returns undefined | { archivists?: string[]; queries?: string[] }

archivist

  • get archivist(): undefined | string

  • Returns undefined | string

config

  • get config(): TParams["config"]

  • Returns TParams["config"]

dead

  • get dead(): boolean

  • Returns boolean

downResolver

ephemeralQueryAccountEnabled

  • get ephemeralQueryAccountEnabled(): boolean

  • Returns boolean

id

  • get id(): string

  • Returns string

ProtectedindexBatchSize

Protectedindexes

logger

  • get logger(): Logger

  • Returns Logger

ProtectedmaxIndexSize

modName

  • get modName(): undefined | string

  • Returns undefined | string

moduleIdentifierTransformers

params

  • get params(): TParams

  • Returns TParams

priority

  • get priority(): 2

  • Returns 2

privateResolver

queries

  • get queries(): string[]

  • Returns string[]

root

  • get root(): this

  • Returns this

status

  • get status(): ModuleStatus

  • Returns ModuleStatus

  • set status(value: ModuleStatus): void

  • Parameters

    Returns void

timestamp

  • get timestamp(): boolean

  • Returns boolean

upResolver

StatichistoryInterval

  • get historyInterval(): number

  • Returns number

  • set historyInterval(value: number): void

  • Parameters

    • value: number

    Returns void

StatichistoryTime

  • get historyTime(): number

  • Returns number

  • set historyTime(value: number): void

  • Parameters

    • value: number

    Returns void

StaticmaxGcFrequency

  • get maxGcFrequency(): number

  • Returns number

  • set maxGcFrequency(value: number): void

  • Parameters

    • value: number

    Returns void

StaticmaxHistoryDepth

  • get maxHistoryDepth(): number

  • Returns number

Methods

Protected_checkDead

  • _checkDead(): void

  • Returns void

_getRootFunction

  • _getRootFunction(funcName: string): any

  • Parameters

    • funcName: string

    Returns any

Protected_noOverride

  • _noOverride(functionName: string): void

  • Parameters

    • functionName: string

    Returns void

addParent

Protectedall

ProtectedarchivistInstance

ProtectedbindHashes

ProtectedbindHashesInternal

ProtectedbindQuery

  • bindQuery<
        T extends
            DeepRestrictToStringKeys<
                {
                    address?: Lowercase<string>
                    | Lowercase<string>[];
                    budget?: number;
                    maxFrequency?:
                        | "once"
                        | "second"
                        | "minute"
                        | "hour"
                        | "day"
                        | "week"
                        | "month"
                        | "year";
                    minBid?: number;
                    schema: string;
                },
            >,
    >(
        query: T,
        payloads?: DeepRestrictToStringKeys<{ schema: string }>[],
        account?: AccountInstance,
        additionalSigners?: AccountInstance[],
    ): PromiseEx<
        [
            UnsignedQueryBoundWitness,
            DeepRestrictToStringKeys<{ schema: string }>[],
            DeepRestrictToStringKeys<{ schema: string }>[],
        ],
        AccountInstance,
    >

  • Type Parameters

    • T extends DeepRestrictToStringKeys<
          {
              address?: Lowercase<string>
              | Lowercase<string>[];
              budget?: number;
              maxFrequency?:
                  | "once"
                  | "second"
                  | "minute"
                  | "hour"
                  | "day"
                  | "week"
                  | "month"
                  | "year";
              minBid?: number;
              schema: string;
          },
      >

    Parameters

    Returns PromiseEx<
        [
            UnsignedQueryBoundWitness,
            DeepRestrictToStringKeys<{ schema: string }>[],
            DeepRestrictToStringKeys<{ schema: string }>[],
        ],
        AccountInstance,
    >

ProtectedbindQueryInternal

  • bindQueryInternal<
        T extends
            DeepRestrictToStringKeys<
                {
                    address?: Lowercase<string>
                    | Lowercase<string>[];
                    budget?: number;
                    maxFrequency?:
                        | "once"
                        | "second"
                        | "minute"
                        | "hour"
                        | "day"
                        | "week"
                        | "month"
                        | "year";
                    minBid?: number;
                    schema: string;
                },
            >,
    >(
        query: T,
        payloads?: DeepRestrictToStringKeys<{ schema: string }>[],
        account?: AccountInstance,
        additionalSigners?: AccountInstance[],
    ): Promise<
        [
            UnsignedQueryBoundWitness,
            DeepRestrictToStringKeys<{ schema: string }>[],
            DeepRestrictToStringKeys<{ schema: string }>[],
        ],
    >

  • Type Parameters

    • T extends DeepRestrictToStringKeys<
          {
              address?: Lowercase<string>
              | Lowercase<string>[];
              budget?: number;
              maxFrequency?:
                  | "once"
                  | "second"
                  | "minute"
                  | "hour"
                  | "day"
                  | "week"
                  | "month"
                  | "year";
              minBid?: number;
              schema: string;
          },
      >

    Parameters

    Returns Promise<
        [
            UnsignedQueryBoundWitness,
            DeepRestrictToStringKeys<{ schema: string }>[],
            DeepRestrictToStringKeys<{ schema: string }>[],
        ],
    >

ProtectedbindQueryResult

  • bindQueryResult<
        T extends
            DeepRestrictToStringKeys<
                {
                    address?: Lowercase<string>
                    | Lowercase<string>[];
                    budget?: number;
                    maxFrequency?:
                        | "once"
                        | "second"
                        | "minute"
                        | "hour"
                        | "day"
                        | "week"
                        | "month"
                        | "year";
                    minBid?: number;
                    schema: string;
                },
            >,
    >(
        query: T,
        payloads: DeepRestrictToStringKeys<{ schema: string }>[],
        additionalWitnesses?: AccountInstance[],
        errors?: DeepRestrictToStringKeys<
            {
                details?: | null
                | string
                | number
                | boolean
                | {
                    [key: string]: | null
                    | string
                    | number
                    | boolean
                    | (
                        { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null)[] | null; }
                    )
                    | (
                        string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null
                    )[];
                }
                | (
                    | null
                    | string
                    | number
                    | boolean
                    | {
                        [key: string]: string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null;
                    }
                    | (
                        (string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null)[]
                    )
                )[];
                message?: string;
                name?: string;
                query?: Lowercase<string>;
                schema: "network.xyo.error.module";
            },
        >[],
    ): Promise<ModuleQueryResult>

  • Type Parameters

    • T extends DeepRestrictToStringKeys<
          {
              address?: Lowercase<string>
              | Lowercase<string>[];
              budget?: number;
              maxFrequency?:
                  | "once"
                  | "second"
                  | "minute"
                  | "hour"
                  | "day"
                  | "week"
                  | "month"
                  | "year";
              minBid?: number;
              schema: string;
          },
      >

    Parameters

    • query: T
    • payloads: DeepRestrictToStringKeys<{ schema: string }>[]
    • OptionaladditionalWitnesses: AccountInstance[]
    • Optionalerrors: DeepRestrictToStringKeys<
          {
              details?: | null
              | string
              | number
              | boolean
              | {
                  [key: string]: | null
                  | string
                  | number
                  | boolean
                  | (
                      { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null)[] | null; }
                  )
                  | (
                      string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null
                  )[];
              }
              | (
                  | null
                  | string
                  | number
                  | boolean
                  | {
                      [key: string]: string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null;
                  }
                  | (
                      (string | number | boolean | { [x: string]: string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | number | boolean | ... | (string | ... 4 more ... | null)[] | null)[] | null)[] | null)[] | null; } | (string | ... 4 more ... | null)[] | null)[]
                  )
              )[];
              message?: string;
              name?: string;
              query?: Lowercase<string>;
              schema: "network.xyo.error.module";
          },
      >[]

    Returns Promise<ModuleQueryResult>

busy

  • busy<R>(closure: () => Promise<R>): Promise<R>

  • Type Parameters

    • R

    Parameters

    • closure: () => Promise<R>

    Returns Promise<R>

certifyParents

ProtectedclearIndex

clearListeners

divine

  • divine(
        payloads?: TIn[],
        retryConfigIn?: RetryConfigWithComplete,
    ): Promise<DivinerDivineResult<TOut>[]>

  • Parameters

    • Optionalpayloads: TIn[]
    • OptionalretryConfigIn: RetryConfigWithComplete

    Returns Promise<DivinerDivineResult<TOut>[]>

ProtecteddivineHandler

divineQuery

emit

emitSerial

ProtectedgenerateConfigAndAddress

ProtectedgenerateDescribe

  • generateDescribe(): Promise<
        DeepRestrictToStringKeys<
            {
                address: Lowercase<string>;
                children?: string[];
                name?: string;
                queries: string[];
                schema: "network.xyo.module.description";
            },
        >,
    >

  • Returns Promise<
        DeepRestrictToStringKeys<
            {
                address: Lowercase<string>;
                children?: string[];
                name?: string;
                queries: string[];
                schema: "network.xyo.module.description";
            },
        >,
    >

ProtectedgetArchivist

ProtectedisAllowedArchivingQuery

  • isAllowedArchivingQuery(schema: string): boolean

  • Parameters

    • schema: string

    Returns boolean

listenerCount

manifest

  • manifest(
        maxDepth?: number,
    ): Promise<
        | DeepRestrictToStringKeys<
            {
                config: {
                    accountPath?: string;
                    features?: string[];
                    labels?: { [key: string]: undefined
                    | string };
                    language?: string;
                    name: string;
                    os?: string;
                    schema: string;
                };
                description?: string;
                lazyStart?: boolean;
                schema: "network.xyo.module.manifest";
                status?: {
                    address: Lowercase<string>;
                    children?: { [key: Lowercase<string>]: null | string };
                };
            },
        >
        | DeepRestrictToStringKeys<
            {
                config: {
                    accountPath?: string;
                    features?: string[];
                    labels?: { [key: string]: undefined
                    | string };
                    language?: string;
                    name: string;
                    os?: string;
                    schema: string;
                };
                description?: string;
                lazyStart?: boolean;
                schema: "network.xyo.node.manifest";
                status?: {
                    address: Lowercase<string>;
                    children?: { [key: Lowercase<string>]: null | string };
                };
            },
        >,
    >

  • Parameters

    • OptionalmaxDepth: number

    Returns Promise<
        | DeepRestrictToStringKeys<
            {
                config: {
                    accountPath?: string;
                    features?: string[];
                    labels?: { [key: string]: undefined
                    | string };
                    language?: string;
                    name: string;
                    os?: string;
                    schema: string;
                };
                description?: string;
                lazyStart?: boolean;
                schema: "network.xyo.module.manifest";
                status?: {
                    address: Lowercase<string>;
                    children?: { [key: Lowercase<string>]: null | string };
                };
            },
        >
        | DeepRestrictToStringKeys<
            {
                config: {
                    accountPath?: string;
                    features?: string[];
                    labels?: { [key: string]: undefined
                    | string };
                    language?: string;
                    name: string;
                    os?: string;
                    schema: string;
                };
                description?: string;
                lazyStart?: boolean;
                schema: "network.xyo.node.manifest";
                status?: {
                    address: Lowercase<string>;
                    children?: { [key: Lowercase<string>]: null | string };
                };
            },
        >,
    >

ProtectedmanifestHandler

  • manifestHandler(
        maxDepth?: number,
        _ignoreAddresses?: Lowercase<string>[],
    ): Promise<
        | DeepRestrictToStringKeys<
            {
                config: {
                    accountPath?: string;
                    features?: string[];
                    labels?: { [key: string]: undefined
                    | string };
                    language?: string;
                    name: string;
                    os?: string;
                    schema: string;
                };
                description?: string;
                lazyStart?: boolean;
                schema: "network.xyo.module.manifest";
                status?: {
                    address: Lowercase<string>;
                    children?: { [key: Lowercase<string>]: null | string };
                };
            },
        >
        | DeepRestrictToStringKeys<
            {
                config: {
                    accountPath?: string;
                    features?: string[];
                    labels?: { [key: string]: undefined
                    | string };
                    language?: string;
                    name: string;
                    os?: string;
                    schema: string;
                };
                description?: string;
                lazyStart?: boolean;
                schema: "network.xyo.node.manifest";
                status?: {
                    address: Lowercase<string>;
                    children?: { [key: Lowercase<string>]: null | string };
                };
            },
        >,
    >

  • Parameters

    • OptionalmaxDepth: number
    • Optional_ignoreAddresses: Lowercase<string>[]

    Returns Promise<
        | DeepRestrictToStringKeys<
            {
                config: {
                    accountPath?: string;
                    features?: string[];
                    labels?: { [key: string]: undefined
                    | string };
                    language?: string;
                    name: string;
                    os?: string;
                    schema: string;
                };
                description?: string;
                lazyStart?: boolean;
                schema: "network.xyo.module.manifest";
                status?: {
                    address: Lowercase<string>;
                    children?: { [key: Lowercase<string>]: null | string };
                };
            },
        >
        | DeepRestrictToStringKeys<
            {
                config: {
                    accountPath?: string;
                    features?: string[];
                    labels?: { [key: string]: undefined
                    | string };
                    language?: string;
                    name: string;
                    os?: string;
                    schema: string;
                };
                description?: string;
                lazyStart?: boolean;
                schema: "network.xyo.node.manifest";
                status?: {
                    address: Lowercase<string>;
                    children?: { [key: Lowercase<string>]: null | string };
                };
            },
        >,
    >

manifestQuery

  • manifestQuery(
        account: AccountInstance,
        maxDepth?: number,
    ): Promise<
        ModuleQueryResult<
            | DeepRestrictToStringKeys<
                {
                    config: {
                        accountPath?: string;
                        features?: string[];
                        labels?: { [key: string]: undefined
                        | string };
                        language?: string;
                        name: string;
                        os?: string;
                        schema: string;
                    };
                    description?: string;
                    lazyStart?: boolean;
                    schema: "network.xyo.module.manifest";
                    status?: {
                        address: Lowercase<string>;
                        children?: { [key: Lowercase<string>]: null | string };
                    };
                },
            >
            | DeepRestrictToStringKeys<
                {
                    config: {
                        accountPath?: string;
                        features?: string[];
                        labels?: { [key: string]: undefined
                        | string };
                        language?: string;
                        name: string;
                        os?: string;
                        schema: string;
                    };
                    description?: string;
                    lazyStart?: boolean;
                    schema: "network.xyo.node.manifest";
                    status?: {
                        address: Lowercase<string>;
                        children?: { [key: Lowercase<string>]: null | string };
                    };
                },
            >,
        >,
    >

  • Parameters

    Returns Promise<
        ModuleQueryResult<
            | DeepRestrictToStringKeys<
                {
                    config: {
                        accountPath?: string;
                        features?: string[];
                        labels?: { [key: string]: undefined
                        | string };
                        language?: string;
                        name: string;
                        os?: string;
                        schema: string;
                    };
                    description?: string;
                    lazyStart?: boolean;
                    schema: "network.xyo.module.manifest";
                    status?: {
                        address: Lowercase<string>;
                        children?: { [key: Lowercase<string>]: null | string };
                    };
                },
            >
            | DeepRestrictToStringKeys<
                {
                    config: {
                        accountPath?: string;
                        features?: string[];
                        labels?: { [key: string]: undefined
                        | string };
                        language?: string;
                        name: string;
                        os?: string;
                        schema: string;
                    };
                    description?: string;
                    lazyStart?: boolean;
                    schema: "network.xyo.node.manifest";
                    status?: {
                        address: Lowercase<string>;
                        children?: { [key: Lowercase<string>]: null | string };
                    };
                },
            >,
        >,
    >

moduleAddress

  • moduleAddress(): Promise<
        (
            | DeepRestrictToStringKeys<
                { address: Lowercase<string>; schema: "network.xyo.address" },
            >
            | DeepRestrictToStringKeys<
                {
                    address: Lowercase<string>;
                    previousHash?: string;
                    schema: "network.xyo.address.hash.previous";
                },
            >
        )[],
    >

  • Returns Promise<
        (
            | DeepRestrictToStringKeys<
                { address: Lowercase<string>; schema: "network.xyo.address" },
            >
            | DeepRestrictToStringKeys<
                {
                    address: Lowercase<string>;
                    previousHash?: string;
                    schema: "network.xyo.address.hash.previous";
                },
            >
        )[],
    >

ProtectedmoduleAddressHandler

  • moduleAddressHandler(): Promisable<
        (
            | DeepRestrictToStringKeys<
                { address: Lowercase<string>; schema: "network.xyo.address" },
            >
            | DeepRestrictToStringKeys<
                {
                    address: Lowercase<string>;
                    previousHash?: string;
                    schema: "network.xyo.address.hash.previous";
                },
            >
        )[],
    >

  • Returns Promisable<
        (
            | DeepRestrictToStringKeys<
                { address: Lowercase<string>; schema: "network.xyo.address" },
            >
            | DeepRestrictToStringKeys<
                {
                    address: Lowercase<string>;
                    previousHash?: string;
                    schema: "network.xyo.address.hash.previous";
                },
            >
        )[],
    >

off

offAny

on

onAny

once

parents

previousHash

  • previousHash(): Promisable<undefined | string>

  • Returns Promisable<undefined | string>

privateChildren

publicChildren

query

  • query<
        T extends UnsignedQueryBoundWitness = UnsignedQueryBoundWitness,
        TConfig extends
            DeepRestrictToStringKeys<
                {
                    allowedQueries?: string[];
                    archiving?: { archivists?: string[]; queries?: string[] };
                    archivist?: string;
                    consoleLogger?: LogLevel;
                    labels?: { [key: string]: undefined | string };
                    name?: string;
                    paging?: { [key: string]: { size?: number } };
                    retry?: { backoff?: number; interval?: number; retries?: number };
                    schema: "network.xyo.module.config";
                    security?: {
                        allowAnonymous?: boolean;
                        allowed?: {
                            [key: string]: (Lowercase<string> | Lowercase<string>[])[];
                        };
                        disallowed?: { [key: string]: Lowercase<string>[] };
                    };
                    sign?: boolean;
                    storeQueries?: boolean;
                    timestamp?: boolean;
                },
            > = DeepRestrictToStringKeys<
            {
                allowedQueries?: string[];
                archiving?: { archivists?: string[]; queries?: string[] };
                archivist?: string;
                consoleLogger?: LogLevel;
                labels?: { [key: string]: undefined | string };
                name?: string;
                paging?: { [key: string]: { size?: number } };
                retry?: { backoff?: number; interval?: number; retries?: number };
                schema: "network.xyo.module.config";
                security?: {
                    allowAnonymous?: boolean;
                    allowed?: { [key: string]: (Lowercase<string> | Lowercase<string>[])[] };
                    disallowed?: { [key: string]: Lowercase<string>[] };
                };
                sign?: boolean;
                storeQueries?: boolean;
                timestamp?: boolean;
            },
        >,
    >(
        query: T,
        payloads?: DeepRestrictToStringKeys<{ schema: string }>[],
        queryConfig?: TConfig,
    ): Promise<ModuleQueryResult>

  • Type Parameters

    • T extends UnsignedQueryBoundWitness = UnsignedQueryBoundWitness
    • TConfig extends DeepRestrictToStringKeys<
          {
              allowedQueries?: string[];
              archiving?: { archivists?: string[]; queries?: string[] };
              archivist?: string;
              consoleLogger?: LogLevel;
              labels?: { [key: string]: undefined | string };
              name?: string;
              paging?: { [key: string]: { size?: number } };
              retry?: { backoff?: number; interval?: number; retries?: number };
              schema: "network.xyo.module.config";
              security?: {
                  allowAnonymous?: boolean;
                  allowed?: { [key: string]: (Lowercase<string> | Lowercase<string>[])[] };
                  disallowed?: { [key: string]: Lowercase<string>[] };
              };
              sign?: boolean;
              storeQueries?: boolean;
              timestamp?: boolean;
          },
      > = DeepRestrictToStringKeys<
          {
              allowedQueries?: string[];
              archiving?: { archivists?: string[]; queries?: string[] };
              archivist?: string;
              consoleLogger?: LogLevel;
              labels?: { [key: string]: undefined | string };
              name?: string;
              paging?: { [key: string]: { size?: number } };
              retry?: { backoff?: number; interval?: number; retries?: number };
              schema: "network.xyo.module.config";
              security?: {
                  allowAnonymous?: boolean;
                  allowed?: { [key: string]: (Lowercase<string> | Lowercase<string>[])[] };
                  disallowed?: { [key: string]: Lowercase<string>[] };
              };
              sign?: boolean;
              storeQueries?: boolean;
              timestamp?: boolean;
          },
      >

    Parameters

    Returns Promise<ModuleQueryResult>

queryable

  • queryable<
        T extends UnsignedQueryBoundWitness = UnsignedQueryBoundWitness,
        TConfig extends
            DeepRestrictToStringKeys<
                {
                    allowedQueries?: string[];
                    archiving?: { archivists?: string[]; queries?: string[] };
                    archivist?: string;
                    consoleLogger?: LogLevel;
                    labels?: { [key: string]: undefined | string };
                    name?: string;
                    paging?: { [key: string]: { size?: number } };
                    retry?: { backoff?: number; interval?: number; retries?: number };
                    schema: "network.xyo.module.config";
                    security?: {
                        allowAnonymous?: boolean;
                        allowed?: {
                            [key: string]: (Lowercase<string> | Lowercase<string>[])[];
                        };
                        disallowed?: { [key: string]: Lowercase<string>[] };
                    };
                    sign?: boolean;
                    storeQueries?: boolean;
                    timestamp?: boolean;
                },
            > = DeepRestrictToStringKeys<
            {
                allowedQueries?: string[];
                archiving?: { archivists?: string[]; queries?: string[] };
                archivist?: string;
                consoleLogger?: LogLevel;
                labels?: { [key: string]: undefined | string };
                name?: string;
                paging?: { [key: string]: { size?: number } };
                retry?: { backoff?: number; interval?: number; retries?: number };
                schema: "network.xyo.module.config";
                security?: {
                    allowAnonymous?: boolean;
                    allowed?: { [key: string]: (Lowercase<string> | Lowercase<string>[])[] };
                    disallowed?: { [key: string]: Lowercase<string>[] };
                };
                sign?: boolean;
                storeQueries?: boolean;
                timestamp?: boolean;
            },
        >,
    >(
        query: T,
        payloads?: DeepRestrictToStringKeys<{ schema: string }>[],
        queryConfig?: TConfig,
    ): Promise<boolean>

  • Type Parameters

    • T extends UnsignedQueryBoundWitness = UnsignedQueryBoundWitness
    • TConfig extends DeepRestrictToStringKeys<
          {
              allowedQueries?: string[];
              archiving?: { archivists?: string[]; queries?: string[] };
              archivist?: string;
              consoleLogger?: LogLevel;
              labels?: { [key: string]: undefined | string };
              name?: string;
              paging?: { [key: string]: { size?: number } };
              retry?: { backoff?: number; interval?: number; retries?: number };
              schema: "network.xyo.module.config";
              security?: {
                  allowAnonymous?: boolean;
                  allowed?: { [key: string]: (Lowercase<string> | Lowercase<string>[])[] };
                  disallowed?: { [key: string]: Lowercase<string>[] };
              };
              sign?: boolean;
              storeQueries?: boolean;
              timestamp?: boolean;
          },
      > = DeepRestrictToStringKeys<
          {
              allowedQueries?: string[];
              archiving?: { archivists?: string[]; queries?: string[] };
              archivist?: string;
              consoleLogger?: LogLevel;
              labels?: { [key: string]: undefined | string };
              name?: string;
              paging?: { [key: string]: { size?: number } };
              retry?: { backoff?: number; interval?: number; retries?: number };
              schema: "network.xyo.module.config";
              security?: {
                  allowAnonymous?: boolean;
                  allowed?: { [key: string]: (Lowercase<string> | Lowercase<string>[])[] };
                  disallowed?: { [key: string]: Lowercase<string>[] };
              };
              sign?: boolean;
              storeQueries?: boolean;
              timestamp?: boolean;
          },
      >

    Parameters

    Returns Promise<boolean>

ProtectedqueryHandler

  • queryHandler<
        T extends UnsignedQueryBoundWitness = UnsignedQueryBoundWitness,
        TConfig extends
            DeepRestrictToStringKeys<
                {
                    allowedQueries?: string[];
                    archiving?: { archivists?: string[]; queries?: string[] };
                    archivist?: string;
                    consoleLogger?: LogLevel;
                    labels?: { [key: string]: undefined | string };
                    name?: string;
                    paging?: { [key: string]: { size?: number } };
                    retry?: { backoff?: number; interval?: number; retries?: number };
                    schema: "network.xyo.module.config";
                    security?: {
                        allowAnonymous?: boolean;
                        allowed?: {
                            [key: string]: (Lowercase<string> | Lowercase<string>[])[];
                        };
                        disallowed?: { [key: string]: Lowercase<string>[] };
                    };
                    sign?: boolean;
                    storeQueries?: boolean;
                    timestamp?: boolean;
                },
            > = DeepRestrictToStringKeys<
            {
                allowedQueries?: string[];
                archiving?: { archivists?: string[]; queries?: string[] };
                archivist?: string;
                consoleLogger?: LogLevel;
                labels?: { [key: string]: undefined | string };
                name?: string;
                paging?: { [key: string]: { size?: number } };
                retry?: { backoff?: number; interval?: number; retries?: number };
                schema: "network.xyo.module.config";
                security?: {
                    allowAnonymous?: boolean;
                    allowed?: { [key: string]: (Lowercase<string> | Lowercase<string>[])[] };
                    disallowed?: { [key: string]: Lowercase<string>[] };
                };
                sign?: boolean;
                storeQueries?: boolean;
                timestamp?: boolean;
            },
        >,
    >(
        query: T,
        payloads?: DeepRestrictToStringKeys<{ schema: string }>[],
        queryConfig?: TConfig,
    ): Promise<ModuleQueryHandlerResult>

  • Type Parameters

    • T extends UnsignedQueryBoundWitness = UnsignedQueryBoundWitness
    • TConfig extends DeepRestrictToStringKeys<
          {
              allowedQueries?: string[];
              archiving?: { archivists?: string[]; queries?: string[] };
              archivist?: string;
              consoleLogger?: LogLevel;
              labels?: { [key: string]: undefined | string };
              name?: string;
              paging?: { [key: string]: { size?: number } };
              retry?: { backoff?: number; interval?: number; retries?: number };
              schema: "network.xyo.module.config";
              security?: {
                  allowAnonymous?: boolean;
                  allowed?: { [key: string]: (Lowercase<string> | Lowercase<string>[])[] };
                  disallowed?: { [key: string]: Lowercase<string>[] };
              };
              sign?: boolean;
              storeQueries?: boolean;
              timestamp?: boolean;
          },
      > = DeepRestrictToStringKeys<
          {
              allowedQueries?: string[];
              archiving?: { archivists?: string[]; queries?: string[] };
              archivist?: string;
              consoleLogger?: LogLevel;
              labels?: { [key: string]: undefined | string };
              name?: string;
              paging?: { [key: string]: { size?: number } };
              retry?: { backoff?: number; interval?: number; retries?: number };
              schema: "network.xyo.module.config";
              security?: {
                  allowAnonymous?: boolean;
                  allowed?: { [key: string]: (Lowercase<string> | Lowercase<string>[])[] };
                  disallowed?: { [key: string]: Lowercase<string>[] };
              };
              sign?: boolean;
              storeQueries?: boolean;
              timestamp?: boolean;
          },
      >

    Parameters

    Returns Promise<ModuleQueryHandlerResult>

removeParent

  • removeParent(address: Lowercase<string>): void

  • Parameters

    • address: Lowercase<string>

    Returns void

resolve

ProtectedresolveArchivingArchivists

resolveIdentifier

  • resolveIdentifier(
        id: string,
        options?: ObjectFilterOptions,
    ): Promise<undefined | Lowercase<string>>

  • Parameters

    Returns Promise<undefined | Lowercase<string>>

resolvePrivate

ProtectedsendQuery

  • sendQuery<
        T extends
            DeepRestrictToStringKeys<
                {
                    address?: Lowercase<string>
                    | Lowercase<string>[];
                    budget?: number;
                    maxFrequency?:
                        | "once"
                        | "second"
                        | "minute"
                        | "hour"
                        | "day"
                        | "week"
                        | "month"
                        | "year";
                    minBid?: number;
                    schema: string;
                },
            >,
        P extends
            DeepRestrictToStringKeys<{ schema: string }> = DeepRestrictToStringKeys<
            { schema: string },
        >,
        R extends
            DeepRestrictToStringKeys<{ schema: string }> = DeepRestrictToStringKeys<
            { schema: string },
        >,
    >(
        queryPayload: T,
        payloads?: P[],
        account?: AccountInstance,
    ): Promise<R[]>

  • Type Parameters

    • T extends DeepRestrictToStringKeys<
          {
              address?: Lowercase<string>
              | Lowercase<string>[];
              budget?: number;
              maxFrequency?:
                  | "once"
                  | "second"
                  | "minute"
                  | "hour"
                  | "day"
                  | "week"
                  | "month"
                  | "year";
              minBid?: number;
              schema: string;
          },
      >
    • P extends DeepRestrictToStringKeys<{ schema: string }> = DeepRestrictToStringKeys<{ schema: string }>
    • R extends DeepRestrictToStringKeys<{ schema: string }> = DeepRestrictToStringKeys<{ schema: string }>

    Parameters

    Returns Promise<R[]>

ProtectedsendQueryRaw

  • sendQueryRaw<
        T extends
            DeepRestrictToStringKeys<
                {
                    address?: Lowercase<string>
                    | Lowercase<string>[];
                    budget?: number;
                    maxFrequency?:
                        | "once"
                        | "second"
                        | "minute"
                        | "hour"
                        | "day"
                        | "week"
                        | "month"
                        | "year";
                    minBid?: number;
                    schema: string;
                },
            >,
        P extends
            DeepRestrictToStringKeys<{ schema: string }> = DeepRestrictToStringKeys<
            { schema: string },
        >,
        R extends
            DeepRestrictToStringKeys<{ schema: string }> = DeepRestrictToStringKeys<
            { schema: string },
        >,
    >(
        queryPayload: T,
        payloads?: P[],
        account?: AccountInstance,
    ): Promise<ModuleQueryResult<R>>

  • Type Parameters

    • T extends DeepRestrictToStringKeys<
          {
              address?: Lowercase<string>
              | Lowercase<string>[];
              budget?: number;
              maxFrequency?:
                  | "once"
                  | "second"
                  | "minute"
                  | "hour"
                  | "day"
                  | "week"
                  | "month"
                  | "year";
              minBid?: number;
              schema: string;
          },
      >
    • P extends DeepRestrictToStringKeys<{ schema: string }> = DeepRestrictToStringKeys<{ schema: string }>
    • R extends DeepRestrictToStringKeys<{ schema: string }> = DeepRestrictToStringKeys<{ schema: string }>

    Parameters

    Returns Promise<ModuleQueryResult<R>>

siblings

start

  • start(_timeout?: number): Promisable<boolean>

  • Parameters

    • Optional_timeout: number

    Returns Promisable<boolean>

started

  • started(
        notStartedAction?: "error" | "warn" | "log" | "throw" | "none",
        tryStart?: boolean,
    ): Promise<boolean>

  • Parameters

    • OptionalnotStartedAction: "error" | "warn" | "log" | "throw" | "none"
    • OptionaltryStart: boolean

    Returns Promise<boolean>

ProtectedstartHandler

  • startHandler(): Promise<boolean>

  • Returns Promise<boolean>

state

ProtectedstateHandler

stateQuery

stop

  • stop(_timeout?: number): Promise<boolean>

  • Parameters

    • Optional_timeout: number

    Returns Promise<boolean>

ProtectedstopHandler

ProtectedstoreToArchivists

subscribe

ProtectedsubscribeHandler

  • subscribeHandler(): void

  • Returns void

ProtectedupdateIndex

ProtectedvalidateConfig

  • validateConfig(config?: unknown, parents?: string[]): boolean

  • Parameters

    • Optionalconfig: unknown
    • Optionalparents: string[]

    Returns boolean

Static_getRootFunction

  • _getRootFunction(funcName: string): any

  • Parameters

    • funcName: string

    Returns any

Static_noOverride

  • _noOverride(functionName: string): void

  • Parameters

    • functionName: string

    Returns void

Staticcreate

StaticdetermineAccount

Staticfactory

Staticgc

  • gc(force?: boolean): void

  • Parameters

    • Optionalforce: boolean

    Returns void

  • gc(className: string): void

  • Parameters

    • className: string

    Returns void

StaticinstanceCount

  • instanceCount(className: string): number

  • Parameters

    • className: string

    Returns number

StaticinstanceCounts

  • instanceCounts(): Record<string, number>

  • Returns Record<string, number>

StaticstartHistory

  • startHistory(): void

  • Returns void

StaticstopHistory

  • stopHistory(): void

  • Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
_checkDead_getRootFunction_noOverrideaddParentallarchivistInstancebindHashesbindHashesInternalbindQuerybindQueryInternalbindQueryResultbusycertifyParentsclearIndexclearListenersdivinedivineHandlerdivineQueryemitemitSerialgenerateConfigAndAddressgenerateDescribegetArchivistisAllowedArchivingQuerylistenerCountmanifestmanifestHandlermanifestQuerymoduleAddressmoduleAddressHandleroffoffAnyononAnyonceparentspreviousHashprivateChildrenpublicChildrenqueryqueryablequeryHandlerremoveParentresolveresolveArchivingArchivistsresolveIdentifierresolvePrivatesendQuerysendQueryRawsiblingsstartstartedstartHandlerstatestateHandlerstateQuerystopstopHandlerstoreToArchivistssubscribesubscribeHandlerupdateIndexvalidateConfig_getRootFunction_noOverridecreatedetermineAccountfactorygcinstanceCountinstanceCountsstartHistorystopHistory