Class SentinelWrapper<TModule>

Index

Constructors

constructor

Properties

cachedCalls eventData wrapperParams defaultLogger? globalInstances globalInstancesCountHistory instanceIdentityCheck moduleIdentityCheck requiredQueries uniqueName

Accessors

account additionalSigners address config downResolver id logger mod modName params priority privateResolver queries status upResolver historyInterval historyTime maxGcFrequency maxHistoryDepth

Constructors

constructor

new SentinelWrapper<TModule extends SentinelModule = SentinelModule>(
    params: BaseParamsFields & {
        account: AccountInstance;
        additionalSigners?: AccountInstance[];
        mod: TModule;
    },
): SentinelWrapper<TModule>
Type Parameters
- TModule extends SentinelModule = SentinelModule
Parameters
- params: BaseParamsFields & {
      account: AccountInstance;
      additionalSigners?: AccountInstance[];
      mod: TModule;
  }
Returns SentinelWrapper<TModule>
Inherited from ModuleWrapper.constructor
- Defined in packages/modules/packages/module/packages/wrapper/dist/neutral/index.d.ts:49

Properties

`Protected` `Readonly`cachedCalls

cachedCalls: LRUCache<string, DeepRestrictToStringKeys<{ schema: string }>[]>

eventData

eventData: TModule["eventData"]

`Protected` `Readonly`wrapperParams

wrapperParams: BaseParamsFields & {
    account: AccountInstance;
    additionalSigners?: AccountInstance[];
    mod: TModule;
}

`Static` `Optional`defaultLogger

defaultLogger?: Logger

`Static` `Readonly`globalInstances

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

`Static` `Readonly`globalInstancesCountHistory

globalInstancesCountHistory: Record<string, number[]>

`Static`instanceIdentityCheck

instanceIdentityCheck: TypeCheck<
    SentinelInstance<
        BaseParamsFields & {
            account?: AccountInstance
            | "random";
            additionalSigners?: AccountInstance[];
            addToResolvers?: boolean;
            allowNameResolution?: boolean;
            config: DeepRestrictToStringKeys<
                {
                    allowedQueries?: string[];
                    archiving?: { archivists?: string[]; queries?: string[] };
                    archivist?: string;
                    automations?: (
                        | {
                            end?: (...)
                            | (...);
                            frequency?: (...) | (...);
                            frequencyUnits?: (...) | (...) | (...) | (...) | (...);
                            remaining?: (...) | (...);
                            schema: "network.xyo.automation";
                            start: number;
                            type: "interval";
                        }
                        | {
                            end?: (...)
                            | (...);
                            frequency?: (...) | (...);
                            frequencyUnits?: (...) | (...) | (...) | (...) | (...);
                            remaining?: (...) | (...);
                            schema: "network.xyo.automation.interval";
                            start: number;
                            type: "interval";
                        }
                        | {
                            end?: (...)
                            | (...);
                            frequency?: (...) | (...);
                            frequencyUnits?: (...) | (...) | (...) | (...) | (...);
                            remaining?: (...) | (...);
                            schema: "network.xyo.automation.event";
                            start: number;
                            type: "interval";
                        }
                        | { schema: "network.xyo.automation"; type: "event" }
                        | { schema: "network.xyo.automation.interval"; type: "event" }
                        | { schema: "network.xyo.automation.event"; type: "event" }
                    )[];
                    consoleLogger?: any;
                    labels?: { [x: string]: undefined | string };
                    name?: string;
                    paging?: { [x: string]: { size?: number } };
                    retry?: { backoff?: number; interval?: number; retries?: number };
                    schema: string;
                    security?: {
                        allowAnonymous?: boolean;
                        allowed?: { [x: string]: (...)[] };
                        disallowed?: { [x: string]: (...)[] };
                    };
                    sign?: boolean;
                    storeQueries?: boolean;
                    synchronous?: boolean;
                    tasks: (
                        | {
                            endPoint?: | "all"
                            | "clear"
                            | "commit"
                            | "delete"
                            | "get"
                            | "insert";
                            input?: string
                            | boolean
                            | (...)[];
                            mod: string;
                            required?: boolean;
                        }
                        | {
                            endPoint?: "divine";
                            input?: string
                            | boolean
                            | (...)[];
                            mod: string;
                            required?: boolean;
                        }
                        | {
                            endPoint?: "observe";
                            input?: string
                            | boolean
                            | (...)[];
                            mod: string;
                            required?: boolean;
                        }
                        | {
                            endPoint?: string;
                            input?: string
                            | boolean
                            | (...)[];
                            mod: string;
                            required?: boolean;
                        }
                    )[];
                    throwErrors?: boolean;
                    timestamp?: boolean;
                },
            >;
            ephemeralQueryAccountEnabled?: boolean;
            moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
        },
        SentinelModuleEventData<
            Module<
                BaseParamsFields & {
                    account?: AccountInstance
                    | "random";
                    additionalSigners?: AccountInstance[];
                    addToResolvers?: boolean;
                    allowNameResolution?: boolean;
                    config: DeepRestrictToStringKeys<
                        {
                            allowedQueries?: string[];
                            archiving?: { archivists?: (...)
                            | (...); queries?: (...) | (...) };
                            archivist?: string;
                            consoleLogger?: any;
                            labels?: { [x: string]: (...) | (...) };
                            name?: string;
                            paging?: { [x: string]: { size?: ... } };
                            retry?: {
                                backoff?: (...) | (...);
                                interval?: (...) | (...);
                                retries?: (...) | (...);
                            };
                            schema: string;
                            security?: {
                                allowAnonymous?: (...)
                                | (...)
                                | (...);
                                allowed?: (...) | (...);
                                disallowed?: (...) | (...);
                            };
                            sign?: boolean;
                            storeQueries?: boolean;
                            timestamp?: boolean;
                        },
                    >;
                    ephemeralQueryAccountEnabled?: boolean;
                    moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
                },
            >,
        >,
    >,
