Class ModuleWrapper<TWrappedModule>

constructor

• new ModuleWrapper<TWrappedModule>(params): ModuleWrapper<TWrappedModule>

• Type Parameters

  • TWrappedModule extends ModuleFields<ModuleParams<SchemaFields & PayloadFields & {
        archivist?: ArchivistModuleConfig;
        name?: string;
        paging?: Record<string, {
            size?: number;
        }>;
        schema: string;
        security?: {
            allowAnonymous?: boolean;
            allowed?: Record<string, (string | CosigningAddressSet)[]>;
            disallowed?: Record<string, string[]>;
        };
        storeQueries?: boolean;
    } & Omit<Omit<SchemaFields & PayloadFields & {
        archivist?: ArchivistModuleConfig;
        name?: string;
        paging?: Record<string, {
            size?: number;
        }>;
        schema: "network.xyo.module.config";
        security?: {
            allowAnonymous?: boolean;
            allowed?: Record<string, (string | CosigningAddressSet)[]>;
            disallowed?: Record<string, string[]>;
        };
        storeQueries?: boolean;
    } & Omit<undefined, "schema">, "schema"> & {
        schema: string;
    }, "schema">, undefined>> & EventFunctions<ModuleEventData, TWrappedModule> = Module<ModuleParams<SchemaFields & PayloadFields & {
        archivist?: ArchivistModuleConfig;
        name?: string;
        paging?: Record<string, {
            size?: number;
        }>;
        schema: string;
        security?: {
            allowAnonymous?: boolean;
            allowed?: Record<string, (string | CosigningAddressSet)[]>;
            disallowed?: Record<string, string[]>;
        };
        storeQueries?: boolean;
    } & Omit<Omit<SchemaFields & PayloadFields & {
        archivist?: ArchivistModuleConfig;
        name?: string;
        paging?: Record<string, {
            size?: number;
        }>;
        schema: "network.xyo.module.config";
        security?: {
            allowAnonymous?: boolean;
            allowed?: Record<string, (string | CosigningAddressSet)[]>;
            disallowed?: Record<string, string[]>;
        };
        storeQueries?: boolean;
    } & Omit<undefined, "schema">, "schema"> & {
        schema: string;
    }, "schema">, undefined>, ModuleEventData>

  Parameters

  • params: BaseParamsFields & {
        account?: AccountInstance;
        module: TWrappedModule;
    }

  Returns ModuleWrapper<TWrappedModule>

eventData

Static requiredQueries

account

• get account(): undefined | AccountInstance

• Returns undefined | AccountInstance

address

• get address(): string

• Returns string

config

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

• Returns TWrappedModule["config"]

downResolver

• get downResolver(): ModuleResolver

• Returns ModuleResolver

module

• get module(): TWrappedModule

• Returns TWrappedModule

queries

• get queries(): string[]

• Returns string[]

upResolver

• get upResolver(): ModuleResolver

• Returns ModuleResolver

clearListeners

• clearListeners(eventNames): void

• Parameters

  • eventNames: Parameters<TWrappedModule["clearListeners"]>[0]

  Returns void

describe

• describe(): Promise<Promise<Promisable<ModuleDescription, never>>>

• Returns Promise<Promise<Promisable<ModuleDescription, never>>>

discover

• discover(): Promise<(SchemaFields & PayloadFields & {
      schema: string;
  })[]>

• Returns Promise<(SchemaFields & PayloadFields & {
      schema: string;
  })[]>

emit

• emit(eventName, eventArgs): Promise<void>

• Parameters

  • eventName: Parameters<TWrappedModule["emit"]>[0]

  • eventArgs: Parameters<TWrappedModule["emit"]>[1]

  Returns Promise<void>

emitSerial

• emitSerial(eventName, eventArgs): Promise<void>

• Parameters

  • eventName: Parameters<TWrappedModule["emitSerial"]>[0]

  • eventArgs: Parameters<TWrappedModule["emitSerial"]>[1]

  Returns Promise<void>

listenerCount

• listenerCount(eventNames): number

