Class PayloadSetPluginResolver

Constructors

constructor

Properties

_params _plugins

Methods

diviner diviners params plugins register resolve sets witness witnesses

Constructors

constructor

Properties

Protected_params

_params: Record<
    string,
    | undefined
    | BaseParamsFields & {
        account?: AccountInstance
        | "random";
        additionalSigners?: AccountInstance[];
        addToResolvers?: boolean;
        allowNameResolution?: boolean;
        config: DeepRestrictToStringKeys<
            {
                allowedQueries?: string[];
                archiving?: { archivists?: string[]; queries?: string[] };
                archivist?: string;
                consoleLogger?: LogLevel;
                labels?: { [key: string]: undefined | string };
                name?: string;
                paging?: { [key: string]: { size?: number } };
                retry?: { backoff?: number; interval?: number; retries?: number };
                schema: string;
                security?: {
                    allowAnonymous?: boolean;
                    allowed?: { [key: string]: (...)[] };
                    disallowed?: { [key: string]: (...)[] };
                };
                sign?: boolean;
                storeQueries?: boolean;
                timestamp?: boolean;
            },
        >;
        ephemeralQueryAccountEnabled?: boolean;
        moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
    }
    | BaseParamsFields & {
        account?: AccountInstance
        | "random";
        additionalSigners?: AccountInstance[];
        addToResolvers?: boolean;
        allowNameResolution?: boolean;
        config: DeepRestrictToStringKeys<
            {
                allowedQueries?: string[];
                archiving?: { archivists?: string[]; queries?: string[] };
                archivist?: string;
                consoleLogger?: LogLevel;
                labels?: { [key: string]: undefined | string };
                name?: string;
                paging?: { [key: string]: { size?: number } };
                retry?: { backoff?: number; interval?: number; retries?: number };
                schema: string;
                security?: {
                    allowAnonymous?: boolean;
                    allowed?: { [key: string]: (...)[] };
                    disallowed?: { [key: string]: (...)[] };
                };
                sign?: boolean;
                storeQueries?: boolean;
                timestamp?: boolean;
            },
        >;
        ephemeralQueryAccountEnabled?: boolean;
        moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
    },
>

Protected_plugins

_plugins: Record<
    string,
    | PayloadSetWitnessPlugin<WitnessModule>
    | PayloadSetDivinerPlugin<DivinerModule>,
>

Methods

diviner

  • diviner(
        set: DeepRestrictToStringKeys<
            {
                optional?: { [key: string]: number };
                required?: { [key: string]: number };
                schema: "network.xyo.payload.set";
            },
        >,
    ): Promise<undefined | DivinerModule>

  • Parameters

    • set: DeepRestrictToStringKeys<
          {
              optional?: { [key: string]: number };
              required?: { [key: string]: number };
              schema: "network.xyo.payload.set";
          },
      >

    Returns Promise<undefined | DivinerModule>

  • diviner(set: string): Promise<undefined | DivinerModule>

  • Parameters

    • set: string

    Returns Promise<undefined | DivinerModule>

diviners