> = isSentinelInstance

`Static`moduleIdentityCheck

moduleIdentityCheck: ModuleTypeCheck<
    SentinelModule<
        BaseParamsFields & {
            account?: AccountInstance
            | "random";
            additionalSigners?: AccountInstance[];
            addToResolvers?: boolean;
            allowNameResolution?: boolean;
            config: DeepRestrictToStringKeys<
                {
                    allowedQueries?: string[];
                    archiving?: { archivists?: string[]; queries?: string[] };
                    archivist?: string;
                    automations?: (
                        | {
                            end?: (...)
                            | (...);
                            frequency?: (...) | (...);
                            frequencyUnits?: (...) | (...) | (...) | (...) | (...);
                            remaining?: (...) | (...);
                            schema: "network.xyo.automation";
                            start: number;
                            type: "interval";
                        }
                        | {
                            end?: (...)
                            | (...);
                            frequency?: (...) | (...);
                            frequencyUnits?: (...) | (...) | (...) | (...) | (...);
                            remaining?: (...) | (...);
                            schema: "network.xyo.automation.interval";
                            start: number;
                            type: "interval";
                        }
                        | {
                            end?: (...)
                            | (...);
                            frequency?: (...) | (...);
                            frequencyUnits?: (...) | (...) | (...) | (...) | (...);
                            remaining?: (...) | (...);
                            schema: "network.xyo.automation.event";
                            start: number;
                            type: "interval";
                        }
                        | { schema: "network.xyo.automation"; type: "event" }
                        | { schema: "network.xyo.automation.interval"; type: "event" }
                        | { schema: "network.xyo.automation.event"; type: "event" }
                    )[];
                    consoleLogger?: any;
                    labels?: { [x: string]: undefined | string };
                    name?: string;
                    paging?: { [x: string]: { size?: number } };
                    retry?: { backoff?: number; interval?: number; retries?: number };
                    schema: string;
                    security?: {
                        allowAnonymous?: boolean;
                        allowed?: { [x: string]: (...)[] };
                        disallowed?: { [x: string]: (...)[] };
                    };
                    sign?: boolean;
                    storeQueries?: boolean;
                    synchronous?: boolean;
                    tasks: (
                        | {
                            endPoint?: | "all"
                            | "clear"
                            | "commit"
                            | "delete"
                            | "get"
                            | "insert";
                            input?: string
                            | boolean
                            | (...)[];
                            mod: string;
                            required?: boolean;
                        }
                        | {
                            endPoint?: "divine";
                            input?: string
                            | boolean
                            | (...)[];
                            mod: string;
                            required?: boolean;
                        }
                        | {
                            endPoint?: "observe";
                            input?: string
                            | boolean
                            | (...)[];
                            mod: string;
                            required?: boolean;
                        }
                        | {
                            endPoint?: string;
                            input?: string
                            | boolean
                            | (...)[];
                            mod: string;
                            required?: boolean;
                        }
                    )[];
                    throwErrors?: boolean;
                    timestamp?: boolean;
                },
            >;
            ephemeralQueryAccountEnabled?: boolean;
            moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
        },
        SentinelModuleEventData<
            Module<
                BaseParamsFields & {
                    account?: AccountInstance
                    | "random";
                    additionalSigners?: AccountInstance[];
                    addToResolvers?: boolean;
                    allowNameResolution?: boolean;
                    config: DeepRestrictToStringKeys<
                        {
                            allowedQueries?: string[];
                            archiving?: { archivists?: (...)
                            | (...); queries?: (...) | (...) };
                            archivist?: string;
                            consoleLogger?: any;
                            labels?: { [x: string]: (...) | (...) };
                            name?: string;
                            paging?: { [x: string]: { size?: ... } };
                            retry?: {
                                backoff?: (...) | (...);
                                interval?: (...) | (...);
                                retries?: (...) | (...);
                            };
                            schema: string;
                            security?: {
                                allowAnonymous?: (...)
                                | (...)
                                | (...);
                                allowed?: (...) | (...);
                                disallowed?: (...) | (...);
                            };
                            sign?: boolean;
                            storeQueries?: boolean;
                            timestamp?: boolean;
                        },
                    >;
                    ephemeralQueryAccountEnabled?: boolean;
                    moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
                },
            >,
        >,
    >,
> = isSentinelModule

`Static`requiredQueries

requiredQueries: string[] = ...

`Static` `Readonly`uniqueName

uniqueName: string

Accessors

account

get account(): AccountInstance
Returns AccountInstance
Implementation of SentinelInstance.account
Inherited from ModuleWrapper.account
- Defined in packages/modules/packages/module/packages/wrapper/dist/neutral/index.d.ts:50

additionalSigners

get additionalSigners(): AccountInstance[]
Returns AccountInstance[]
Inherited from ModuleWrapper.additionalSigners
- Defined in packages/modules/packages/module/packages/wrapper/dist/neutral/index.d.ts:51

address