• Parameters

  • eventNames: Parameters<TWrappedModule["listenerCount"]>[0]

  Returns number

off

• off<TEventName>(eventNames, listener): void

• Type Parameters

  • TEventName extends string | number | symbol

  Parameters

  • eventNames: TEventName

  • listener: EventListener<TWrappedModule["eventData"][TEventName]>

  Returns void

offAny

• offAny(listener): void

• Parameters

  • listener: EventAnyListener<EventArgs>

  Returns void

on

• on<TEventName>(eventNames, listener): EventUnsubscribeFunction

• Type Parameters

  • TEventName extends string | number | symbol

  Parameters

  • eventNames: TEventName

  • listener: EventListener<TWrappedModule["eventData"][TEventName]>

  Returns EventUnsubscribeFunction

onAny

• onAny(listener): EventUnsubscribeFunction

• Parameters

  • listener: EventAnyListener<EventArgs>

  Returns EventUnsubscribeFunction

once

• once<TEventName>(eventName, listener): EventUnsubscribeFunction

• Type Parameters

  • TEventName extends string | number | symbol

  Parameters

  • eventName: TEventName

  • listener: EventListener<TWrappedModule["eventData"][TEventName]>

  Returns EventUnsubscribeFunction

previousHash

• previousHash(): Promise<(SchemaFields & PayloadFields & {
      schema: string;
  })[]>

• Returns Promise<(SchemaFields & PayloadFields & {
      schema: string;
  })[]>

query

• query<T>(query, payloads?): Promise<ModuleQueryResult<SchemaFields & PayloadFields & {
      schema: string;
  }>>

• Type Parameters

  • T extends SchemaFields & PayloadFields & BoundWitnessFields & {
        query: string;
        resultSet?: string;
        schema: "network.xyo.boundwitness";
    } = SchemaFields & PayloadFields & BoundWitnessFields & {
        query: string;
        resultSet?: string;
        schema: "network.xyo.boundwitness";
    }

  Parameters

  • query: T

  • Optional payloads: (SchemaFields & PayloadFields & {
        schema: string;
    })[]

  Returns Promise<ModuleQueryResult<SchemaFields & PayloadFields & {
      schema: string;
  }>>

queryable

• queryable<T>(query, payloads?): Promisable<boolean, never>

• Type Parameters

  • T extends SchemaFields & PayloadFields & BoundWitnessFields & {
        query: string;
        resultSet?: string;
        schema: "network.xyo.boundwitness";
    } = SchemaFields & PayloadFields & BoundWitnessFields & {
        query: string;
        resultSet?: string;
        schema: "network.xyo.boundwitness";
    }

  Parameters

  • query: T

  • Optional payloads: (SchemaFields & PayloadFields & {
        schema: string;
    })[]

  Returns Promisable<boolean, never>

resolve

• resolve<TModule>(filter?): Promise<TModule[]>

• Type Parameters

  • TModule extends ModuleFields<ModuleParams<SchemaFields & PayloadFields & {
        archivist?: ArchivistModuleConfig;
        name?: string;
        paging?: Record<string, {
            size?: number;
        }>;
        schema: string;
        security?: {
            allowAnonymous?: boolean;
            allowed?: Record<string, (string | CosigningAddressSet)[]>;
            disallowed?: Record<string, string[]>;
        };
        storeQueries?: boolean;
    } & Omit<Omit<SchemaFields & PayloadFields & {
        archivist?: ArchivistModuleConfig;
        name?: string;
        paging?: Record<string, {
            size?: number;
        }>;
        schema: "network.xyo.module.config";
        security?: {
            allowAnonymous?: boolean;
            allowed?: Record<string, (string | CosigningAddressSet)[]>;
            disallowed?: Record<string, string[]>;
        };
        storeQueries?: boolean;
    } & Omit<undefined, "schema">, "schema"> & {
        schema: string;
    }, "schema">, undefined>> & EventFunctions<ModuleEventData, TModule> = Module<ModuleParams<SchemaFields & PayloadFields & {
        archivist?: ArchivistModuleConfig;
        name?: string;
        paging?: Record<string, {
            size?: number;
        }>;
        schema: string;
        security?: {
            allowAnonymous?: boolean;
            allowed?: Record<string, (string | CosigningAddressSet)[]>;
            disallowed?: Record<string, string[]>;
        };
        storeQueries?: boolean;
    } & Omit<Omit<SchemaFields & PayloadFields & {
        archivist?: ArchivistModuleConfig;
        name?: string;
        paging?: Record<string, {
            size?: number;
        }>;
        schema: "network.xyo.module.config";
        security?: {
            allowAnonymous?: boolean;
            allowed?: Record<string, (string | CosigningAddressSet)[]>;
            disallowed?: Record<string, string[]>;
        };
        storeQueries?: boolean;
    } & Omit<undefined, "schema">, "schema"> & {
        schema: string;
    }, "schema">, undefined>, ModuleEventData>

  Parameters

  • Optional filter: ModuleFilter

  Returns Promise<TModule[]>

