Class ManifestWrapperEx<TManifest, TParams>

Provides functionality that can be performed on a PackageManifest

Type Parameters

TManifest extends WithAnySchema<PackageManifestPayload> | void
TParams extends ManifestWrapperExParams = ManifestWrapperExParams

Hierarchy (View Summary)

PayloadWrapper<
    TManifest extends WithAnySchema<PackageManifestPayload>
        ? TManifest
        : WithAnySchema<PackageManifestPayload>,
>
- ManifestWrapperEx

Index

Constructors

constructor

new ManifestWrapperEx<
    TManifest extends
        | void
        | {
            description?: string;
            modules?: {
                [key: string]: {
                    config: {
                        accountPath?: string;
                        features?: string[];
                        labels?: { [key: string]: undefined
                        | string };
                        language?: string;
                        name: string;
                        os?: string;
                        schema: string;
                    };
                    description?: string;
                    lazyStart?: boolean;
                    status?: {
                        address: Lowercase<string>;
                        children?: { [key: Lowercase<string>]: null | string };
                    };
                };
            };
            nodes: {
                config: {
                    accountPath?: string;
                    features?: string[];
                    labels?: { [key: string]: undefined
                    | string };
                    language?: string;
                    name: string;
                    os?: string;
                    schema: string;
                };
                description?: string;
                lazyStart?: boolean;
                modules?: {
                    private?: (
                        | string
                        | {
                            config: {
                                accountPath?: ...;
                                features?: ...;
                                labels?: ...;
                                language?: ...;
                                name: ...;
                                os?: ...;
                                schema: ...;
                            };
                            description?: (...)
                            | (...);
                            lazyStart?: (...) | (...) | (...);
                            status?: (...) | (...);
                        }
                    )[];
                    public?: (
                        | string
                        | {
                            config: {
                                accountPath?: ...;
                                features?: ...;
                                labels?: ...;
                                language?: ...;
                                name: ...;
                                os?: ...;
                                schema: ...;
                            };
                            description?: (...)
                            | (...);
                            lazyStart?: (...) | (...) | (...);
                            status?: (...) | (...);
                        }
                    )[];
                };
                status?: {
                    address: Lowercase<string>;
                    children?: { [key: Lowercase<string>]: null | string };
                };
            }[];
            schema: string;
        },
    TParams extends ManifestWrapperExParams = ManifestWrapperExParams,