get address(): Lowercase<string>
Returns Lowercase<string>
Implementation of SentinelInstance.address
Inherited from ModuleWrapper.address
- Defined in packages/modules/packages/module/packages/wrapper/dist/neutral/index.d.ts:52

config

get config(): Exclude<TWrappedModule["params"]["config"], undefined>
Returns Exclude<TWrappedModule["params"]["config"], undefined>
Implementation of SentinelInstance.config
Inherited from ModuleWrapper.config
- Defined in packages/modules/packages/module/packages/wrapper/dist/neutral/index.d.ts:53

downResolver

get downResolver(): ModuleResolverInstance
Returns ModuleResolverInstance
Inherited from ModuleWrapper.downResolver
- Defined in packages/modules/packages/module/packages/wrapper/dist/neutral/index.d.ts:54

id

get id(): string
Returns string
Implementation of SentinelInstance.id
Inherited from ModuleWrapper.id
- Defined in packages/modules/packages/module/packages/wrapper/dist/neutral/index.d.ts:55

logger

get logger(): undefined | Logger
Returns undefined | Logger
Inherited from ModuleWrapper.logger
- Defined in node_modules/.store/@xylabs-object-npm-4.5.0-9523cbf677/package/dist/neutral/Base.d.ts:27

mod

get mod(): TWrappedModule
Returns TWrappedModule
Inherited from ModuleWrapper.mod
- Defined in packages/modules/packages/module/packages/wrapper/dist/neutral/index.d.ts:56

modName

get modName(): undefined | string
Returns undefined | string
Implementation of SentinelInstance.modName
Inherited from ModuleWrapper.modName
- Defined in packages/modules/packages/module/packages/wrapper/dist/neutral/index.d.ts:57

params

get params(): TParams
Returns TParams
Implementation of SentinelInstance.params
Inherited from ModuleWrapper.params
- Defined in node_modules/.store/@xylabs-object-npm-4.5.0-9523cbf677/package/dist/neutral/Base.d.ts:28

priority

get priority(): 1
Returns 1
Implementation of SentinelInstance.priority
Inherited from ModuleWrapper.priority
- Defined in packages/modules/packages/module/packages/wrapper/dist/neutral/index.d.ts:58

privateResolver

get privateResolver(): ModuleResolverInstance
Returns ModuleResolverInstance
Inherited from ModuleWrapper.privateResolver
- Defined in packages/modules/packages/module/packages/wrapper/dist/neutral/index.d.ts:59

queries

get queries(): string[]
Returns string[]
Implementation of SentinelInstance.queries
Inherited from ModuleWrapper.queries
- Defined in packages/modules/packages/module/packages/wrapper/dist/neutral/index.d.ts:60

status

get status(): ModuleStatus
Returns ModuleStatus
Implementation of SentinelInstance.status
Inherited from ModuleWrapper.status
- Defined in packages/modules/packages/module/packages/wrapper/dist/neutral/index.d.ts:61
set status(value: ModuleStatus): void
Parameters
- value: ModuleStatus
Returns void
Implementation of SentinelInstance.status
Inherited from ModuleWrapper.status
- Defined in packages/modules/packages/module/packages/wrapper/dist/neutral/index.d.ts:63

upResolver

get upResolver(): ModuleResolverInstance
Returns ModuleResolverInstance
Inherited from ModuleWrapper.upResolver
- Defined in packages/modules/packages/module/packages/wrapper/dist/neutral/index.d.ts:62

`Static`historyInterval

get historyInterval(): number
Returns number
Inherited from ModuleWrapper.historyInterval
- Defined in node_modules/.store/@xylabs-object-npm-4.5.0-9523cbf677/package/dist/neutral/Base.d.ts:20
set historyInterval(value: number): void
Parameters
- value: number
Returns void
Inherited from ModuleWrapper.historyInterval
- Defined in node_modules/.store/@xylabs-object-npm-4.5.0-9523cbf677/package/dist/neutral/Base.d.ts:21

`Static`historyTime

get historyTime(): number
Returns number
Inherited from ModuleWrapper.historyTime
- Defined in node_modules/.store/@xylabs-object-npm-4.5.0-9523cbf677/package/dist/neutral/Base.d.ts:22
set historyTime(value: number): void
Parameters
- value: number
Returns void
Inherited from ModuleWrapper.historyTime
- Defined in node_modules/.store/@xylabs-object-npm-4.5.0-9523cbf677/package/dist/neutral/Base.d.ts:23

`Static`maxGcFrequency

get maxGcFrequency(): number
Returns number
Inherited from ModuleWrapper.maxGcFrequency
- Defined in node_modules/.store/@xylabs-object-npm-4.5.0-9523cbf677/package/dist/neutral/Base.d.ts:24
set maxGcFrequency(value: number): void
Parameters
- value: number
Returns void
Inherited from ModuleWrapper.maxGcFrequency
- Defined in node_modules/.store/@xylabs-object-npm-4.5.0-9523cbf677/package/dist/neutral/Base.d.ts:25

`Static`maxHistoryDepth

get maxHistoryDepth(): number
Returns number
Inherited from ModuleWrapper.maxHistoryDepth
- Defined in node_modules/.store/@xylabs-object-npm-4.5.0-9523cbf677/package/dist/neutral/Base.d.ts:26

Methods

addParent

addParent(mod: ModuleInstance): void
Parameters
- mod: ModuleInstance
Returns void
Implementation of SentinelInstance.addParent
Inherited from ModuleWrapper.addParent
- Defined in packages/modules/packages/module/packages/wrapper/dist/neutral/index.d.ts:114

addressPreviousHash