params

  • params(): (
        | undefined
        | BaseParamsFields & {
            account?: AccountInstance
            | "random";
            additionalSigners?: AccountInstance[];
            addToResolvers?: boolean;
            allowNameResolution?: boolean;
            config: DeepRestrictToStringKeys<
                {
                    allowedQueries?: string[];
                    archiving?: { archivists?: string[]; queries?: string[] };
                    archivist?: string;
                    consoleLogger?: LogLevel;
                    labels?: { [key: string]: undefined | string };
                    name?: string;
                    paging?: { [key: string]: { size?: number } };
                    retry?: { backoff?: number; interval?: number; retries?: number };
                    schema: string;
                    security?: {
                        allowAnonymous?: boolean;
                        allowed?: { [key: string]: (...)[] };
                        disallowed?: { [key: string]: (...)[] };
                    };
                    sign?: boolean;
                    storeQueries?: boolean;
                    timestamp?: boolean;
                },
            >;
            ephemeralQueryAccountEnabled?: boolean;
            moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
        }
        | BaseParamsFields & {
            account?: AccountInstance
            | "random";
            additionalSigners?: AccountInstance[];
            addToResolvers?: boolean;
            allowNameResolution?: boolean;
            config: DeepRestrictToStringKeys<
                {
                    allowedQueries?: string[];
                    archiving?: { archivists?: string[]; queries?: string[] };
                    archivist?: string;
                    consoleLogger?: LogLevel;
                    labels?: { [key: string]: undefined | string };
                    name?: string;
                    paging?: { [key: string]: { size?: number } };
                    retry?: { backoff?: number; interval?: number; retries?: number };
                    schema: string;
                    security?: {
                        allowAnonymous?: boolean;
                        allowed?: { [key: string]: (...)[] };
                        disallowed?: { [key: string]: (...)[] };
                    };
                    sign?: boolean;
                    storeQueries?: boolean;
                    timestamp?: boolean;
                },
            >;
            ephemeralQueryAccountEnabled?: boolean;
            moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
        }
    )[]

  • Returns (
        | undefined
        | BaseParamsFields & {
            account?: AccountInstance
            | "random";
            additionalSigners?: AccountInstance[];
            addToResolvers?: boolean;
            allowNameResolution?: boolean;
            config: DeepRestrictToStringKeys<
                {
                    allowedQueries?: string[];
                    archiving?: { archivists?: string[]; queries?: string[] };
                    archivist?: string;
                    consoleLogger?: LogLevel;
                    labels?: { [key: string]: undefined | string };
                    name?: string;
                    paging?: { [key: string]: { size?: number } };
                    retry?: { backoff?: number; interval?: number; retries?: number };
                    schema: string;
                    security?: {
                        allowAnonymous?: boolean;
                        allowed?: { [key: string]: (...)[] };
                        disallowed?: { [key: string]: (...)[] };
                    };
                    sign?: boolean;
                    storeQueries?: boolean;
                    timestamp?: boolean;
                },
            >;
            ephemeralQueryAccountEnabled?: boolean;
            moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
        }
        | BaseParamsFields & {
            account?: AccountInstance
            | "random";
            additionalSigners?: AccountInstance[];
            addToResolvers?: boolean;
            allowNameResolution?: boolean;
            config: DeepRestrictToStringKeys<
                {
                    allowedQueries?: string[];
                    archiving?: { archivists?: string[]; queries?: string[] };
                    archivist?: string;
                    consoleLogger?: LogLevel;
                    labels?: { [key: string]: undefined | string };
                    name?: string;
                    paging?: { [key: string]: { size?: number } };
                    retry?: { backoff?: number; interval?: number; retries?: number };
                    schema: string;
                    security?: {
                        allowAnonymous?: boolean;
                        allowed?: { [key: string]: (...)[] };
                        disallowed?: { [key: string]: (...)[] };
                    };
                    sign?: boolean;
                    storeQueries?: boolean;
                    timestamp?: boolean;
                },
            >;
            ephemeralQueryAccountEnabled?: boolean;
            moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
        }
    )[]

plugins

register

resolve

sets

  • sets(): DeepRestrictToStringKeys<
        {
            optional?: { [key: string]: number };
            required?: { [key: string]: number };
            schema: "network.xyo.payload.set";
        },
    >[]

  • Returns DeepRestrictToStringKeys<
        {
            optional?: { [key: string]: number };
            required?: { [key: string]: number };
            schema: "network.xyo.payload.set";
        },
    >[]

witness

  • witness(
        set: DeepRestrictToStringKeys<
            {
                optional?: { [key: string]: number };
                required?: { [key: string]: number };
                schema: "network.xyo.payload.set";
            },
        >,
    ): Promise<undefined | WitnessModule>

  • Parameters

    • set: DeepRestrictToStringKeys<
          {
              optional?: { [key: string]: number };
              required?: { [key: string]: number };
              schema: "network.xyo.payload.set";
          },
      >

    Returns Promise<undefined | WitnessModule>

  • witness(set: string): Promise<undefined | WitnessModule>

  • Parameters

    • set: string

    Returns Promise<undefined | WitnessModule>

witnesses

Settings

Member Visibility

On This Page

Constructors
Properties
Methods