>(
    payload: TManifest extends {
        description?: string;
        modules?: {
            [key: string]: {
                config: {
                    accountPath?: string;
                    features?: string[];
                    labels?: { [key: string]: undefined
                    | string };
                    language?: string;
                    name: string;
                    os?: string;
                    schema: string;
                };
                description?: string;
                lazyStart?: boolean;
                status?: {
                    address: Lowercase<string>;
                    children?: { [key: Lowercase<string>]: null | string };
                };
            };
        };
        nodes: {
            config: {
                accountPath?: string;
                features?: string[];
                labels?: { [key: string]: undefined
                | string };
                language?: string;
                name: string;
                os?: string;
                schema: string;
            };
            description?: string;
            lazyStart?: boolean;
            modules?: {
                private?: (
                    | string
                    | {
                        config: {
                            accountPath?: ...;
                            features?: ...;
                            labels?: ...;
                            language?: ...;
                            name: ...;
                            os?: ...;
                            schema: ...;
                        };
                        description?: (...)
                        | (...);
                        lazyStart?: (...) | (...) | (...);
                        status?: (...) | (...);
                    }
                )[];
                public?: (
                    | string
                    | {
                        config: {
                            accountPath?: ...;
                            features?: ...;
                            labels?: ...;
                            language?: ...;
                            name: ...;
                            os?: ...;
                            schema: ...;
                        };
                        description?: (...)
                        | (...);
                        lazyStart?: (...) | (...) | (...);
                        status?: (...) | (...);
                    }
                )[];
            };
            status?: {
                address: Lowercase<string>;
                children?: { [key: Lowercase<string>]: null | string };
            };
        }[];
        schema: string;
    }
        ? TManifest<TManifest>
        : {
            description?: string;
            modules?: {
                [key: string]: {
                    config: {
                        accountPath?: string;
                        features?: string[];
                        labels?: { [key: string]: undefined | string };
                        language?: string;
                        name: string;
                        os?: string;
                        schema: string;
                    };
                    description?: string;
                    lazyStart?: boolean;
                    status?: {
                        address: Lowercase<string>;
                        children?: { [key: Lowercase<string>]: null | string };
                    };
                };
            };
            nodes: {
                config: {
                    accountPath?: string;
                    features?: string[];
                    labels?: { [key: string]: undefined
                    | string };
                    language?: string;
                    name: string;
                    os?: string;
                    schema: string;
                };
                description?: string;
                lazyStart?: boolean;
                modules?: {
                    private?: (
                        | string
                        | {
                            config: {
                                accountPath?: ...;
                                features?: ...;
                                labels?: ...;
                                language?: ...;
                                name: ...;
                                os?: ...;
                                schema: ...;
                            };
                            description?: (...)
                            | (...);
                            lazyStart?: (...) | (...) | (...);
                            status?: (...) | (...);
                        }
                    )[];
                    public?: (
                        | string
                        | {
                            config: {
                                accountPath?: ...;
                                features?: ...;
                                labels?: ...;
                                language?: ...;
                                name: ...;
                                os?: ...;
                                schema: ...;
                            };
                            description?: (...)
                            | (...);
                            lazyStart?: (...) | (...) | (...);
                            status?: (...) | (...);
                        }
                    )[];
                };
                status?: {
                    address: Lowercase<string>;
                    children?: { [key: Lowercase<string>]: null | string };
                };
            }[];
            schema: string;
        },
    params: TParams,
): ManifestWrapperEx<TManifest, TParams>
Type Parameters
- TManifest extends
      | void
      | {
          description?: string;
          modules?: {
              [key: string]: {
                  config: {
                      accountPath?: string;
                      features?: string[];
                      labels?: { [key: string]: undefined
                      | string };
                      language?: string;
                      name: string;
                      os?: string;
                      schema: string;
                  };
                  description?: string;
                  lazyStart?: boolean;
                  status?: {
                      address: Lowercase<string>;
                      children?: { [key: Lowercase<string>]: null | string };
                  };
              };
          };
          nodes: {
              config: {
                  accountPath?: string;
                  features?: string[];
                  labels?: { [key: string]: undefined
                  | string };
                  language?: string;
                  name: string;
                  os?: string;
                  schema: string;
              };
              description?: string;
              lazyStart?: boolean;
              modules?: {
                  private?: (
                      | string
                      | {
                          config: {
                              accountPath?: ...;
                              features?: ...;
                              labels?: ...;
                              language?: ...;
                              name: ...;
                              os?: ...;
                              schema: ...;
                          };
                          description?: (...)
                          | (...);
                          lazyStart?: (...) | (...) | (...);
                          status?: (...) | (...);
                      }
                  )[];
                  public?: (
                      | string
                      | {
                          config: {
                              accountPath?: ...;
                              features?: ...;
                              labels?: ...;
                              language?: ...;
                              name: ...;
                              os?: ...;
                              schema: ...;
                          };
                          description?: (...)
                          | (...);
                          lazyStart?: (...) | (...) | (...);
                          status?: (...) | (...);
                      }
                  )[];
              };
              status?: {
                  address: Lowercase<string>;
                  children?: { [key: Lowercase<string>]: null | string };
              };
          }[];
          schema: string;
      }
- TParams extends ManifestWrapperExParams = ManifestWrapperExParams
Parameters
- payload: TManifest extends {
      description?: string;
      modules?: {
          [key: string]: {
              config: {
                  accountPath?: string;
                  features?: string[];
                  labels?: { [key: string]: undefined
                  | string };
                  language?: string;
                  name: string;
                  os?: string;
                  schema: string;
              };
              description?: string;
              lazyStart?: boolean;
              status?: {
                  address: Lowercase<string>;
                  children?: { [key: Lowercase<string>]: null | string };
              };
          };
      };
      nodes: {
          config: {
              accountPath?: string;
              features?: string[];
              labels?: { [key: string]: undefined
              | string };
              language?: string;
              name: string;
              os?: string;
              schema: string;
          };
          description?: string;
          lazyStart?: boolean;
          modules?: {
              private?: (
                  | string
                  | {
                      config: {
                          accountPath?: ...;
                          features?: ...;
                          labels?: ...;
                          language?: ...;
                          name: ...;
                          os?: ...;
                          schema: ...;
                      };
                      description?: (...)
                      | (...);
                      lazyStart?: (...) | (...) | (...);
                      status?: (...) | (...);
                  }
              )[];
              public?: (
                  | string
                  | {
                      config: {
                          accountPath?: ...;
                          features?: ...;
                          labels?: ...;
                          language?: ...;
                          name: ...;
                          os?: ...;
                          schema: ...;
                      };
                      description?: (...)
                      | (...);
                      lazyStart?: (...) | (...) | (...);
                      status?: (...) | (...);
                  }
              )[];
          };
          status?: {
              address: Lowercase<string>;
              children?: { [key: Lowercase<string>]: null | string };
          };
      }[];
      schema: string;
  }
      ? TManifest<TManifest>
      : {
          description?: string;
          modules?: {
              [key: string]: {
                  config: {
                      accountPath?: string;
                      features?: string[];
                      labels?: { [key: string]: undefined | string };
                      language?: string;
                      name: string;
                      os?: string;
                      schema: string;
                  };
                  description?: string;
                  lazyStart?: boolean;
                  status?: {
                      address: Lowercase<string>;
                      children?: { [key: Lowercase<string>]: null | string };
                  };
              };
          };
          nodes: {
              config: {
                  accountPath?: string;
                  features?: string[];
                  labels?: { [key: string]: undefined
                  | string };
                  language?: string;
                  name: string;
                  os?: string;
                  schema: string;
              };
              description?: string;
              lazyStart?: boolean;
              modules?: {
                  private?: (
                      | string
                      | {
                          config: {
                              accountPath?: ...;
                              features?: ...;
                              labels?: ...;
                              language?: ...;
                              name: ...;
                              os?: ...;
                              schema: ...;
                          };
                          description?: (...)
                          | (...);
                          lazyStart?: (...) | (...) | (...);
                          status?: (...) | (...);
                      }
                  )[];
                  public?: (
                      | string
                      | {
                          config: {
                              accountPath?: ...;
                              features?: ...;
                              labels?: ...;
                              language?: ...;
                              name: ...;
                              os?: ...;
                              schema: ...;
                          };
                          description?: (...)
                          | (...);
                          lazyStart?: (...) | (...) | (...);
                          status?: (...) | (...);
                      }
                  )[];
              };
              status?: {
                  address: Lowercase<string>;
                  children?: { [key: Lowercase<string>]: null | string };
              };
          }[];
          schema: string;
      }