addressPreviousHash(): Promise<
    DeepRestrictToStringKeys<
        {
            address: Lowercase<string>;
            previousHash?: string;
            schema: "network.xyo.address.hash.previous";
        },
    >,
>
Returns Promise<
    DeepRestrictToStringKeys<
        {
            address: Lowercase<string>;
            previousHash?: string;
            schema: "network.xyo.address.hash.previous";
        },
    >,
>
Inherited from ModuleWrapper.addressPreviousHash
- Defined in packages/modules/packages/module/packages/wrapper/dist/neutral/index.d.ts:115

archivists

archivists(): Promise<ArchivistInstance[]>
Returns Promise<ArchivistInstance[]>
- Defined in packages/modules/packages/sentinel/packages/wrapper/src/Wrapper.ts:26

`Protected`bindQuery

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<
            {
                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";
            },
        >[],
    ],
    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
- query: T
- Optionalpayloads: DeepRestrictToStringKeys<{ schema: string }>[]
- Optionalaccount: AccountInstance
- OptionaladditionalSigners: AccountInstance[]
Returns PromiseEx<
    [
        UnsignedQueryBoundWitness,
        DeepRestrictToStringKeys<{ schema: string }>[],
        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";
            },
        >[],
    ],
    AccountInstance,
>
Inherited from ModuleWrapper.bindQuery
- Defined in packages/modules/packages/module/packages/wrapper/dist/neutral/index.d.ts:146

`Protected`bindQueryInternal

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<
            {
                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";
            },
        >[],
    ],
>
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
- Optionalpayloads: DeepRestrictToStringKeys<{ schema: string }>[]
- Optionalaccount: AccountInstance
- OptionaladditionalSigners: AccountInstance[]
Returns Promise<
    [
        UnsignedQueryBoundWitness,
        DeepRestrictToStringKeys<{ schema: string }>[],
        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";
            },
        >[],
    ],
>
Inherited from ModuleWrapper.bindQueryInternal
- Defined in packages/modules/packages/module/packages/wrapper/dist/neutral/index.d.ts:147

clearListeners

clearListeners(eventNames: Parameters<TModule["clearListeners"]>[0]): void
Parameters
- eventNames: Parameters<TModule["clearListeners"]>[0]
Returns void
Implementation of SentinelInstance.clearListeners
Inherited from ModuleWrapper.clearListeners
- Defined in packages/modules/packages/module/packages/wrapper/dist/neutral/index.d.ts:116

emit

emit(
eventName: Parameters<TModule["emit"]>[0],
eventArgs: Parameters<TModule["emit"]>[1],
): Promise<void>
Parameters
- eventName: Parameters<TModule["emit"]>[0]
- eventArgs: Parameters<TModule["emit"]>[1]
Returns Promise<void>
Implementation of SentinelInstance.emit
Inherited from ModuleWrapper.emit
- Defined in packages/modules/packages/module/packages/wrapper/dist/neutral/index.d.ts:117

emitSerial

emitSerial(
eventName: Parameters<TModule["emitSerial"]>[0],
eventArgs: Parameters<TModule["emitSerial"]>[1],
): Promise<void>
Parameters
- eventName: Parameters<TModule["emitSerial"]>[0]
- eventArgs: Parameters<TModule["emitSerial"]>[1]
Returns Promise<void>
Implementation of SentinelInstance.emitSerial
Inherited from ModuleWrapper.emitSerial
- Defined in packages/modules/packages/module/packages/wrapper/dist/neutral/index.d.ts:118

`Protected`filterErrors

filterErrors(
    result: ModuleQueryResult,
): Promise<
    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";
        },
    >[],
>
Parameters
- result: ModuleQueryResult
Returns Promise<
    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";
        },
    >[],
>
Inherited from ModuleWrapper.filterErrors
- Defined in packages/modules/packages/module/packages/wrapper/dist/neutral/index.d.ts:148

listenerCount

listenerCount(eventNames: Parameters<TModule["listenerCount"]>[0]): number
Parameters
- eventNames: Parameters<TModule["listenerCount"]>[0]
Returns number
Implementation of SentinelInstance.listenerCount
Inherited from ModuleWrapper.listenerCount
- Defined in packages/modules/packages/module/packages/wrapper/dist/neutral/index.d.ts:119

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 };
            };
        },
    >,
>
Implementation of SentinelInstance.manifest
Inherited from ModuleWrapper.manifest
- Defined in packages/modules/packages/module/packages/wrapper/dist/neutral/index.d.ts:120

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
- account: AccountInstance
- OptionalmaxDepth: number
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 };
                };
            },
        >,
    >,
>
Implementation of SentinelInstance.manifestQuery
Inherited from ModuleWrapper.manifestQuery
- Defined in packages/modules/packages/module/packages/wrapper/dist/neutral/index.d.ts:121

moduleAddress

moduleAddress(): Promise<
    DeepRestrictToStringKeys<
        {
            address: Lowercase<string>;
            previousHash?: string;
            schema: "network.xyo.address.hash.previous";
        },
    >[],
>
Returns Promise<
    DeepRestrictToStringKeys<
        {
            address: Lowercase<string>;
            previousHash?: string;
            schema: "network.xyo.address.hash.previous";
        },
    >[],
>
Implementation of SentinelInstance.moduleAddress
Inherited from ModuleWrapper.moduleAddress
- Defined in packages/modules/packages/module/packages/wrapper/dist/neutral/index.d.ts:122

off