• resolve<TModule>(nameOrAddress): Promise<undefined | TModule>

• Type Parameters

  • TModule extends ModuleFields<ModuleParams<SchemaFields & PayloadFields & {
        archivist?: ArchivistModuleConfig;
        name?: string;
        paging?: Record<string, {
            size?: number;
        }>;
        schema: string;
        security?: {
            allowAnonymous?: boolean;
            allowed?: Record<string, (string | CosigningAddressSet)[]>;
            disallowed?: Record<string, string[]>;
        };
        storeQueries?: boolean;
    } & Omit<Omit<SchemaFields & PayloadFields & {
        archivist?: ArchivistModuleConfig;
        name?: string;
        paging?: Record<string, {
            size?: number;
        }>;
        schema: "network.xyo.module.config";
        security?: {
            allowAnonymous?: boolean;
            allowed?: Record<string, (string | CosigningAddressSet)[]>;
            disallowed?: Record<string, string[]>;
        };
        storeQueries?: boolean;
    } & Omit<undefined, "schema">, "schema"> & {
        schema: string;
    }, "schema">, undefined>> & EventFunctions<ModuleEventData, TModule> = Module<ModuleParams<SchemaFields & PayloadFields & {
        archivist?: ArchivistModuleConfig;
        name?: string;
        paging?: Record<string, {
            size?: number;
        }>;
        schema: string;
        security?: {
            allowAnonymous?: boolean;
            allowed?: Record<string, (string | CosigningAddressSet)[]>;
            disallowed?: Record<string, string[]>;
        };
        storeQueries?: boolean;
    } & Omit<Omit<SchemaFields & PayloadFields & {
        archivist?: ArchivistModuleConfig;
        name?: string;
        paging?: Record<string, {
            size?: number;
        }>;
        schema: "network.xyo.module.config";
        security?: {
            allowAnonymous?: boolean;
            allowed?: Record<string, (string | CosigningAddressSet)[]>;
            disallowed?: Record<string, string[]>;
        };
        storeQueries?: boolean;
    } & Omit<undefined, "schema">, "schema"> & {
        schema: string;
    }, "schema">, undefined>, ModuleEventData>

  Parameters

  • nameOrAddress: string

  Returns Promise<undefined | TModule>

resolveWrapped

• resolveWrapped<T>(wrapper, filter?): Promise<T[]>