- params: TParams
Returns ManifestWrapperEx<TManifest, TParams>
Overrides PayloadWrapper.constructor
- Defined in packages/manifest/packages/wrapper/src/WrapperEx.ts:30

Properties

`Protected`params

params: TParams

payload

payload: TManifest extends {
    description?: string;
    modules?: {
        [key: string]: {
            config: {
                accountPath?: string;
                features?: string[];
                labels?: { [key: string]: undefined
                | string };
                language?: string;
                name: string;
                os?: string;
                schema: string;
            };
            description?: string;
            lazyStart?: boolean;
            status?: {
                address: Lowercase<string>;
                children?: { [key: Lowercase<string>]: null | string };
            };
        };
    };
    nodes: {
        config: {
            accountPath?: string;
            features?: string[];
            labels?: { [key: string]: undefined
            | string };
            language?: string;
            name: string;
            os?: string;
            schema: string;
        };
        description?: string;
        lazyStart?: boolean;
        modules?: {
            private?: (
                | string
                | {
                    config: {
                        accountPath?: ...;
                        features?: ...;
                        labels?: ...;
                        language?: ...;
                        name: ...;
                        os?: ...;
                        schema: ...;
                    };
                    description?: (...)
                    | (...);
                    lazyStart?: (...) | (...) | (...);
                    status?: (...) | (...);
                }
            )[];
            public?: (
                | string
                | {
                    config: {
                        accountPath?: ...;
                        features?: ...;
                        labels?: ...;
                        language?: ...;
                        name: ...;
                        os?: ...;
                        schema: ...;
                    };
                    description?: (...)
                    | (...);
                    lazyStart?: (...) | (...) | (...);
                    status?: (...) | (...);
                }
            )[];
        };
        status?: {
            address: Lowercase<string>;
            children?: { [key: Lowercase<string>]: null | string };
        };
    }[];
    schema: string;
}
    ? TManifest<TManifest>
    : {
        description?: string;
        modules?: {
            [key: string]: {
                config: {
                    accountPath?: string;
                    features?: string[];
                    labels?: { [key: string]: undefined | string };
                    language?: string;
                    name: string;
                    os?: string;
                    schema: string;
                };
                description?: string;
                lazyStart?: boolean;
                status?: {
                    address: Lowercase<string>;
                    children?: { [key: Lowercase<string>]: null | string };
                };
            };
        };
        nodes: {
            config: {
                accountPath?: string;
                features?: string[];
                labels?: { [key: string]: undefined
                | string };
                language?: string;
                name: string;
                os?: string;
                schema: string;
            };
            description?: string;
            lazyStart?: boolean;
            modules?: {
                private?: (
                    | string
                    | {
                        config: {
                            accountPath?: ...;
                            features?: ...;
                            labels?: ...;
                            language?: ...;
                            name: ...;
                            os?: ...;
                            schema: ...;
                        };
                        description?: (...)
                        | (...);
                        lazyStart?: (...) | (...) | (...);
                        status?: (...) | (...);
                    }
                )[];
                public?: (
                    | string
                    | {
                        config: {
                            accountPath?: ...;
                            features?: ...;
                            labels?: ...;
                            language?: ...;
                            name: ...;
                            os?: ...;
                            schema: ...;
                        };
                        description?: (...)
                        | (...);
                        lazyStart?: (...) | (...) | (...);
                        status?: (...) | (...);
                    }
                )[];
            };
            status?: {
                address: Lowercase<string>;
                children?: { [key: Lowercase<string>]: null | string };
            };
        }[];
        schema: string;
    }