off<TEventName extends string | number | symbol>(
eventNames: TEventName,
listener: EventListener<TModule["eventData"][TEventName]>,
): void
Type Parameters
- TEventName extends string | number | symbol
Parameters
- eventNames: TEventName
- listener: EventListener<TModule["eventData"][TEventName]>
Returns void
Implementation of SentinelInstance.off
Inherited from ModuleWrapper.off
- Defined in packages/modules/packages/module/packages/wrapper/dist/neutral/index.d.ts:123

offAny

offAny(listener: EventAnyListener): void
Parameters
- listener: EventAnyListener
Returns void
Implementation of SentinelInstance.offAny
Inherited from ModuleWrapper.offAny
- Defined in packages/modules/packages/module/packages/wrapper/dist/neutral/index.d.ts:124

on

on<TEventName extends string | number | symbol>(
eventNames: TEventName,
listener: EventListener<TModule["eventData"][TEventName]>,
): EventUnsubscribeFunction
Type Parameters
- TEventName extends string | number | symbol
Parameters
- eventNames: TEventName
- listener: EventListener<TModule["eventData"][TEventName]>
Returns EventUnsubscribeFunction
Implementation of SentinelInstance.on
Inherited from ModuleWrapper.on
- Defined in packages/modules/packages/module/packages/wrapper/dist/neutral/index.d.ts:125

onAny

onAny(listener: EventAnyListener): EventUnsubscribeFunction
Parameters
- listener: EventAnyListener
Returns EventUnsubscribeFunction
Implementation of SentinelInstance.onAny
Inherited from ModuleWrapper.onAny
- Defined in packages/modules/packages/module/packages/wrapper/dist/neutral/index.d.ts:126

once

once<TEventName extends string | number | symbol>(
eventName: TEventName,
listener: EventListener<TModule["eventData"][TEventName]>,
): EventUnsubscribeFunction
Type Parameters
- TEventName extends string | number | symbol
Parameters
- eventName: TEventName
- listener: EventListener<TModule["eventData"][TEventName]>
Returns EventUnsubscribeFunction
Implementation of SentinelInstance.once
Inherited from ModuleWrapper.once
- Defined in packages/modules/packages/module/packages/wrapper/dist/neutral/index.d.ts:127

parents

parents(): Promisable<ModuleInstance[]>
Returns Promisable<ModuleInstance[]>
Implementation of SentinelInstance.parents
Inherited from ModuleWrapper.parents
- Defined in packages/modules/packages/module/packages/wrapper/dist/neutral/index.d.ts:128

previousHash

previousHash(): Promise<undefined | string>
Returns Promise<undefined | string>
Implementation of SentinelInstance.previousHash
Inherited from ModuleWrapper.previousHash
- Defined in packages/modules/packages/module/packages/wrapper/dist/neutral/index.d.ts:129

previousHashQuery

previousHashQuery(
    account?: AccountInstance,
): Promise<
    ModuleQueryResult<
        DeepRestrictToStringKeys<
            {
                address: Lowercase<string>;
                previousHash?: string;
                schema: "network.xyo.address.hash.previous";
            },
        >,
    >,
>
Parameters
- Optionalaccount: AccountInstance
Returns Promise<
    ModuleQueryResult<
        DeepRestrictToStringKeys<
            {
                address: Lowercase<string>;
                previousHash?: string;
                schema: "network.xyo.address.hash.previous";
            },
        >,
    >,
>
Inherited from ModuleWrapper.previousHashQuery
- Defined in packages/modules/packages/module/packages/wrapper/dist/neutral/index.d.ts:130

privateChildren

privateChildren(): Promise<ModuleInstance[]>
Returns Promise<ModuleInstance[]>
Implementation of SentinelInstance.privateChildren
Inherited from ModuleWrapper.privateChildren
- Defined in packages/modules/packages/module/packages/wrapper/dist/neutral/index.d.ts:131

publicChildren

publicChildren(): Promise<ModuleInstance[]>
Returns Promise<ModuleInstance[]>
Implementation of SentinelInstance.publicChildren
Inherited from ModuleWrapper.publicChildren
- Defined in packages/modules/packages/module/packages/wrapper/dist/neutral/index.d.ts:132

query

query<T extends UnsignedQueryBoundWitness = UnsignedQueryBoundWitness>(
query: T,
payloads?: DeepRestrictToStringKeys<{ schema: string }>[],
): Promise<ModuleQueryResult>
Type Parameters
- T extends UnsignedQueryBoundWitness = UnsignedQueryBoundWitness
Parameters
- query: T
- Optionalpayloads: DeepRestrictToStringKeys<{ schema: string }>[]
Returns Promise<ModuleQueryResult>
Implementation of SentinelInstance.query
Inherited from ModuleWrapper.query
- Defined in packages/modules/packages/module/packages/wrapper/dist/neutral/index.d.ts:133

queryable

queryable<T extends UnsignedQueryBoundWitness = UnsignedQueryBoundWitness>(
query: T,
payloads?: DeepRestrictToStringKeys<{ schema: string }>[],
): Promisable<boolean>
Type Parameters
- T extends UnsignedQueryBoundWitness = UnsignedQueryBoundWitness
Parameters
- query: T
- Optionalpayloads: DeepRestrictToStringKeys<{ schema: string }>[]
Returns Promisable<boolean>
Implementation of SentinelInstance.queryable
Inherited from ModuleWrapper.queryable
- Defined in packages/modules/packages/module/packages/wrapper/dist/neutral/index.d.ts:134

removeParent