• Resolves the supplied filter into wrapped modules

  Example

  Example using ArchivistWrapper

  const filter = { address: [address] }
  const mods: ArchivistWrapper[] = await node.resolveWrapped(ArchivistWrapper, filter)
  Copy

  Type Parameters

  • T extends ModuleWrapper<Module<ModuleParams<SchemaFields & PayloadFields & {
        archivist?: ArchivistModuleConfig;
        name?: string;
        paging?: Record<string, {
            size?: number;
        }>;
        schema: string;
        security?: {
            allowAnonymous?: boolean;
            allowed?: Record<string, (string | CosigningAddressSet)[]>;
            disallowed?: Record<string, string[]>;
        };
        storeQueries?: boolean;
    } & Omit<Omit<SchemaFields & PayloadFields & {
        archivist?: ArchivistModuleConfig;
        name?: string;
        paging?: Record<string, {
            size?: number;
        }>;
        schema: "network.xyo.module.config";
        security?: {
            allowAnonymous?: boolean;
            allowed?: Record<string, (string | CosigningAddressSet)[]>;
            disallowed?: Record<string, string[]>;
        };
        storeQueries?: boolean;
    } & Omit<undefined, "schema">, "schema"> & {
        schema: string;
    }, "schema">, undefined>, ModuleEventData>, T> = ModuleWrapper<Module<ModuleParams<SchemaFields & PayloadFields & {
        archivist?: ArchivistModuleConfig;
        name?: string;
        paging?: Record<string, {
            size?: number;
        }>;
        schema: string;
        security?: {
            allowAnonymous?: boolean;
            allowed?: Record<string, (string | CosigningAddressSet)[]>;
            disallowed?: Record<string, string[]>;
        };
        storeQueries?: boolean;
    } & Omit<Omit<SchemaFields & PayloadFields & {
        archivist?: ArchivistModuleConfig;
        name?: string;
        paging?: Record<string, {
            size?: number;
        }>;
        schema: "network.xyo.module.config";
        security?: {
            allowAnonymous?: boolean;
            allowed?: Record<string, (string | CosigningAddressSet)[]>;
            disallowed?: Record<string, string[]>;
        };
        storeQueries?: boolean;
    } & Omit<undefined, "schema">, "schema"> & {
        schema: string;
    }, "schema">, undefined>, ModuleEventData>>

  Parameters

  • wrapper: ConstructableModuleWrapper<T>

    The ModuleWrapper class (ArchivistWrapper, DivinerWrapper, etc.)

  • Optional filter: ModuleFilter

    The ModuleFilter

  Returns Promise<T[]>

  An array of ModuleWrapper instances corresponding to the underlying modules matching the supplied filter

• resolveWrapped<T>(wrapper, nameOrAddress): Promise<undefined | T>

• Type Parameters

  • T extends ModuleWrapper<Module<ModuleParams<SchemaFields & PayloadFields & {
        archivist?: ArchivistModuleConfig;
        name?: string;
        paging?: Record<string, {
            size?: number;
        }>;
        schema: string;
        security?: {
            allowAnonymous?: boolean;
            allowed?: Record<string, (string | CosigningAddressSet)[]>;
            disallowed?: Record<string, string[]>;
        };
        storeQueries?: boolean;
    } & Omit<Omit<SchemaFields & PayloadFields & {
        archivist?: ArchivistModuleConfig;
        name?: string;
        paging?: Record<string, {
            size?: number;
        }>;
        schema: "network.xyo.module.config";
        security?: {
            allowAnonymous?: boolean;
            allowed?: Record<string, (string | CosigningAddressSet)[]>;
            disallowed?: Record<string, string[]>;
        };
        storeQueries?: boolean;
    } & Omit<undefined, "schema">, "schema"> & {
        schema: string;
    }, "schema">, undefined>, ModuleEventData>, T> = ModuleWrapper<Module<ModuleParams<SchemaFields & PayloadFields & {
        archivist?: ArchivistModuleConfig;
        name?: string;
        paging?: Record<string, {
            size?: number;
        }>;
        schema: string;
        security?: {
            allowAnonymous?: boolean;
            allowed?: Record<string, (string | CosigningAddressSet)[]>;
            disallowed?: Record<string, string[]>;
        };
        storeQueries?: boolean;
    } & Omit<Omit<SchemaFields & PayloadFields & {
        archivist?: ArchivistModuleConfig;
        name?: string;
        paging?: Record<string, {
            size?: number;
        }>;
        schema: "network.xyo.module.config";
        security?: {
            allowAnonymous?: boolean;
            allowed?: Record<string, (string | CosigningAddressSet)[]>;
            disallowed?: Record<string, string[]>;
        };
        storeQueries?: boolean;
    } & Omit<undefined, "schema">, "schema"> & {
        schema: string;
    }, "schema">, undefined>, ModuleEventData>>

  Parameters

  • wrapper: ConstructableModuleWrapper<T>

  • nameOrAddress: string

  Returns Promise<undefined | T>