`Protected` `Static`loaderFactory

loaderFactory: null | PayloadLoaderFactory

Accessors

Methods

dataHash

dataHash(): Promise<Lowercase<string>>
Returns Promise<Lowercase<string>>
Inherited from PayloadWrapper.dataHash
- Defined in packages/protocol/packages/payload/packages/wrapper/dist/neutral/index.d.ts:18

getErrors

getErrors(): Promise<Error[]>
Returns Promise<Error[]>
Inherited from PayloadWrapper.getErrors
- Defined in packages/protocol/packages/payload/packages/wrapper/dist/neutral/index.d.ts:19

getValid

getValid(): Promise<boolean>
Returns Promise<boolean>
Inherited from PayloadWrapper.getValid
- Defined in packages/protocol/packages/payload/packages/wrapper/dist/neutral/index.d.ts:20

loadModule

loadModule(
    wallet: WalletInstance,
    node: MemoryNode,
    manifest: ModuleManifest,
    external?: boolean,
): Promise<void>
Parameters
- wallet: WalletInstance
- node: MemoryNode
- manifest: ModuleManifest
- external: boolean = true
Returns Promise<void>
- Defined in packages/manifest/packages/wrapper/src/WrapperEx.ts:57

loadNodeFromIndex

loadNodeFromIndex(
    index: number,
): Promise<
    MemoryNode<
        BaseParamsFields & {
            account?: AccountInstance
            | "random";
            additionalSigners?: AccountInstance[];
            addToResolvers?: boolean;
            allowNameResolution?: boolean;
            config: AnyConfigSchema<NodeConfig>;
            ephemeralQueryAccountEnabled?: boolean;
            moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
            privateChildren?: ModuleInstance<
                BaseParamsFields & {
                    account?: AccountInstance
                    | "random";
                    additionalSigners?: (...)[];
                    addToResolvers?: boolean;
                    allowNameResolution?: boolean;
                    config: AnyConfigSchema<ModuleConfig<(...), (...)>>;
                    ephemeralQueryAccountEnabled?: boolean;
                    moduleIdentifierTransformers?: (...)[];
                    privateChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                    publicChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                },
                ModuleEventData<object>,
            >[];
            publicChildren?: ModuleInstance<
                BaseParamsFields & {
                    account?: AccountInstance
                    | "random";
                    additionalSigners?: (...)[];
                    addToResolvers?: boolean;
                    allowNameResolution?: boolean;
                    config: AnyConfigSchema<ModuleConfig<(...), (...)>>;
                    ephemeralQueryAccountEnabled?: boolean;
                    moduleIdentifierTransformers?: (...)[];
                    privateChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                    publicChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                },
                ModuleEventData<object>,
            >[];
        },
        NodeModuleEventData,
    >,
>
Parameters
- index: number
Returns Promise<
    MemoryNode<
        BaseParamsFields & {
            account?: AccountInstance
            | "random";
            additionalSigners?: AccountInstance[];
            addToResolvers?: boolean;
            allowNameResolution?: boolean;
            config: AnyConfigSchema<NodeConfig>;
            ephemeralQueryAccountEnabled?: boolean;
            moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
            privateChildren?: ModuleInstance<
                BaseParamsFields & {
                    account?: AccountInstance
                    | "random";
                    additionalSigners?: (...)[];
                    addToResolvers?: boolean;
                    allowNameResolution?: boolean;
                    config: AnyConfigSchema<ModuleConfig<(...), (...)>>;
                    ephemeralQueryAccountEnabled?: boolean;
                    moduleIdentifierTransformers?: (...)[];
                    privateChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                    publicChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                },
                ModuleEventData<object>,
            >[];
            publicChildren?: ModuleInstance<
                BaseParamsFields & {
                    account?: AccountInstance
                    | "random";
                    additionalSigners?: (...)[];
                    addToResolvers?: boolean;
                    allowNameResolution?: boolean;
                    config: AnyConfigSchema<ModuleConfig<(...), (...)>>;
                    ephemeralQueryAccountEnabled?: boolean;
                    moduleIdentifierTransformers?: (...)[];
                    privateChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                    publicChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                },
                ModuleEventData<object>,
            >[];
        },
        NodeModuleEventData,
    >,
>
- Defined in packages/manifest/packages/wrapper/src/WrapperEx.ts:80

loadNodeFromManifest