removeParent(address: Lowercase<string>): void
Parameters
- address: Lowercase<string>
Returns void
Implementation of SentinelInstance.removeParent
Inherited from ModuleWrapper.removeParent
- Defined in packages/modules/packages/module/packages/wrapper/dist/neutral/index.d.ts:135

report

report(
payloads?: DeepRestrictToStringKeys<{ schema: string }>[],
): Promise<DeepRestrictToStringKeys<{ schema: string }>[]>
Parameters
- Optionalpayloads: DeepRestrictToStringKeys<{ schema: string }>[]
Returns Promise<DeepRestrictToStringKeys<{ schema: string }>[]>
Implementation of SentinelInstance.report
- Defined in packages/modules/packages/sentinel/packages/wrapper/src/Wrapper.ts:30

reportQuery

reportQuery(
payloads?: DeepRestrictToStringKeys<{ schema: string }>[],
account?: AccountInstance,
): Promise<ModuleQueryResult>
Parameters
- Optionalpayloads: DeepRestrictToStringKeys<{ schema: string }>[]
- Optionalaccount: AccountInstance
Returns Promise<ModuleQueryResult>
Implementation of SentinelInstance.reportQuery
- Defined in packages/modules/packages/sentinel/packages/wrapper/src/Wrapper.ts:35

resolve

resolve<T extends ModuleInstance = ModuleInstance>(): Promise<T[]>
Type Parameters
- T extends ModuleInstance = ModuleInstance
Returns Promise<T[]>
Implementation of SentinelInstance.resolve
Inherited from ModuleWrapper.resolve
- Defined in packages/modules/packages/module/packages/wrapper/dist/neutral/index.d.ts:136
resolve<T extends ModuleInstance = ModuleInstance>(
all: "*",
options?: ModuleFilterOptions<T>,
): Promise<T[]>
Type Parameters
- T extends ModuleInstance = ModuleInstance
Parameters
- all: "*"
- Optionaloptions: ModuleFilterOptions<T>
Returns Promise<T[]>
Implementation of SentinelInstance.resolve
Inherited from ModuleWrapper.resolve
- Defined in packages/modules/packages/module/packages/wrapper/dist/neutral/index.d.ts:137
resolve<T extends ModuleInstance = ModuleInstance>(
filter: undefined | ModuleFilter<T>,
options?: ModuleFilterOptions<T>,
): Promise<T[]>
Type Parameters
- T extends ModuleInstance = ModuleInstance
Parameters
- filter: undefined | ModuleFilter<T>
- Optionaloptions: ModuleFilterOptions<T>
Returns Promise<T[]>
Implementation of SentinelInstance.resolve
Inherited from ModuleWrapper.resolve
- Defined in packages/modules/packages/module/packages/wrapper/dist/neutral/index.d.ts:138
resolve<T extends ModuleInstance = ModuleInstance>(
id: string,
options?: ModuleFilterOptions<T>,
): Promise<ModuleInstance>
Type Parameters
- T extends ModuleInstance = ModuleInstance
Parameters
- id: string
- Optionaloptions: ModuleFilterOptions<T>
Returns Promise<ModuleInstance>
Implementation of SentinelInstance.resolve
Inherited from ModuleWrapper.resolve
- Defined in packages/modules/packages/module/packages/wrapper/dist/neutral/index.d.ts:139
resolve<T extends ModuleInstance = ModuleInstance>(
filter?: ModuleFilter<T>,
options?: ModuleFilterOptions<T>,
): Promise<T[]>
Type Parameters
- T extends ModuleInstance = ModuleInstance
Parameters
- Optionalfilter: ModuleFilter<T>
- Optionaloptions: ModuleFilterOptions<T>
Returns Promise<T[]>
Implementation of SentinelInstance.resolve
Inherited from ModuleWrapper.resolve
- Defined in packages/modules/packages/module/packages/wrapper/dist/neutral/index.d.ts:140

resolvePrivate

resolvePrivate<T extends ModuleInstance = ModuleInstance>(
all: "*",
options?: ModuleFilterOptions<T>,
): Promise<T[]>
Type Parameters
- T extends ModuleInstance = ModuleInstance
Parameters
- all: "*"
- Optionaloptions: ModuleFilterOptions<T>
Returns Promise<T[]>
Implementation of SentinelInstance.resolvePrivate
Inherited from ModuleWrapper.resolvePrivate
- Defined in packages/modules/packages/module/packages/wrapper/dist/neutral/index.d.ts:141
resolvePrivate<T extends ModuleInstance = ModuleInstance>(
id: string,
options?: ModuleFilterOptions<T>,
): Promise<undefined | T>
Type Parameters
- T extends ModuleInstance = ModuleInstance
Parameters
- id: string
- Optionaloptions: ModuleFilterOptions<T>
Returns Promise<undefined | T>
Implementation of SentinelInstance.resolvePrivate
Inherited from ModuleWrapper.resolvePrivate
- Defined in packages/modules/packages/module/packages/wrapper/dist/neutral/index.d.ts:142

`Protected`sendQuery

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[],
): 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
- queryPayload: T
- Optionalpayloads: P[]
Returns Promise<R[]>
Inherited from ModuleWrapper.sendQuery
- Defined in packages/modules/packages/module/packages/wrapper/dist/neutral/index.d.ts:149

`Protected`sendQueryRaw

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
- queryPayload: T
- Optionalpayloads: P[]
- Optionalaccount: AccountInstance
Returns Promise<ModuleQueryResult<R>>
Inherited from ModuleWrapper.sendQueryRaw
- Defined in packages/modules/packages/module/packages/wrapper/dist/neutral/index.d.ts:150