Static canWrap

• canWrap(module?): boolean

• Parameters

  • Optional module: Module<ModuleParams<SchemaFields & PayloadFields & {
        archivist?: ArchivistModuleConfig;
        name?: string;
        paging?: Record<string, {
            size?: number;
        }>;
        schema: string;
        security?: {
            allowAnonymous?: boolean;
            allowed?: Record<string, (string | CosigningAddressSet)[]>;
            disallowed?: Record<string, string[]>;
        };
        storeQueries?: boolean;
    } & Omit<Omit<SchemaFields & PayloadFields & {
        archivist?: ArchivistModuleConfig;
        name?: string;
        paging?: Record<string, {
            size?: number;
        }>;
        schema: "network.xyo.module.config";
        security?: {
            allowAnonymous?: boolean;
            allowed?: Record<string, (string | CosigningAddressSet)[]>;
            disallowed?: Record<string, string[]>;
        };
        storeQueries?: boolean;
    } & Omit<undefined, "schema">, "schema"> & {
        schema: string;
    }, "schema">, undefined>, ModuleEventData>

  Returns boolean

Static hasRequiredQueries

• hasRequiredQueries(module): boolean

• Parameters

  • module: Module<ModuleParams<SchemaFields & PayloadFields & {
        archivist?: ArchivistModuleConfig;
        name?: string;
        paging?: Record<string, {
            size?: number;
        }>;
        schema: string;
        security?: {
            allowAnonymous?: boolean;
            allowed?: Record<string, (string | CosigningAddressSet)[]>;
            disallowed?: Record<string, string[]>;
        };
        storeQueries?: boolean;
    } & Omit<Omit<SchemaFields & PayloadFields & {
        archivist?: ArchivistModuleConfig;
        name?: string;
        paging?: Record<string, {
            size?: number;
        }>;
        schema: "network.xyo.module.config";
        security?: {
            allowAnonymous?: boolean;
            allowed?: Record<string, (string | CosigningAddressSet)[]>;
            disallowed?: Record<string, string[]>;
        };
        storeQueries?: boolean;
    } & Omit<undefined, "schema">, "schema"> & {
        schema: string;
    }, "schema">, undefined>, ModuleEventData>

  Returns boolean

Static missingRequiredQueries

• missingRequiredQueries(module): string[]

• Parameters

  • module: Module<ModuleParams<SchemaFields & PayloadFields & {
        archivist?: ArchivistModuleConfig;
        name?: string;
        paging?: Record<string, {
            size?: number;
        }>;
        schema: string;
        security?: {
            allowAnonymous?: boolean;
            allowed?: Record<string, (string | CosigningAddressSet)[]>;
            disallowed?: Record<string, string[]>;
        };
        storeQueries?: boolean;
    } & Omit<Omit<SchemaFields & PayloadFields & {
        archivist?: ArchivistModuleConfig;
        name?: string;
        paging?: Record<string, {
            size?: number;
        }>;
        schema: "network.xyo.module.config";
        security?: {
            allowAnonymous?: boolean;
            allowed?: Record<string, (string | CosigningAddressSet)[]>;
            disallowed?: Record<string, string[]>;
        };
        storeQueries?: boolean;
    } & Omit<undefined, "schema">, "schema"> & {
        schema: string;
    }, "schema">, undefined>, ModuleEventData>

  Returns string[]

Static tryWrap

• tryWrap<TModuleWrapper>(this, module?, account?): undefined | TModuleWrapper