loadNodeFromManifest(
    wallet: WalletInstance,
    manifest: NodeManifest,
    path?: string,
): Promise<
    MemoryNode<
        BaseParamsFields & {
            account?: AccountInstance
            | "random";
            additionalSigners?: AccountInstance[];
            addToResolvers?: boolean;
            allowNameResolution?: boolean;
            config: AnyConfigSchema<NodeConfig>;
            ephemeralQueryAccountEnabled?: boolean;
            moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
            privateChildren?: ModuleInstance<
                BaseParamsFields & {
                    account?: AccountInstance
                    | "random";
                    additionalSigners?: (...)[];
                    addToResolvers?: boolean;
                    allowNameResolution?: boolean;
                    config: AnyConfigSchema<ModuleConfig<(...), (...)>>;
                    ephemeralQueryAccountEnabled?: boolean;
                    moduleIdentifierTransformers?: (...)[];
                    privateChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                    publicChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                },
                ModuleEventData<object>,
            >[];
            publicChildren?: ModuleInstance<
                BaseParamsFields & {
                    account?: AccountInstance
                    | "random";
                    additionalSigners?: (...)[];
                    addToResolvers?: boolean;
                    allowNameResolution?: boolean;
                    config: AnyConfigSchema<ModuleConfig<(...), (...)>>;
                    ephemeralQueryAccountEnabled?: boolean;
                    moduleIdentifierTransformers?: (...)[];
                    privateChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                    publicChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                },
                ModuleEventData<object>,
            >[];
        },
        NodeModuleEventData,
    >,
>
Parameters
- wallet: WalletInstance
- manifest: NodeManifest
- Optionalpath: string
Returns Promise<
    MemoryNode<
        BaseParamsFields & {
            account?: AccountInstance
            | "random";
            additionalSigners?: AccountInstance[];
            addToResolvers?: boolean;
            allowNameResolution?: boolean;
            config: AnyConfigSchema<NodeConfig>;
            ephemeralQueryAccountEnabled?: boolean;
            moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
            privateChildren?: ModuleInstance<
                BaseParamsFields & {
                    account?: AccountInstance
                    | "random";
                    additionalSigners?: (...)[];
                    addToResolvers?: boolean;
                    allowNameResolution?: boolean;
                    config: AnyConfigSchema<ModuleConfig<(...), (...)>>;
                    ephemeralQueryAccountEnabled?: boolean;
                    moduleIdentifierTransformers?: (...)[];
                    privateChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                    publicChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                },
                ModuleEventData<object>,
            >[];
            publicChildren?: ModuleInstance<
                BaseParamsFields & {
                    account?: AccountInstance
                    | "random";
                    additionalSigners?: (...)[];
                    addToResolvers?: boolean;
                    allowNameResolution?: boolean;
                    config: AnyConfigSchema<ModuleConfig<(...), (...)>>;
                    ephemeralQueryAccountEnabled?: boolean;
                    moduleIdentifierTransformers?: (...)[];
                    privateChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                    publicChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                },
                ModuleEventData<object>,
            >[];
        },
        NodeModuleEventData,
    >,
>
- Defined in packages/manifest/packages/wrapper/src/WrapperEx.ts:85

loadNodes

loadNodes(
    node?: MemoryNode<
        BaseParamsFields & {
            account?: AccountInstance
            | "random";
            additionalSigners?: AccountInstance[];
            addToResolvers?: boolean;
            allowNameResolution?: boolean;
            config: AnyConfigSchema<NodeConfig>;
            ephemeralQueryAccountEnabled?: boolean;
            moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
            privateChildren?: ModuleInstance<
                BaseParamsFields & {
                    account?: AccountInstance
                    | "random";
                    additionalSigners?: (...)[];
                    addToResolvers?: boolean;
                    allowNameResolution?: boolean;
                    config: AnyConfigSchema<ModuleConfig<(...), (...)>>;
                    ephemeralQueryAccountEnabled?: boolean;
                    moduleIdentifierTransformers?: (...)[];
                    privateChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                    publicChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                },
                ModuleEventData<object>,
            >[];
            publicChildren?: ModuleInstance<
                BaseParamsFields & {
                    account?: AccountInstance
                    | "random";
                    additionalSigners?: (...)[];
                    addToResolvers?: boolean;
                    allowNameResolution?: boolean;
                    config: AnyConfigSchema<ModuleConfig<(...), (...)>>;
                    ephemeralQueryAccountEnabled?: boolean;
                    moduleIdentifierTransformers?: (...)[];
                    privateChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                    publicChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                },
                ModuleEventData<object>,
            >[];
        },
        NodeModuleEventData,
    >,
): Promise<
    MemoryNode<
        BaseParamsFields & {
            account?: AccountInstance
            | "random";
            additionalSigners?: AccountInstance[];
            addToResolvers?: boolean;
            allowNameResolution?: boolean;
            config: AnyConfigSchema<NodeConfig>;
            ephemeralQueryAccountEnabled?: boolean;
            moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
            privateChildren?: ModuleInstance<
                BaseParamsFields & {
                    account?: (...)
                    | (...)
                    | (...);
                    additionalSigners?: (...) | (...);
                    addToResolvers?: (...) | (...) | (...);
                    allowNameResolution?: (...) | (...) | (...);
                    config: AnyConfigSchema<(...)>;
                    ephemeralQueryAccountEnabled?: (...) | (...) | (...);
                    moduleIdentifierTransformers?: (...) | (...);
                    privateChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                    publicChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                },
                ModuleEventData<object>,
            >[];
            publicChildren?: ModuleInstance<
                BaseParamsFields & {
                    account?: (...)
                    | (...)
                    | (...);
                    additionalSigners?: (...) | (...);
                    addToResolvers?: (...) | (...) | (...);
                    allowNameResolution?: (...) | (...) | (...);
                    config: AnyConfigSchema<(...)>;
                    ephemeralQueryAccountEnabled?: (...) | (...) | (...);
                    moduleIdentifierTransformers?: (...) | (...);
                    privateChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                    publicChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                },
                ModuleEventData<object>,
            >[];
        },
        NodeModuleEventData,
    >[],