siblings

siblings(): Promise<ModuleInstance[]>
Returns Promise<ModuleInstance[]>
Implementation of SentinelInstance.siblings
Inherited from ModuleWrapper.siblings
- Defined in packages/modules/packages/module/packages/wrapper/dist/neutral/index.d.ts:143

state

state(): Promise<DeepRestrictToStringKeys<{ schema: string }>[]>
Returns Promise<DeepRestrictToStringKeys<{ schema: string }>[]>
Implementation of SentinelInstance.state
Inherited from ModuleWrapper.state
- Defined in packages/modules/packages/module/packages/wrapper/dist/neutral/index.d.ts:144

stateQuery

stateQuery(_account: AccountInstance): Promise<ModuleQueryResult>
Parameters
- _account: AccountInstance
Returns Promise<ModuleQueryResult>
Implementation of SentinelInstance.stateQuery
Inherited from ModuleWrapper.stateQuery
- Defined in packages/modules/packages/module/packages/wrapper/dist/neutral/index.d.ts:145

witnesses

witnesses(): Promise<WitnessInstance[]>
Returns Promise<WitnessInstance[]>
- Defined in packages/modules/packages/sentinel/packages/wrapper/src/Wrapper.ts:40

`Static`canWrap

canWrap(
    mod?: Module,
): mod is Module<
    BaseParamsFields & {
        account?: AccountInstance
        | "random";
        additionalSigners?: AccountInstance[];
        addToResolvers?: boolean;
        allowNameResolution?: boolean;
        config: DeepRestrictToStringKeys<
            {
                allowedQueries?: string[];
                archiving?: { archivists?: string[]; queries?: string[] };
                archivist?: string;
                consoleLogger?: LogLevel;
                labels?: { [x: string]: undefined | string };
                name?: string;
                paging?: { [x: string]: { size?: number } };
                retry?: { backoff?: number; interval?: number; retries?: number };
                schema: string;
                security?: {
                    allowAnonymous?: boolean;
                    allowed?: { [x: string]: ((...) | (...))[] };
                    disallowed?: { [x: string]: Lowercase<(...)>[] };
                };
                sign?: boolean;
                storeQueries?: boolean;
                timestamp?: boolean;
            },
        >;
        ephemeralQueryAccountEnabled?: boolean;
        moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
    },
>
Parameters
- Optionalmod: Module
Returns mod is Module<
    BaseParamsFields & {
        account?: AccountInstance
        | "random";
        additionalSigners?: AccountInstance[];
        addToResolvers?: boolean;
        allowNameResolution?: boolean;
        config: DeepRestrictToStringKeys<
            {
                allowedQueries?: string[];
                archiving?: { archivists?: string[]; queries?: string[] };
                archivist?: string;
                consoleLogger?: LogLevel;
                labels?: { [x: string]: undefined | string };
                name?: string;
                paging?: { [x: string]: { size?: number } };
                retry?: { backoff?: number; interval?: number; retries?: number };
                schema: string;
                security?: {
                    allowAnonymous?: boolean;
                    allowed?: { [x: string]: ((...) | (...))[] };
                    disallowed?: { [x: string]: Lowercase<(...)>[] };
                };
                sign?: boolean;
                storeQueries?: boolean;
                timestamp?: boolean;
            },
        >;
        ephemeralQueryAccountEnabled?: boolean;
        moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
    },
>
Inherited from ModuleWrapper.canWrap
- Defined in packages/modules/packages/module/packages/wrapper/dist/neutral/index.d.ts:64

`Static`gc

gc(force?: boolean): void
Parameters
- Optionalforce: boolean
Returns void
Inherited from ModuleWrapper.gc
- Defined in node_modules/.store/@xylabs-object-npm-4.5.0-9523cbf677/package/dist/neutral/Base.d.ts:29
gc(className: string): void
Parameters
- className: string
Returns void
Inherited from ModuleWrapper.gc
- Defined in node_modules/.store/@xylabs-object-npm-4.5.0-9523cbf677/package/dist/neutral/Base.d.ts:30

`Static`hasRequiredQueries

hasRequiredQueries(mod: Module): boolean
Parameters
- mod: Module
Returns boolean
Inherited from ModuleWrapper.hasRequiredQueries
- Defined in packages/modules/packages/module/packages/wrapper/dist/neutral/index.d.ts:108

`Static`instanceCount

instanceCount(className: string): number
Parameters
- className: string
Returns number
Inherited from ModuleWrapper.instanceCount
- Defined in node_modules/.store/@xylabs-object-npm-4.5.0-9523cbf677/package/dist/neutral/Base.d.ts:31

`Static`instanceCounts

instanceCounts(): Record<string, number>
Returns Record<string, number>
Inherited from ModuleWrapper.instanceCounts
- Defined in node_modules/.store/@xylabs-object-npm-4.5.0-9523cbf677/package/dist/neutral/Base.d.ts:32

`Static`is

is<TModuleWrapper extends ModuleWrapper>(
this: ConstructableModuleWrapper<TModuleWrapper>,
wrapper: any,
): wrapper is TModuleWrapper
Type Parameters
- TModuleWrapper extends ModuleWrapper
Parameters
- this: ConstructableModuleWrapper<TModuleWrapper>
- wrapper: any
Returns wrapper is TModuleWrapper
Inherited from ModuleWrapper.is
- Defined in packages/modules/packages/module/packages/wrapper/dist/neutral/index.d.ts:109