• Type Parameters

  • TModuleWrapper extends ModuleWrapper<Module<ModuleParams<SchemaFields & PayloadFields & {
        archivist?: ArchivistModuleConfig;
        name?: string;
        paging?: Record<string, {
            size?: number;
        }>;
        schema: string;
        security?: {
            allowAnonymous?: boolean;
            allowed?: Record<string, (string | CosigningAddressSet)[]>;
            disallowed?: Record<string, string[]>;
        };
        storeQueries?: boolean;
    } & Omit<Omit<SchemaFields & PayloadFields & {
        archivist?: ArchivistModuleConfig;
        name?: string;
        paging?: Record<string, {
            size?: number;
        }>;
        schema: "network.xyo.module.config";
        security?: {
            allowAnonymous?: boolean;
            allowed?: Record<string, (string | CosigningAddressSet)[]>;
            disallowed?: Record<string, string[]>;
        };
        storeQueries?: boolean;
    } & Omit<undefined, "schema">, "schema"> & {
        schema: string;
    }, "schema">, undefined>, ModuleEventData>, TModuleWrapper>

  Parameters

  • this: ConstructableModuleWrapper<TModuleWrapper>

  • Optional module: Module<ModuleParams<SchemaFields & PayloadFields & {
        archivist?: ArchivistModuleConfig;
        name?: string;
        paging?: Record<string, {
            size?: number;
        }>;
        schema: string;
        security?: {
            allowAnonymous?: boolean;
            allowed?: Record<string, (string | CosigningAddressSet)[]>;
            disallowed?: Record<string, string[]>;
        };
        storeQueries?: boolean;
    } & Omit<Omit<SchemaFields & PayloadFields & {
        archivist?: ArchivistModuleConfig;
        name?: string;
        paging?: Record<string, {
            size?: number;
        }>;
        schema: "network.xyo.module.config";
        security?: {
            allowAnonymous?: boolean;
            allowed?: Record<string, (string | CosigningAddressSet)[]>;
            disallowed?: Record<string, string[]>;
        };
        storeQueries?: boolean;
    } & Omit<undefined, "schema">, "schema"> & {
        schema: string;
    }, "schema">, undefined>, ModuleEventData>

  • Optional account: AccountInstance

  Returns undefined | TModuleWrapper

Static wrap

• wrap<TModuleWrapper>(this, module?, account?): TModuleWrapper

• Type Parameters

  • TModuleWrapper extends ModuleWrapper<Module<ModuleParams<SchemaFields & PayloadFields & {
        archivist?: ArchivistModuleConfig;
        name?: string;
        paging?: Record<string, {
            size?: number;
        }>;
        schema: string;
        security?: {
            allowAnonymous?: boolean;
            allowed?: Record<string, (string | CosigningAddressSet)[]>;
            disallowed?: Record<string, string[]>;
        };
        storeQueries?: boolean;
    } & Omit<Omit<SchemaFields & PayloadFields & {
        archivist?: ArchivistModuleConfig;
        name?: string;
        paging?: Record<string, {
            size?: number;
        }>;
        schema: "network.xyo.module.config";
        security?: {
            allowAnonymous?: boolean;
            allowed?: Record<string, (string | CosigningAddressSet)[]>;
            disallowed?: Record<string, string[]>;
        };
        storeQueries?: boolean;
    } & Omit<undefined, "schema">, "schema"> & {
        schema: string;
    }, "schema">, undefined>, ModuleEventData>, TModuleWrapper>

  Parameters

  • this: ConstructableModuleWrapper<TModuleWrapper>

  • Optional module: Module<ModuleParams<SchemaFields & PayloadFields & {
        archivist?: ArchivistModuleConfig;
        name?: string;
        paging?: Record<string, {
            size?: number;
        }>;
        schema: string;
        security?: {
            allowAnonymous?: boolean;
            allowed?: Record<string, (string | CosigningAddressSet)[]>;
            disallowed?: Record<string, string[]>;
        };
        storeQueries?: boolean;
    } & Omit<Omit<SchemaFields & PayloadFields & {
        archivist?: ArchivistModuleConfig;
        name?: string;
        paging?: Record<string, {
            size?: number;
        }>;
        schema: "network.xyo.module.config";
        security?: {
            allowAnonymous?: boolean;
            allowed?: Record<string, (string | CosigningAddressSet)[]>;
            disallowed?: Record<string, string[]>;
        };
        storeQueries?: boolean;
    } & Omit<undefined, "schema">, "schema"> & {
        schema: string;
    }, "schema">, undefined>, ModuleEventData>

  • Optional account: AccountInstance

  Returns TModuleWrapper