>
Load the nodes that are defined in the wrapped manifest and optionally attach them to a node
Parameters
- Optionalnode: MemoryNode<
      BaseParamsFields & {
          account?: AccountInstance
          | "random";
          additionalSigners?: AccountInstance[];
          addToResolvers?: boolean;
          allowNameResolution?: boolean;
          config: AnyConfigSchema<NodeConfig>;
          ephemeralQueryAccountEnabled?: boolean;
          moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
          privateChildren?: ModuleInstance<
              BaseParamsFields & {
                  account?: AccountInstance
                  | "random";
                  additionalSigners?: (...)[];
                  addToResolvers?: boolean;
                  allowNameResolution?: boolean;
                  config: AnyConfigSchema<ModuleConfig<(...), (...)>>;
                  ephemeralQueryAccountEnabled?: boolean;
                  moduleIdentifierTransformers?: (...)[];
                  privateChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                  publicChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
              },
              ModuleEventData<object>,
          >[];
          publicChildren?: ModuleInstance<
              BaseParamsFields & {
                  account?: AccountInstance
                  | "random";
                  additionalSigners?: (...)[];
                  addToResolvers?: boolean;
                  allowNameResolution?: boolean;
                  config: AnyConfigSchema<ModuleConfig<(...), (...)>>;
                  ephemeralQueryAccountEnabled?: boolean;
                  moduleIdentifierTransformers?: (...)[];
                  privateChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                  publicChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
              },
              ModuleEventData<object>,
          >[];
      },
      NodeModuleEventData,
  >
Returns Promise<
    MemoryNode<
        BaseParamsFields & {
            account?: AccountInstance
            | "random";
            additionalSigners?: AccountInstance[];
            addToResolvers?: boolean;
            allowNameResolution?: boolean;
            config: AnyConfigSchema<NodeConfig>;
            ephemeralQueryAccountEnabled?: boolean;
            moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
            privateChildren?: ModuleInstance<
                BaseParamsFields & {
                    account?: (...)
                    | (...)
                    | (...);
                    additionalSigners?: (...) | (...);
                    addToResolvers?: (...) | (...) | (...);
                    allowNameResolution?: (...) | (...) | (...);
                    config: AnyConfigSchema<(...)>;
                    ephemeralQueryAccountEnabled?: (...) | (...) | (...);
                    moduleIdentifierTransformers?: (...) | (...);
                    privateChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                    publicChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                },
                ModuleEventData<object>,
            >[];
            publicChildren?: ModuleInstance<
                BaseParamsFields & {
                    account?: (...)
                    | (...)
                    | (...);
                    additionalSigners?: (...) | (...);
                    addToResolvers?: (...) | (...) | (...);
                    allowNameResolution?: (...) | (...) | (...);
                    config: AnyConfigSchema<(...)>;
                    ephemeralQueryAccountEnabled?: (...) | (...) | (...);
                    moduleIdentifierTransformers?: (...) | (...);
                    privateChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                    publicChildren?: ModuleInstance<BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }, ModuleEventData<...>>[] | undefined;
                },
                ModuleEventData<object>,
            >[];
        },
        NodeModuleEventData,
    >[],
>
- Defined in packages/manifest/packages/wrapper/src/WrapperEx.ts:126

nodeManifest