`Static`missingRequiredQueries

missingRequiredQueries(mod: Module): string[]
Parameters
- mod: Module
Returns string[]
Inherited from ModuleWrapper.missingRequiredQueries
- Defined in packages/modules/packages/module/packages/wrapper/dist/neutral/index.d.ts:110

`Static`startHistory

startHistory(): void
Returns void
Inherited from ModuleWrapper.startHistory
- Defined in node_modules/.store/@xylabs-object-npm-4.5.0-9523cbf677/package/dist/neutral/Base.d.ts:33

`Static`stopHistory

stopHistory(): void
Returns void
Inherited from ModuleWrapper.stopHistory
- Defined in node_modules/.store/@xylabs-object-npm-4.5.0-9523cbf677/package/dist/neutral/Base.d.ts:34

`Static`tryWrap

tryWrap<TModuleWrapper extends ModuleWrapper>(
    this: ConstructableModuleWrapper<TModuleWrapper>,
    mod: undefined | Module,
    account: AccountInstance,
    checkIdentity?: boolean,
): undefined | TModuleWrapper
Type Parameters
- TModuleWrapper extends ModuleWrapper
Parameters
- this: ConstructableModuleWrapper<TModuleWrapper>
- mod: undefined | Module
- account: AccountInstance
- OptionalcheckIdentity: boolean
Returns undefined | TModuleWrapper
Inherited from ModuleWrapper.tryWrap
- Defined in packages/modules/packages/module/packages/wrapper/dist/neutral/index.d.ts:111

`Static`with

with<TModuleWrapper extends ModuleWrapper, R extends Promisable<void> = void>(
    this: ConstructableModuleWrapper<TModuleWrapper>,
    mod: any,
    closure: (mod: TModuleWrapper) => R,
): undefined | R
Type Parameters
- TModuleWrapper extends ModuleWrapper
- R extends Promisable<void> = void
Parameters
- this: ConstructableModuleWrapper<TModuleWrapper>
- mod: any
- closure: (mod: TModuleWrapper) => R
Returns undefined | R
Inherited from ModuleWrapper.with
- Defined in packages/modules/packages/module/packages/wrapper/dist/neutral/index.d.ts:112

`Static`wrap

wrap<TModuleWrapper extends ModuleWrapper>(
    this: ConstructableModuleWrapper<TModuleWrapper>,
    mod: undefined | Module,
    account: AccountInstance,
    checkIdentity?: boolean,
): TModuleWrapper
Type Parameters
- TModuleWrapper extends ModuleWrapper
Parameters
- this: ConstructableModuleWrapper<TModuleWrapper>
- mod: undefined | Module
- account: AccountInstance
- OptionalcheckIdentity: boolean
Returns TModuleWrapper
Inherited from ModuleWrapper.wrap
- Defined in packages/modules/packages/module/packages/wrapper/dist/neutral/index.d.ts:113

Class SentinelWrapper<TModule>

Type Parameters

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns SentinelWrapper<TModule>

Properties

Protected ReadonlycachedCalls

eventData

Protected ReadonlywrapperParams

Static OptionaldefaultLogger

Static ReadonlyglobalInstances

Static ReadonlyglobalInstancesCountHistory

StaticinstanceIdentityCheck

StaticmoduleIdentityCheck

StaticrequiredQueries

Static ReadonlyuniqueName

Accessors

account

Returns AccountInstance

additionalSigners

Returns AccountInstance[]

address

Returns Lowercase<string>

config

Returns Exclude<TWrappedModule["params"]["config"], undefined>

downResolver

Returns ModuleResolverInstance

id

Returns string

logger

Returns undefined | Logger

mod

Returns TWrappedModule

modName

Returns undefined | string

params

Returns TParams

priority

Returns 1

privateResolver

Returns ModuleResolverInstance

queries

Returns string[]

status

Returns ModuleStatus

Parameters

Returns void

upResolver

Returns ModuleResolverInstance

StatichistoryInterval

Returns number

Parameters

Returns void

StatichistoryTime

Returns number

Parameters

Returns void

StaticmaxGcFrequency

Returns number

Parameters

Returns void

StaticmaxHistoryDepth

Returns number

Methods

addParent

Parameters

Returns void

addressPreviousHash

Returns Promise< DeepRestrictToStringKeys< { address: Lowercase<string>; previousHash?: string; schema: "network.xyo.address.hash.previous"; }, >,>

archivists

Returns Promise<ArchivistInstance[]>

`Protected` `Readonly`cachedCalls

`Protected` `Readonly`wrapperParams

`Static` `Optional`defaultLogger

`Static` `Readonly`globalInstances

`Static` `Readonly`globalInstancesCountHistory

`Static`instanceIdentityCheck

`Static`moduleIdentityCheck

`Static`requiredQueries

`Static` `Readonly`uniqueName

`Static`historyInterval

`Static`historyTime

`Static`maxGcFrequency

`Static`maxHistoryDepth

Returns Promise<
DeepRestrictToStringKeys<
{
address: Lowercase<string>;
previousHash?: string;
schema: "network.xyo.address.hash.previous";
},
>,
>

`Protected`bindQuery

`Protected`bindQueryInternal

`Protected`filterErrors

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

Returns Promise<
ModuleQueryResult<
DeepRestrictToStringKeys<
{
address: Lowercase<string>;
previousHash?: string;
schema: "network.xyo.address.hash.previous";
},
>,
>,
>