nodeManifest(
    index: number,
): {
    config: {
        accountPath?: string;
        features?: string[];
        labels?: { [key: string]: undefined | string };
        language?: string;
        name: string;
        os?: string;
        schema: string;
    };
    description?: string;
    lazyStart?: boolean;
    modules?: {
        private?: (
            | string
            | {
                config: {
                    accountPath?: string;
                    features?: string[];
                    labels?: { [key: string]: (...)
                    | (...) };
                    language?: string;
                    name: string;
                    os?: string;
                    schema: string;
                };
                description?: string;
                lazyStart?: boolean;
                status?: { address: Lowercase<string>; children?: { [key: ...]: ... } };
            }
        )[];
        public?: (
            | string
            | {
                config: {
                    accountPath?: string;
                    features?: string[];
                    labels?: { [key: string]: (...)
                    | (...) };
                    language?: string;
                    name: string;
                    os?: string;
                    schema: string;
                };
                description?: string;
                lazyStart?: boolean;
                status?: { address: Lowercase<string>; children?: { [key: ...]: ... } };
            }
        )[];
    };
    status?: {
        address: Lowercase<string>;
        children?: { [key: Lowercase<string>]: null | string };
    };
}
Parameters
- index: number
Returns {
    config: {
        accountPath?: string;
        features?: string[];
        labels?: { [key: string]: undefined | string };
        language?: string;
        name: string;
        os?: string;
        schema: string;
    };
    description?: string;
    lazyStart?: boolean;
    modules?: {
        private?: (
            | string
            | {
                config: {
                    accountPath?: string;
                    features?: string[];
                    labels?: { [key: string]: (...)
                    | (...) };
                    language?: string;
                    name: string;
                    os?: string;
                    schema: string;
                };
                description?: string;
                lazyStart?: boolean;
                status?: { address: Lowercase<string>; children?: { [key: ...]: ... } };
            }
        )[];
        public?: (
            | string
            | {
                config: {
                    accountPath?: string;
                    features?: string[];
                    labels?: { [key: string]: (...)
                    | (...) };
                    language?: string;
                    name: string;
                    os?: string;
                    schema: string;
                };
                description?: string;
                lazyStart?: boolean;
                status?: { address: Lowercase<string>; children?: { [key: ...]: ... } };
            }
        )[];
    };
    status?: {
        address: Lowercase<string>;
        children?: { [key: Lowercase<string>]: null | string };
    };
}
- Defined in packages/manifest/packages/wrapper/src/WrapperEx.ts:136

schema

schema(): string
Returns string
Inherited from PayloadWrapper.schema
- Defined in packages/protocol/packages/payload/packages/wrapper/dist/neutral/index.d.ts:21

validate

validate(): Promise<Error[]>
Returns Promise<Error[]>
Inherited from PayloadWrapper.validate
- Defined in packages/protocol/packages/payload/packages/wrapper/dist/neutral/index.d.ts:35

`Static`as

as<T extends Payload = Payload>(value: unknown): null | PayloadDataWrapper<T>
Type Parameters
- T extends Payload = Payload
Parameters
- value: unknown
Returns null | PayloadDataWrapper<T>
Inherited from PayloadWrapper.as
- Defined in packages/protocol/packages/payload/packages/wrapper/dist/neutral/index.d.ts:28

`Static`load

load(address: Lowercase<string>): Promise<null | PayloadDataWrapper<Payload>>
Parameters
- address: Lowercase<string>
Returns Promise<null | PayloadDataWrapper<Payload>>
Inherited from PayloadWrapper.load
- Defined in packages/protocol/packages/payload/packages/wrapper/dist/neutral/index.d.ts:29

`Static`parse

parse<T extends Payload>(payload?: unknown): undefined | PayloadDataWrapper<T>
Type Parameters
- T extends Payload
Parameters
- Optionalpayload: unknown
Returns undefined | PayloadDataWrapper<T>
Inherited from PayloadWrapper.parse
- Defined in packages/protocol/packages/payload/packages/wrapper/dist/neutral/index.d.ts:30

`Static`setLoaderFactory

setLoaderFactory(factory: null | PayloadLoaderFactory): void
Parameters
- factory: null | PayloadLoaderFactory
Returns void
Inherited from PayloadWrapper.setLoaderFactory
- Defined in packages/protocol/packages/payload/packages/wrapper/dist/neutral/index.d.ts:31

`Static`tryParse

tryParse<T extends Payload>(obj: unknown): undefined | PayloadDataWrapper<T>
Type Parameters
- T extends Payload
Parameters
- obj: unknown
Returns undefined | PayloadDataWrapper<T>
Inherited from PayloadWrapper.tryParse
- Defined in packages/protocol/packages/payload/packages/wrapper/dist/neutral/index.d.ts:32

`Static`unwrap

unwrap<TPayload extends Payload = Payload>(
payload?: TPayload,
): undefined | TPayload
Type Parameters
- TPayload extends Payload = Payload
Parameters
- Optionalpayload: TPayload
Returns undefined | TPayload
Inherited from PayloadWrapper.unwrap
- Defined in packages/protocol/packages/payload/packages/wrapper/dist/neutral/index.d.ts:13
unwrap<
    TPayload extends Payload = Payload,
    TWrapper extends
        PayloadWrapperBase<TPayload> = PayloadWrapperBase<TPayload>,
>(
    payload: TPayload | TWrapper,
): TPayload
Type Parameters
- TPayload extends Payload = Payload
- TWrapper extends PayloadWrapperBase<TPayload> = PayloadWrapperBase<TPayload>
Parameters
- payload: TPayload | TWrapper
Returns TPayload
Inherited from PayloadWrapper.unwrap
- Defined in packages/protocol/packages/payload/packages/wrapper/dist/neutral/index.d.ts:14
unwrap<
    TPayload extends Payload = Payload,
    TWrapper extends
        PayloadWrapperBase<TPayload> = PayloadWrapperBase<TPayload>,
>(
    payload: (TPayload | TWrapper)[],
): TPayload[]
Type Parameters
- TPayload extends Payload = Payload
- TWrapper extends PayloadWrapperBase<TPayload> = PayloadWrapperBase<TPayload>
Parameters
- payload: (TPayload | TWrapper)[]
Returns TPayload[]
Inherited from PayloadWrapper.unwrap
- Defined in packages/protocol/packages/payload/packages/wrapper/dist/neutral/index.d.ts:15

`Static`unwrapSinglePayload

unwrapSinglePayload<TPayload extends Payload = Payload>(
payload?: TPayload,
): undefined | TPayload
Type Parameters
- TPayload extends Payload = Payload
Parameters
- Optionalpayload: TPayload
Returns undefined | TPayload
Inherited from PayloadWrapper.unwrapSinglePayload
- Defined in packages/protocol/packages/payload/packages/wrapper/dist/neutral/index.d.ts:16
unwrapSinglePayload<
    TPayload extends Payload = Payload,
    TWrapper extends
        PayloadWrapperBase<TPayload> = PayloadWrapperBase<TPayload>,
>(
    payload: TPayload | TWrapper,
): TPayload
Type Parameters
- TPayload extends Payload = Payload
- TWrapper extends PayloadWrapperBase<TPayload> = PayloadWrapperBase<TPayload>
Parameters
- payload: TPayload | TWrapper
Returns TPayload
Inherited from PayloadWrapper.unwrapSinglePayload
- Defined in packages/protocol/packages/payload/packages/wrapper/dist/neutral/index.d.ts:17

`Static`wrap

wrap<T extends Payload>(
payload?: T | PayloadDataWrapper<T>,
): PayloadDataWrapper<T>
Type Parameters
- T extends Payload
Parameters
- Optionalpayload: T | PayloadDataWrapper<T>
Returns PayloadDataWrapper<T>
Inherited from PayloadWrapper.wrap
- Defined in packages/protocol/packages/payload/packages/wrapper/dist/neutral/index.d.ts:33

`Static`wrappedMap

wrappedMap<T extends Payload>(
payloads: (T | PayloadDataWrapper<T>)[],
): Promise<Record<string, PayloadDataWrapper<T>>>
Type Parameters
- T extends Payload
Parameters
- payloads: (T | PayloadDataWrapper<T>)[]
Returns Promise<Record<string, PayloadDataWrapper<T>>>
Inherited from PayloadWrapper.wrappedMap
- Defined in packages/protocol/packages/payload/packages/wrapper/dist/neutral/index.d.ts:34

Class ManifestWrapperEx<TManifest, TParams>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns ManifestWrapperEx<TManifest, TParams>

Properties

Protectedparams

payload

Protected StaticloaderFactory

Accessors

locator

Returns ModuleFactoryLocator

moduleIdentifierTransformers

Returns ModuleIdentifierTransformer[]

privateChildren

Returns ModuleManifest[]

publicChildren

Returns ModuleManifest[]

wallet

Returns WalletInstance

Methods

dataHash

Returns Promise<Lowercase<string>>

getErrors

Returns Promise<Error[]>

getValid

Returns Promise<boolean>

loadModule

Parameters

Returns Promise<void>

loadNodeFromIndex

Parameters

loadNodeFromManifest

Parameters

loadNodes

Parameters

nodeManifest

Parameters

schema

Returns string

validate

Returns Promise<Error[]>

Staticas

Type Parameters

Parameters

Returns null | PayloadDataWrapper<T>

Staticload

Parameters

Returns Promise<null | PayloadDataWrapper<Payload>>

Staticparse

Type Parameters

Parameters

Returns undefined | PayloadDataWrapper<T>

StaticsetLoaderFactory

Parameters

Returns void

StatictryParse

Type Parameters

Parameters

Returns undefined | PayloadDataWrapper<T>

Staticunwrap

Type Parameters

Parameters

Returns undefined | TPayload

Type Parameters

Parameters

Returns TPayload

Type Parameters

Parameters

Returns TPayload[]

StaticunwrapSinglePayload

Type Parameters

`Protected`params

`Protected` `Static`loaderFactory

`Static`as

`Static`load

`Static`parse

`Static`setLoaderFactory

`Static`tryParse

`Static`unwrap

`Static`unwrapSinglePayload

`Static`wrap

`Static`wrappedMap